chore: adding 09-localhost to client InitGenesis (#3092)

* adding localhost AppModuleBasic to app.go. adding localhost client to InitGenesis. Fixing update localhost client

* renmaing variable

* adding migration handler for enabling localhost client

* updating to use clienttypes.GetSelfHeight()

modules/core/02-client/abci.go

@@ -34,7 +34,7 @@ func BeginBlocker(ctx sdk.Context, k keeper.Keeper) {
 	}
 
 	// update the localhost client with the latest block height
-	if err := k.UpdateClient(ctx, exported.Localhost, nil); err != nil {
-		k.Logger(ctx).Error(err.Error())
+	if clientState, found := k.GetClientState(ctx, exported.Localhost); found {
+		k.UpdateLocalhostClient(ctx, clientState)
 	}
 }

modules/core/02-client/genesis.go

@@ -46,6 +46,10 @@ func InitGenesis(ctx sdk.Context, k keeper.Keeper, gs types.GenesisState) {
 	}
 
 	k.SetNextClientSequence(ctx, gs.NextClientSequence)
+
+	if err := k.CreateLocalhostClient(ctx); err != nil {
+		panic(fmt.Sprintf("failed to initialise localhost client: %s", err.Error()))
+	}
 }
 
 // ExportGenesis returns the ibc client submodule's exported genesis.

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

