use uint64 instead of *uint64 as argument type for GetFinalizedHeader

Signed-off-by: Masanori Yoshida <masanori.yoshida@datachain.jp>

Author: siburu

chains/tendermint/prover.go

@@ -109,12 +109,8 @@ func (pr *Prover) SetupHeadersForUpdate(counterparty core.FinalityAwareChain, la
 }
 
 // GetFinalizedHeader returns the finalized header at `height`
-func (pr *Prover) GetFinalizedHeader(height *uint64) (core.Header, error) {
-	if height == nil {
-		return pr.UpdateLightClient(0)
-	} else {
-		return pr.UpdateLightClient(int64(*height))
-	}
+func (pr *Prover) GetFinalizedHeader(height uint64) (core.Header, error) {
+	return pr.UpdateLightClient(int64(height))
 }
 
 func (pr *Prover) CheckRefreshRequired(counterparty core.ChainInfoICS02Querier) (bool, error) {

chains/tendermint/query.go

@@ -209,7 +209,7 @@ func (c *Chain) QueryUnfinalizedRelayPackets(ctx core.QueryContext, counterparty
 	}
 
 	var counterpartyCtx core.QueryContext
-	if counterpartyH, err := counterparty.GetFinalizedHeader(nil); 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.GetFinalizedHeader(nil); err != nil {
+	if counterpartyH, err := counterparty.GetFinalizedHeader(0); err != nil {
 		return nil, err
 	} else {
 		counterpartyCtx = core.NewQueryContext(context.TODO(), counterpartyH.GetHeight())

cmd/tx.go

@@ -2,7 +2,6 @@ package cmd
 
 import (
 	"context"
-	"math"
 	"strings"
 
 	"github.com/cosmos/cosmos-sdk/client/flags"
@@ -43,6 +42,10 @@ func createClientsCmd(ctx *config.Context) *cobra.Command {
 		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",
@@ -63,29 +66,21 @@ func createClientsCmd(ctx *config.Context) *cobra.Command {
 				return err
 			}
 
-			var srcHeight *uint64
-			if h, err := cmd.Flags().GetUint64(flagSrcHeight); err != nil {
+			srcHeight, err := cmd.Flags().GetUint64(flagSrcHeight)
+			if err != nil {
 				return err
-			} else if h == math.MaxUint64 {
-				srcHeight = nil
-			} else {
-				srcHeight = &h
 			}
 
-			var dstHeight *uint64
-			if h, err := cmd.Flags().GetUint64(flagDstHeight); err != nil {
+			dstHeight, err := cmd.Flags().GetUint64(flagDstHeight)
+			if err != nil {
 				return err
-			} else if h == math.MaxUint64 {
-				dstHeight = nil
-			} else {
-				dstHeight = &h
 			}
 
 			return core.CreateClients(c[src], c[dst], srcHeight, dstHeight)
 		},
 	}
-	cmd.Flags().Uint64(flagSrcHeight, math.MaxUint64, "src header at this height is submitted to dst chain")
-	cmd.Flags().Uint64(flagDstHeight, math.MaxUint64, "dst header at this height is submitted to src chain")
+	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,7 +8,7 @@ import (
 	"golang.org/x/sync/errgroup"
 )
 
-func CreateClients(src, dst *ProvableChain, srcHeight, dstHeight *uint64) error {
+func CreateClients(src, dst *ProvableChain, srcHeight, dstHeight uint64) error {
 	logger := GetChainPairLogger(src, dst)
 	defer logger.TimeTrack(time.Now(), "CreateClients")
 	var (
@@ -118,7 +118,7 @@ func UpdateClients(src, dst *ProvableChain) error {
 }
 
 // getHeadersForCreateClient calls UpdateLightWithHeader on the passed chains concurrently
-func getHeadersForCreateClient(src, dst LightClient, srcHeight, dstHeight *uint64) (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.GetFinalizedHeader(srcHeight)

core/headers.go

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

core/provers.go

@@ -51,7 +51,7 @@ type FinalityAware interface {
 	// GetFinalizedHeader returns the finalized header on this chain corresponding to `height`.
 	// If `height` is nil, 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)
+	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.GetFinalizedHeader(nil)
+		lfHeader, err := chain.GetFinalizedHeader(0)
 		if err != nil {
 			return fmt.Errorf("failed to get latest finalized header: %v", err)
 		}

provers/mock/prover.go

@@ -90,15 +90,15 @@ func (pr *Prover) getDelayedLatestFinalizedHeight() (exported.Height, error) {
 }
 
 // GetFinalizedHeader returns the finalized header at `height`
-func (pr *Prover) GetFinalizedHeader(height *uint64) (core.Header, error) {
+func (pr *Prover) GetFinalizedHeader(height uint64) (core.Header, error) {
 	if latestFinalizedHeight, err := pr.getDelayedLatestFinalizedHeight(); err != nil {
 		return nil, err
-	} else if height == nil {
+	} 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 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)
+		ics02Height := clienttypes.NewHeight(latestFinalizedHeight.GetRevisionNumber(), height)
 		return pr.createMockHeader(ics02Height)
 	}
 }