Merge pull request #122 from siburu/get-finalized-header

replace `GetLatestFinalizedHeader` with `GetFinalizedHeader`

Author: siburu

chains/tendermint/cmd/light.go

@@ -103,7 +103,7 @@ func updateLightCmd(ctx *config.Context) *cobra.Command {
 				return err
 			}
 
-			ah, err := prover.UpdateLightClient()
+			ah, err := prover.UpdateLightClient(0)
 			if err != nil {
 				return err
 			}

chains/tendermint/prover.go

@@ -7,6 +7,7 @@ import (
 	"time"
 
 	"github.com/cometbft/cometbft/light"
+	"github.com/cometbft/cometbft/types"
 	tmtypes "github.com/cometbft/cometbft/types"
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
@@ -107,13 +108,9 @@ func (pr *Prover) SetupHeadersForUpdate(counterparty core.FinalityAwareChain, la
 	return []core.Header{&h}, nil
 }
 
-// GetLatestFinalizedHeader returns the latest finalized header
-func (pr *Prover) GetLatestFinalizedHeader() (latestFinalizedHeader core.Header, err error) {
-	h, err := pr.UpdateLightClient()
-	if err != nil {
-		return nil, err
-	}
-	return h, nil
+// GetFinalizedHeader returns the finalized header at `height`
+func (pr *Prover) GetFinalizedHeader(height uint64) (core.Header, error) {
+	return pr.UpdateLightClient(int64(height))
 }
 
 func (pr *Prover) CheckRefreshRequired(counterparty core.ChainInfoICS02Querier) (bool, error) {
@@ -183,7 +180,7 @@ func (pr *Prover) GetLatestLightHeight() (int64, error) {
 	return client.LastTrustedHeight()
 }
 
-func (pr *Prover) UpdateLightClient() (core.Header, error) {
+func (pr *Prover) UpdateLightClient(height int64) (core.Header, error) {
 	// create database connection
 	db, df, err := pr.NewLightDB()
 	if err != nil {
@@ -196,14 +193,18 @@ func (pr *Prover) UpdateLightClient() (core.Header, error) {
 		return nil, lightError(err)
 	}
 
-	sh, err := client.Update(context.Background(), time.Now())
-	if err != nil {
-		return nil, lightError(err)
-	}
-
-	if sh == nil {
-		sh, err = client.TrustedLightBlock(0)
-		if err != nil {
+	var sh *types.LightBlock
+	if height == 0 {
+		if sh, err = client.Update(context.Background(), time.Now()); err != nil {
+			return nil, lightError(err)
+		} else if sh == nil {
+			sh, err = client.TrustedLightBlock(0)
+			if err != nil {
+				return nil, lightError(err)
+			}
+		}
+	} else {
+		if sh, err = client.VerifyLightBlockAtHeight(context.Background(), height, time.Now()); err != nil {
 			return nil, lightError(err)
 		}
 	}

chains/tendermint/query.go

@@ -209,7 +209,7 @@ func (c *Chain) QueryUnfinalizedRelayPackets(ctx core.QueryContext, counterparty
 	}
 
 	var counterpartyCtx core.QueryContext
-	if counterpartyH, err := counterparty.GetLatestFinalizedHeader(); err != nil {
+	if counterpartyH, err := counterparty.GetFinalizedHeader(0); err != nil {
 		return nil, err
 	} else {
 		counterpartyCtx = core.NewQueryContext(context.TODO(), counterpartyH.GetHeight())
@@ -262,7 +262,7 @@ func (c *Chain) QueryUnfinalizedRelayAcknowledgements(ctx core.QueryContext, cou
 	}
 
 	var counterpartyCtx core.QueryContext
-	if counterpartyH, err := counterparty.GetLatestFinalizedHeader(); err != nil {
+	if counterpartyH, err := counterparty.GetFinalizedHeader(0); err != nil {
 		return nil, err
 	} else {
 		counterpartyCtx = core.NewQueryContext(context.TODO(), counterpartyH.GetHeight())

cmd/tx.go

@@ -38,6 +38,14 @@ func transactionCmd(ctx *config.Context) *cobra.Command {
 }
 
 func createClientsCmd(ctx *config.Context) *cobra.Command {
+	const (
+		flagSrcHeight = "src-height"
+		flagDstHeight = "dst-height"
+	)
+	const (
+		defaultSrcHeight = 0
+		defaultDstHeight = 0
+	)
 	cmd := &cobra.Command{
 		Use:   "clients [path-name]",
 		Short: "create a clients between two configured chains with a configured path",
@@ -58,9 +66,21 @@ func createClientsCmd(ctx *config.Context) *cobra.Command {
 				return err
 			}
 
-			return core.CreateClients(c[src], c[dst])
+			srcHeight, err := cmd.Flags().GetUint64(flagSrcHeight)
+			if err != nil {
+				return err
+			}
+
+			dstHeight, err := cmd.Flags().GetUint64(flagDstHeight)
+			if err != nil {
+				return err
+			}
+
+			return core.CreateClients(c[src], c[dst], srcHeight, dstHeight)
 		},
 	}
+	cmd.Flags().Uint64(flagSrcHeight, defaultSrcHeight, "src header at this height is submitted to dst chain")
+	cmd.Flags().Uint64(flagDstHeight, defaultDstHeight, "dst header at this height is submitted to src chain")
 	return cmd
 }
 

core/client.go

@@ -8,14 +8,14 @@ import (
 	"golang.org/x/sync/errgroup"
 )
 
-func CreateClients(src, dst *ProvableChain) error {
+func CreateClients(src, dst *ProvableChain, srcHeight, dstHeight uint64) error {
 	logger := GetChainPairLogger(src, dst)
 	defer logger.TimeTrack(time.Now(), "CreateClients")
 	var (
 		clients = &RelayMsgs{Src: []sdk.Msg{}, Dst: []sdk.Msg{}}
 	)
 
-	srcH, dstH, err := getHeadersForCreateClient(src, dst)
+	srcH, dstH, err := getHeadersForCreateClient(src, dst, srcHeight, dstHeight)
 	if err != nil {
 		logger.Error(
 			"failed to get headers for create client",
@@ -118,14 +118,14 @@ func UpdateClients(src, dst *ProvableChain) error {
 }
 
 // getHeadersForCreateClient calls UpdateLightWithHeader on the passed chains concurrently
-func getHeadersForCreateClient(src, dst LightClient) (srch, dsth Header, err error) {
+func getHeadersForCreateClient(src, dst LightClient, srcHeight, dstHeight uint64) (srch, dsth Header, err error) {
 	var eg = new(errgroup.Group)
 	eg.Go(func() error {
-		srch, err = src.GetLatestFinalizedHeader()
+		srch, err = src.GetFinalizedHeader(srcHeight)
 		return err
 	})
 	eg.Go(func() error {
-		dsth, err = dst.GetLatestFinalizedHeader()
+		dsth, err = dst.GetFinalizedHeader(dstHeight)
 		return err
 	})
 	if err := eg.Wait(); err != nil {

core/headers.go

@@ -77,12 +77,12 @@ func (sh *syncHeaders) Updates(src, dst ChainInfoLightClient) error {
 		return err
 	}
 
-	srcHeader, err := src.GetLatestFinalizedHeader()
+	srcHeader, err := src.GetFinalizedHeader(0)
 	if err != nil {
 		logger.Error("error getting latest finalized header of src", err)
 		return err
 	}
-	dstHeader, err := dst.GetLatestFinalizedHeader()
+	dstHeader, err := dst.GetFinalizedHeader(0)
 	if err != nil {
 		logger.Error("error getting latest finalized header of dst", err)
 		return err

core/provers.go

@@ -48,9 +48,10 @@ type LightClient interface {
 
 // FinalityAware provides the capability to determine the finality of the chain
 type FinalityAware interface {
-	// GetLatestFinalizedHeader returns the latest finalized header on this chain
-	// The returned header is expected to be the latest one of headers that can be verified by the light client
-	GetLatestFinalizedHeader() (latestFinalizedHeader Header, err error)
+	// GetFinalizedHeader returns the finalized header on this chain corresponding to `height`.
+	// If `height` is zero, this function returns the latest finalized header.
+	// If the header at `height` isn't finalized yet, this function returns an error.
+	GetFinalizedHeader(height uint64) (Header, error)
 }
 
 // FinalityAwareChain is FinalityAware + Chain

core/send.go

@@ -28,7 +28,7 @@ func GetFinalizedMsgResult(chain ProvableChain, msgID MsgID) (MsgResult, error)
 
 	if err := retry.Do(func() error {
 		// query LFH for each retry because it can proceed.
-		lfHeader, err := chain.GetLatestFinalizedHeader()
+		lfHeader, err := chain.GetFinalizedHeader(0)
 		if err != nil {
 			return fmt.Errorf("failed to get latest finalized header: %v", err)
 		}

provers/mock/prover.go

@@ -3,11 +3,13 @@ package mock
 import (
 	"context"
 	"crypto/sha256"
+	fmt "fmt"
 	"time"
 
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
+	"github.com/cosmos/ibc-go/v7/modules/core/exported"
 
 	mocktypes "github.com/datachainlab/ibc-mock-client/modules/light-clients/xx-mock/types"
 	"github.com/hyperledger-labs/yui-relayer/core"
@@ -58,30 +60,47 @@ func (pr *Prover) SetupHeadersForUpdate(_ core.FinalityAwareChain, latestFinaliz
 	return []core.Header{latestFinalizedHeader.(*mocktypes.Header)}, nil
 }
 
-// GetLatestFinalizedHeader returns the latest finalized header
-func (pr *Prover) GetLatestFinalizedHeader() (latestFinalizedHeader core.Header, err error) {
-	chainLatestHeight, err := pr.chain.LatestHeight()
+func (pr *Prover) createMockHeader(height exported.Height) (core.Header, error) {
+	timestamp, err := pr.chain.Timestamp(height)
 	if err != nil {
-		return nil, err
+		return nil, fmt.Errorf("failed to get block timestamp at height:%v", height)
+	}
+	return &mocktypes.Header{
+		Height: clienttypes.Height{
+			RevisionNumber: height.GetRevisionNumber(),
+			RevisionHeight: height.GetRevisionHeight(),
+		},
+		Timestamp: uint64(timestamp.UnixNano()),
+	}, nil
+}
+
+func (pr *Prover) getDelayedLatestFinalizedHeight() (exported.Height, error) {
+	height, err := pr.chain.LatestHeight()
+	if err != nil {
+		return nil, fmt.Errorf("failed to get latest height: %v", err)
 	}
 	for i := uint64(0); i < pr.config.FinalityDelay; i++ {
-		if prevHeight, success := chainLatestHeight.Decrement(); success {
-			chainLatestHeight = prevHeight
+		if h, ok := height.Decrement(); ok {
+			height = h
 		} else {
 			break
 		}
 	}
-	timestamp, err := pr.chain.Timestamp(chainLatestHeight)
-	if err != nil {
+	return height, nil
+}
+
+// GetFinalizedHeader returns the finalized header at `height`
+func (pr *Prover) GetFinalizedHeader(height uint64) (core.Header, error) {
+	if latestFinalizedHeight, err := pr.getDelayedLatestFinalizedHeight(); err != nil {
 		return nil, err
+	} else if height == 0 {
+		return pr.createMockHeader(latestFinalizedHeight)
+	} else if height > latestFinalizedHeight.GetRevisionHeight() {
+		return nil, fmt.Errorf("the requested height is greater than the latest finalized height: %v > %v", height, latestFinalizedHeight)
+	} else {
+		ics02Height := clienttypes.NewHeight(latestFinalizedHeight.GetRevisionNumber(), height)
+		return pr.createMockHeader(ics02Height)
 	}
-	return &mocktypes.Header{
-		Height: clienttypes.Height{
-			RevisionNumber: chainLatestHeight.GetRevisionNumber(),
-			RevisionHeight: chainLatestHeight.GetRevisionHeight(),
-		},
-		Timestamp: uint64(timestamp.UnixNano()),
-	}, nil
 }
 
 // CheckRefreshRequired always returns false because mock clients don't need refresh.

tests/cases/tm2tm/scripts/handshake

@@ -27,6 +27,6 @@ retry 5 $RLY tendermint light init $CHAINID_TWO -f
 # add a path between chain0 and chain1
 $RLY paths add $CHAINID_ONE $CHAINID_TWO $PATH_NAME --file=./configs/path.json
 
-retry 5 $RLY tx clients $PATH_NAME
+retry 5 $RLY tx clients --src-height 2 $PATH_NAME
 retry 5 $RLY tx connection $PATH_NAME
 retry 5 $RLY tx channel $PATH_NAME