@@ -111,13 +111,17 @@ func (suite *KeeperTestSuite) TestQueryClientStates() {
 		{
 			"empty pagination",
 			func() {
+				localhost := types.NewIdentifiedClientState(exported.Localhost, suite.chainA.GetClientState(exported.Localhost))
+				expClientStates = types.IdentifiedClientStates{localhost}
 				req = &types.QueryClientStatesRequest{}
 			},
 			true,
 		},
 		{
-			"success, no results",
+			"success, only localhost",
 			func() {
+				localhost := types.NewIdentifiedClientState(exported.Localhost, suite.chainA.GetClientState(exported.Localhost))
+				expClientStates = types.IdentifiedClientStates{localhost}
 				req = &types.QueryClientStatesRequest{
 					Pagination: &query.PageRequest{
 						Limit:      3,
@@ -139,11 +143,12 @@ func (suite *KeeperTestSuite) TestQueryClientStates() {
 				clientStateA1 := path1.EndpointA.GetClientState()
 				clientStateA2 := path2.EndpointA.GetClientState()
 
+				localhost := types.NewIdentifiedClientState(exported.Localhost, suite.chainA.GetClientState(exported.Localhost))
 				idcs := types.NewIdentifiedClientState(path1.EndpointA.ClientID, clientStateA1)
 				idcs2 := types.NewIdentifiedClientState(path2.EndpointA.ClientID, clientStateA2)
 
 				// order is sorted by client id
-				expClientStates = types.IdentifiedClientStates{idcs, idcs2}.Sort()
+				expClientStates = types.IdentifiedClientStates{localhost, idcs, idcs2}.Sort()
 				req = &types.QueryClientStatesRequest{
 					Pagination: &query.PageRequest{
 						Limit:      20,
@@ -158,10 +163,10 @@ func (suite *KeeperTestSuite) TestQueryClientStates() {
 	for _, tc := range testCases {
 		suite.Run(fmt.Sprintf("Case %s", tc.msg), func() {
 			suite.SetupTest() // reset
+
 			tc.malleate()
 
 			ctx := sdk.WrapSDKContext(suite.chainA.GetContext())
-
 			res, err := suite.chainA.QueryServer.ClientStates(ctx, req)
 
 			if tc.expPass {

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

@@ -20,6 +20,7 @@ import (
 	host "github.com/cosmos/ibc-go/v7/modules/core/24-host"
 	"github.com/cosmos/ibc-go/v7/modules/core/exported"
 	ibctm "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint"
+	localhost "github.com/cosmos/ibc-go/v7/modules/light-clients/09-localhost"
 )
 
 // Keeper represents a type that grants read and write permissions to any client
@@ -53,6 +54,17 @@ func (k Keeper) Logger(ctx sdk.Context) log.Logger {
 	return ctx.Logger().With("module", "x/"+exported.ModuleName+"/"+types.SubModuleName)
 }
 
+// CreateLocalhostClient initialises the 09-localhost client state and sets it in state.
+func (k Keeper) CreateLocalhostClient(ctx sdk.Context) error {
+	var clientState localhost.ClientState
+	return clientState.Initialize(ctx, k.cdc, k.ClientStore(ctx, exported.Localhost), nil)
+}
+
+// UpdateLocalhostClient updates the 09-localhost client to the latest block height and chain ID.
+func (k Keeper) UpdateLocalhostClient(ctx sdk.Context, clientState exported.ClientState) []exported.Height {
+	return clientState.UpdateState(ctx, k.cdc, k.ClientStore(ctx, exported.Localhost), nil)
+}
+
 // GenerateClientIdentifier returns the next client identifier.
 func (k Keeper) GenerateClientIdentifier(ctx sdk.Context, clientType string) string {
 	nextClientSeq := k.GetNextClientSequence(ctx)

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

@@ -21,6 +21,7 @@ import (
 	"github.com/cosmos/ibc-go/v7/modules/core/exported"
 	solomachine "github.com/cosmos/ibc-go/v7/modules/light-clients/06-solomachine"
 	ibctm "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint"
+	localhost "github.com/cosmos/ibc-go/v7/modules/light-clients/09-localhost"
 	ibctesting "github.com/cosmos/ibc-go/v7/testing"
 	ibctestingmock "github.com/cosmos/ibc-go/v7/testing/mock"
 	"github.com/cosmos/ibc-go/v7/testing/simapp"
@@ -236,9 +237,10 @@ func (suite *KeeperTestSuite) TestValidateSelfClient() {
 
 func (suite KeeperTestSuite) TestGetAllGenesisClients() { //nolint:govet // this is a test, we are okay with copying locks
 	clientIDs := []string{
-		testClientID2, testClientID3, testClientID,
+		exported.Localhost, testClientID2, testClientID3, testClientID,
 	}
 	expClients := []exported.ClientState{
+		localhost.NewClientState(suite.chainA.ChainID, types.GetSelfHeight(suite.chainA.GetContext())),
 		ibctm.NewClientState(testChainID, ibctm.DefaultTrustLevel, trustingPeriod, ubdPeriod, maxClockDrift, types.ZeroHeight(), commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath),
 		ibctm.NewClientState(testChainID, ibctm.DefaultTrustLevel, trustingPeriod, ubdPeriod, maxClockDrift, types.ZeroHeight(), commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath),
 		ibctm.NewClientState(testChainID, ibctm.DefaultTrustLevel, trustingPeriod, ubdPeriod, maxClockDrift, types.ZeroHeight(), commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath),
@@ -418,22 +420,31 @@ func (suite KeeperTestSuite) TestIterateClientStates() { //nolint:govet // this
 	testCases := []struct {
 		name         string
 		prefix       []byte
-		expClientIDs []string
+		expClientIDs func() []string
 	}{
 		{
 			"all clientIDs",
 			nil,
-			append(expSMClientIDs, expTMClientIDs...),
+			func() []string {
+				allClientIDs := []string{exported.Localhost}
+				allClientIDs = append(allClientIDs, expSMClientIDs...)
+				allClientIDs = append(allClientIDs, expTMClientIDs...)
+				return allClientIDs
+			},
 		},
 		{
 			"tendermint clientIDs",
 			[]byte(exported.Tendermint),
-			expTMClientIDs,
+			func() []string {
+				return expTMClientIDs
+			},
 		},
 		{
 			"solo machine clientIDs",
 			[]byte(exported.Solomachine),
-			expSMClientIDs,
+			func() []string {
+				return expSMClientIDs
+			},
 		},
 	}
 
@@ -446,7 +457,7 @@ func (suite KeeperTestSuite) TestIterateClientStates() { //nolint:govet // this
 				return false
 			})
 
-			suite.Require().Equal(tc.expClientIDs, clientIDs)
+			suite.Require().ElementsMatch(tc.expClientIDs(), clientIDs)
 		})
 	}
 }

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

@@ -16,7 +16,7 @@ func NewMigrator(keeper Keeper) Migrator {
 	return Migrator{keeper: keeper}
 }
 
-// Migrate2to3 migrates from version 2 to 3.
+// Migrate2to3 migrates from consensus version 2 to 3.
 // This migration
 // - migrates solo machine client states from v2 to v3 protobuf definition
 // - prunes solo machine consensus states
@@ -25,3 +25,9 @@ func NewMigrator(keeper Keeper) Migrator {
 func (m Migrator) Migrate2to3(ctx sdk.Context) error {
 	return v7.MigrateStore(ctx, m.keeper.storeKey, m.keeper.cdc, m.keeper)
 }
+
+// Migrate3to4 migrates from consensus version 3 to 4.
+// This migration enables the localhost client.
+func (m Migrator) Migrate3to4(ctx sdk.Context) error {
+	return v7.MigrateLocalhostClient(ctx, m.keeper)
+}

modules/core/02-client/migrations/v7/expected_keepers.go

@@ -11,4 +11,5 @@ type ClientKeeper interface {
 	GetClientState(ctx sdk.Context, clientID string) (exported.ClientState, bool)
 	SetClientState(ctx sdk.Context, clientID string, clientState exported.ClientState)
 	ClientStore(ctx sdk.Context, clientID string) sdk.KVStore
+	CreateLocalhostClient(ctx sdk.Context) error
 }

modules/core/02-client/migrations/v7/localhost.go

@@ -0,0 +1,10 @@
+package v7
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+// MigrateLocalhostClient initialises the 09-localhost client state and sets it in state.
+func MigrateLocalhostClient(ctx sdk.Context, clientKeeper ClientKeeper) error {
+	return clientKeeper.CreateLocalhostClient(ctx)
+}

modules/core/02-client/migrations/v7/localhost_test.go

@@ -0,0 +1,26 @@
+package v7_test
+
+import (
+	v7 "github.com/cosmos/ibc-go/v7/modules/core/02-client/migrations/v7"
+	host "github.com/cosmos/ibc-go/v7/modules/core/24-host"
+	"github.com/cosmos/ibc-go/v7/modules/core/exported"
+)
+
+func (suite *MigrationsV7TestSuite) TestMigrateLocalhostClient() {
+	suite.SetupTest()
+
+	// note: explicitly remove the localhost client before running migration handler
+	clientStore := suite.chainA.GetSimApp().GetIBCKeeper().ClientKeeper.ClientStore(suite.chainA.GetContext(), exported.Localhost)
+	clientStore.Delete(host.ClientStateKey())
+
+	clientState, found := suite.chainA.GetSimApp().GetIBCKeeper().ClientKeeper.GetClientState(suite.chainA.GetContext(), exported.Localhost)
+	suite.Require().False(found)
+	suite.Require().Nil(clientState)
+
+	err := v7.MigrateLocalhostClient(suite.chainA.GetContext(), suite.chainA.GetSimApp().GetIBCKeeper().ClientKeeper)
+	suite.Require().NoError(err)
+
+	clientState, found = suite.chainA.GetSimApp().GetIBCKeeper().ClientKeeper.GetClientState(suite.chainA.GetContext(), exported.Localhost)
+	suite.Require().True(found)
+	suite.Require().NotNil(clientState)
+}

modules/core/03-connection/keeper/keeper.go

@@ -41,25 +41,6 @@ func NewKeeper(cdc codec.BinaryCodec, key storetypes.StoreKey, paramSpace paramt
 	}
 }
 
-// EnableLocalhost is called by init genesis or an upgrade handler?
-// EnableLocalhost sets the localhost loopback connection end in store
-// NOTES:
-// - channel handshake code can remain the same
-// - packet handlers require access to a ClientState and use the following methods:
-//   - Status()
-//   - GetLatestHeight()
-//   - GetTimestampAtHeight()
-//   - VerifyMembership
-//   - VerifyNonMembership
-func (k Keeper) EnableLocalhost(ctx sdk.Context) {
-	counterparty := types.NewCounterparty(exported.Localhost, types.LocalhostID, commitmenttypes.NewMerklePrefix(k.GetCommitmentPrefix().Bytes()))
-	connectionEnd := types.NewConnectionEnd(types.OPEN, exported.Localhost, counterparty, types.ExportedVersionsToProto(types.GetCompatibleVersions()), 0)
-
-	store := ctx.KVStore(k.storeKey)
-	bz := k.cdc.MustMarshal(&connectionEnd)
-	store.Set(host.ConnectionKey(types.LocalhostID), bz)
-}
-
 // Logger returns a module-specific logger.
 func (k Keeper) Logger(ctx sdk.Context) log.Logger {
 	return ctx.Logger().With("module", "x/"+exported.ModuleName+"/"+types.SubModuleName)

modules/core/module.go

@@ -131,7 +131,17 @@ func (am AppModule) RegisterServices(cfg module.Configurator) {
 	}
 
 	connectionMigrator := connectionkeeper.NewMigrator(am.keeper.ConnectionKeeper)
-	if err := cfg.RegisterMigration(exported.ModuleName, 3, connectionMigrator.Migrate3to4); err != nil {
+	if err := cfg.RegisterMigration(exported.ModuleName, 3, func(ctx sdk.Context) error {
+		if err := connectionMigrator.Migrate3to4(ctx); err != nil {
+			return err
+		}
+
+		if err := clientMigrator.Migrate3to4(ctx); err != nil {
+			return err
+		}
+
+		return nil
+	}); err != nil {
 		panic(err)
 	}
 }

modules/light-clients/09-localhost/client_state.go

@@ -62,11 +62,18 @@ func (cs ClientState) ZeroCustomFields() exported.ClientState {
 }
 
 // Initialize ensures that initial consensus state for localhost is nil.
-func (cs ClientState) Initialize(_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, consState exported.ConsensusState) error {
+func (cs ClientState) Initialize(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, consState exported.ConsensusState) error {
 	if consState != nil {
 		return sdkerrors.Wrap(clienttypes.ErrInvalidConsensus, "initial consensus state for localhost must be nil.")
 	}
 
+	clientState := ClientState{
+		ChainId:      ctx.ChainID(),
+		LatestHeight: clienttypes.GetSelfHeight(ctx),
+	}
+
+	clientStore.Set([]byte(host.KeyClientState), clienttypes.MustMarshalClientState(cdc, &clientState))
+
 	return nil
 }
 
@@ -144,7 +151,7 @@ func (cs ClientState) UpdateStateOnMisbehaviour(_ sdk.Context, _ codec.BinaryCod
 // UpdateState updates and stores as necessary any associated information for an IBC client, such as the ClientState and corresponding ConsensusState.
 // Upon successful update, a list of consensus heights is returned. It assumes the ClientMessage has already been verified.
 func (cs ClientState) UpdateState(ctx sdk.Context, cdc codec.BinaryCodec, clientStore sdk.KVStore, clientMsg exported.ClientMessage) []exported.Height {
-	height := clienttypes.NewHeight(clienttypes.ParseChainID(ctx.ChainID()), uint64(ctx.BlockHeight()))
+	height := clienttypes.GetSelfHeight(ctx)
 
 	clientState := NewClientState(ctx.ChainID(), height)
 	clientStore.Set([]byte(host.KeyClientState), clienttypes.MustMarshalClientState(cdc, clientState))

testing/simapp/app.go

@@ -114,6 +114,7 @@ import (
 	ibckeeper "github.com/cosmos/ibc-go/v7/modules/core/keeper"
 	solomachine "github.com/cosmos/ibc-go/v7/modules/light-clients/06-solomachine"
 	ibctm "github.com/cosmos/ibc-go/v7/modules/light-clients/07-tendermint"
+	localhost "github.com/cosmos/ibc-go/v7/modules/light-clients/09-localhost"
 	ibcmock "github.com/cosmos/ibc-go/v7/testing/mock"
 	simappparams "github.com/cosmos/ibc-go/v7/testing/simapp/params"
 	simappupgrades "github.com/cosmos/ibc-go/v7/testing/simapp/upgrades"
@@ -159,6 +160,7 @@ var (
 		slashing.AppModuleBasic{},
 		ibc.AppModuleBasic{},
 		ibctm.AppModuleBasic{},
+		localhost.AppModuleBasic{},
 		solomachine.AppModuleBasic{},
 		feegrantmodule.AppModuleBasic{},
 		upgrade.AppModuleBasic{},