02-client routing: remove GetLatestHeight from ClientState interface and add it to LightClientModule

docs/docs/03-light-clients/01-developer-guide/02-client-state.md

@@ -15,10 +15,6 @@ Learn how to implement the [`ClientState`](https://github.com/cosmos/ibc-go/blob
 `ClientType` should return a unique string identifier of the light client. This will be used when generating a client identifier.
 The format is created as follows: `ClientType-{N}` where `{N}` is the unique global nonce associated with a specific client.
 
-## `GetLatestHeight` method
-
-`GetLatestHeight` should return the latest block height that the client state represents.
-
 ## `Validate` method
 
 `Validate` should validate every client state field and should return an error if any value is invalid. The light client

e2e/tests/core/02-client/client_test.go

@@ -361,8 +361,8 @@ func (s *ClientTestSuite) TestClient_Update_Misbehaviour() {
 		tmClientState, ok := clientState.(*ibctm.ClientState)
 		s.Require().True(ok)
 
-		trustedHeight, ok = tmClientState.GetLatestHeight().(clienttypes.Height)
-		s.Require().True(ok)
+		trustedHeight := tmClientState.LatestHeight
+		s.Require().True(trustedHeight.GT(clienttypes.ZeroHeight()))
 	})
 
 	t.Run("update clients", func(t *testing.T) {
@@ -377,8 +377,8 @@ func (s *ClientTestSuite) TestClient_Update_Misbehaviour() {
 		tmClientState, ok := clientState.(*ibctm.ClientState)
 		s.Require().True(ok)
 
-		latestHeight, ok = tmClientState.GetLatestHeight().(clienttypes.Height)
-		s.Require().True(ok)
+		latestHeight := tmClientState.LatestHeight
+		s.Require().True(latestHeight.GT(clienttypes.ZeroHeight()))
 	})
 
 	t.Run("create validator set", func(t *testing.T) {

e2e/tests/transfer/localhost_test.go

@@ -55,13 +55,13 @@ func (s *LocalhostTransferTestSuite) TestMsgTransfer_Localhost() {
 	t.Run("verify begin blocker was executed", func(t *testing.T) {
 		cs, err := s.QueryClientState(ctx, chainA, exported.LocalhostClientID)
 		s.Require().NoError(err)
-		originalHeight := cs.GetLatestHeight()
+		originalHeight := cs.(*localhost.ClientState).LatestHeight
 
 		s.Require().NoError(test.WaitForBlocks(ctx, 1, chainA), "failed to wait for blocks")
 
 		cs, err = s.QueryClientState(ctx, chainA, exported.LocalhostClientID)
 		s.Require().NoError(err)
-		s.Require().True(cs.GetLatestHeight().GT(originalHeight), "client state height was not incremented")
+		s.Require().True(cs.(*localhost.ClientState).LatestHeight.GT(originalHeight), "client state height was not incremented")
 	})
 
 	t.Run("channel open init localhost", func(t *testing.T) {

modules/core/02-client/keeper/client.go

@@ -9,7 +9,6 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
 	"github.com/cosmos/ibc-go/v8/modules/core/02-client/types"
-	ibcerrors "github.com/cosmos/ibc-go/v8/modules/core/errors"
 	"github.com/cosmos/ibc-go/v8/modules/core/exported"
 )
 
@@ -33,28 +32,28 @@ func (k Keeper) CreateClient(
 
 	clientID := k.GenerateClientIdentifier(ctx, clientType)
 
-	lightClientModule, found := k.router.GetRoute(clientID)
+	clientModule, found := k.router.GetRoute(clientID)
 	if !found {
 		return "", errorsmod.Wrap(types.ErrRouteNotFound, clientID)
 	}
 
-	if err := lightClientModule.Initialize(ctx, clientID, clientState, consensusState); err != nil {
+	if err := clientModule.Initialize(ctx, clientID, clientState, consensusState); err != nil {
 		return "", err
 	}
 
 	if status := k.GetClientStatus(ctx, clientID); status != exported.Active {
 		return "", errorsmod.Wrapf(types.ErrClientNotActive, "cannot create client (%s) with status %s", clientID, status)
 	}
 
-	// 	k.Logger(ctx).Info("client created at height", "client-id", clientID, "height", clientState.GetLatestHeight().String())
+	k.Logger(ctx).Info("client created at height", "client-id", clientID, "height", clientModule.LatestHeight(ctx, clientID).String())
 
 	defer telemetry.IncrCounterWithLabels(
 		[]string{"ibc", "client", "create"},
 		1,
 		[]metrics.Label{telemetry.NewLabel(types.LabelClientType, clientType)},
 	)
 
-	emitCreateClientEvent(ctx, clientID, clientType)
+	emitCreateClientEvent(ctx, clientID, clientType, clientModule.LatestHeight(ctx, clientID))
 
 	return clientID, nil
 }
@@ -70,18 +69,18 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, clientMsg exporte
 		return errorsmod.Wrapf(types.ErrClientNotFound, "clientID (%s)", clientID)
 	}
 
-	lightClientModule, found := k.router.GetRoute(clientID)
+	clientModule, found := k.router.GetRoute(clientID)
 	if !found {
 		return errorsmod.Wrap(types.ErrRouteNotFound, clientID)
 	}
 
-	if err := lightClientModule.VerifyClientMessage(ctx, clientID, clientMsg); err != nil {
+	if err := clientModule.VerifyClientMessage(ctx, clientID, clientMsg); err != nil {
 		return err
 	}
 
-	foundMisbehaviour := lightClientModule.CheckForMisbehaviour(ctx, clientID, clientMsg)
+	foundMisbehaviour := clientModule.CheckForMisbehaviour(ctx, clientID, clientMsg)
 	if foundMisbehaviour {
-		lightClientModule.UpdateStateOnMisbehaviour(ctx, clientID, clientMsg)
+		clientModule.UpdateStateOnMisbehaviour(ctx, clientID, clientMsg)
 
 		k.Logger(ctx).Info("client frozen due to misbehaviour", "client-id", clientID)
 
@@ -100,7 +99,7 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, clientMsg exporte
 		return nil
 	}
 
-	consensusHeights := lightClientModule.UpdateState(ctx, clientID, clientMsg)
+	consensusHeights := clientModule.UpdateState(ctx, clientID, clientMsg)
 
 	k.Logger(ctx).Info("client state updated", "client-id", clientID, "heights", consensusHeights)
 
@@ -136,21 +135,22 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
 		return errorsmod.Wrapf(types.ErrClientNotActive, "cannot upgrade client (%s) with status %s", clientID, status)
 	}
 
+	// TODO: This code is removed in https://github.com/cosmos/ibc-go/pull/5827
 	// last height of current counterparty chain must be client's latest height
-	lastHeight := clientState.GetLatestHeight()
+	// lastHeight := k.GetLatestHeight(ctx, clientID)
 
-	if !upgradedClient.GetLatestHeight().GT(lastHeight) {
-		return errorsmod.Wrapf(ibcerrors.ErrInvalidHeight, "upgraded client height %s must be at greater than current client height %s",
-			upgradedClient.GetLatestHeight(), lastHeight)
-	}
+	// if !upgradedClient.GetLatestHeight().GT(lastHeight) {
+	// 	return errorsmod.Wrapf(ibcerrors.ErrInvalidHeight, "upgraded client height %s must be at greater than current client height %s",
+	// 		upgradedClient.GetLatestHeight(), lastHeight)
+	// }
 
 	if err := clientState.VerifyUpgradeAndUpdateState(ctx, k.cdc, clientStore,
 		upgradedClient, upgradedConsState, upgradeClientProof, upgradeConsensusStateProof,
 	); err != nil {
 		return errorsmod.Wrapf(err, "cannot upgrade client with ID %s", clientID)
 	}
 
-	k.Logger(ctx).Info("client state upgraded", "client-id", clientID, "height", upgradedClient.GetLatestHeight().String())
+	k.Logger(ctx).Info("client state upgraded", "client-id", clientID, "height", k.GetLatestHeight(ctx, clientID).String())
 
 	defer telemetry.IncrCounterWithLabels(
 		[]string{"ibc", "client", "upgrade"},
@@ -161,7 +161,7 @@ func (k Keeper) UpgradeClient(ctx sdk.Context, clientID string, upgradedClient e
 		},
 	)
 
-	emitUpgradeClientEvent(ctx, clientID, upgradedClient)
+	emitUpgradeClientEvent(ctx, clientID, upgradedClient.ClientType(), k.GetLatestHeight(ctx, clientID))
 
 	return nil
 }
@@ -187,12 +187,18 @@ func (k Keeper) RecoverClient(ctx sdk.Context, subjectClientID, substituteClient
 		return errorsmod.Wrapf(types.ErrClientNotFound, "clientID (%s)", subjectClientID)
 	}
 
-	lightClientModule, found := k.router.GetRoute(subjectClientID)
+	clientModule, found := k.router.GetRoute(subjectClientID)
 	if !found {
 		return errorsmod.Wrap(types.ErrRouteNotFound, subjectClientID)
 	}
 
-	if err := lightClientModule.RecoverClient(ctx, subjectClientID, substituteClientID); err != nil {
+	subjectLatestHeight := clientModule.LatestHeight(ctx, subjectClientID)
+	substituteLatestHeight := clientModule.LatestHeight(ctx, substituteClientID)
+	if subjectLatestHeight.GTE(substituteLatestHeight) {
+		return errorsmod.Wrapf(types.ErrInvalidHeight, "subject client state latest height is greater or equal to substitute client state latest height (%s >= %s)", subjectLatestHeight, substituteLatestHeight)
+	}
+
+	if err := clientModule.RecoverClient(ctx, subjectClientID, substituteClientID); err != nil {
 		return err
 	}