Add in-place and genesis migrations

modules/core/02-client/legacy/v100/genesis.go

@@ -17,7 +17,7 @@ import (
 // - Update solo machine client state protobuf definition (v1 to v2)
 // - Remove all solo machine consensus states
 // - Remove all expired tendermint consensus states
-func MigrateGenesis(cdc codec.BinaryCodec, clientGenState *types.GenesisState, genesisBlockTime time.Time) (*types.GenesisState, error) {
+func MigrateGenesis(cdc codec.BinaryCodec, clientGenState *types.GenesisState, genesisBlockTime time.Time, selfHeight exported.Height) (*types.GenesisState, error) {
 	// To prune the consensus states, we will create new clientsConsensus
 	// and clientsMetadata. These slices will be filled up with consensus states
 	// which should not be pruned. No solo machine consensus states should be added
@@ -102,9 +102,14 @@ func MigrateGenesis(cdc codec.BinaryCodec, clientGenState *types.GenesisState, g
 								// only unexpired consensus state heights should be added
 								var clientMetadata []types.GenesisMetadata
 								for _, metadata := range identifiedGenMetadata.ClientMetadata {
-									if bytes.Equal(metadata.Key, ibctmtypes.IterationKey(height)) ||
-										bytes.Equal(metadata.Key, ibctmtypes.ProcessedTimeKey(height)) ||
-										bytes.Equal(metadata.Key, ibctmtypes.ProcessedHeightKey(height)) {
+									// the previous version of IBC only contained the processed time metadata
+									// if we find the processed time metadata for an unexpired height, add the
+									// iteration key and processed height keys.
+									if bytes.Equal(metadata.Key, ibctmtypes.ProcessedTimeKey(height)) {
+										clientMetadata = append(clientMetadata, types.GenesisMetadata{
+											Key:   ibctmtypes.ProcessedHeightKey(height),
+											Value: []byte(selfHeight.String()),
+										})
 										clientMetadata = append(clientMetadata, metadata)
 									}
 								}

modules/core/02-client/legacy/v100/genesis_test.go

@@ -1,6 +1,7 @@
 package v100_test
 
 import (
+	"bytes"
 	"encoding/json"
 	"fmt"
 	"time"
@@ -120,8 +121,29 @@ func (suite *LegacyTestSuite) TestMigrateGenesisSolomachine() {
 	suite.Require().NoError(err)
 	expectedClientGenState := ibcclient.ExportGenesis(path.EndpointA.Chain.GetContext(), path.EndpointA.Chain.App.GetIBCKeeper().ClientKeeper)
 
+	// 'ExportGenesis' order metadata keys by processedheight, processedtime for all heights, then it appends all iteration keys
+	// In order to match the genesis migration with export genesis we must reorder the iteration keys to be last
+	// This isn't ideal, but it is better than modifying the genesis migration from a previous version to match the export genesis of a new version
+	// which provides no benefit except nicer testing
+	for i, clientMetadata := range expectedClientGenState.ClientsMetadata {
+		var updatedMetadata []types.GenesisMetadata
+		var iterationKeys []types.GenesisMetadata
+		for _, metadata := range clientMetadata.ClientMetadata {
+			if bytes.HasPrefix(metadata.Key, []byte(ibctmtypes.KeyIterateConsensusStatePrefix)) {
+				iterationKeys = append(iterationKeys, metadata)
+			} else {
+				updatedMetadata = append(updatedMetadata, metadata)
+			}
+		}
+		updatedMetadata = append(updatedMetadata, iterationKeys...)
+		expectedClientGenState.ClientsMetadata[i] = types.IdentifiedGenesisMetadata{
+			ClientId:       clientMetadata.ClientId,
+			ClientMetadata: updatedMetadata,
+		}
+	}
+
 	// NOTE: genesis time isn't updated since we aren't testing for tendermint consensus state pruning
-	migrated, err := v100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &clientGenState, suite.coordinator.CurrentTime)
+	migrated, err := v100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &clientGenState, suite.coordinator.CurrentTime, types.GetSelfHeight(suite.chainA.GetContext()))
 	suite.Require().NoError(err)
 
 	bz, err := clientCtx.JSONCodec.MarshalJSON(&expectedClientGenState)
@@ -199,7 +221,28 @@ func (suite *LegacyTestSuite) TestMigrateGenesisTendermint() {
 	suite.Require().NoError(err)
 	expectedClientGenState := ibcclient.ExportGenesis(path1.EndpointA.Chain.GetContext(), path1.EndpointA.Chain.App.GetIBCKeeper().ClientKeeper)
 
-	migrated, err := v100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &clientGenState, suite.coordinator.CurrentTime)
+	// 'ExportGenesis' order metadata keys by processedheight, processedtime for all heights, then it appends all iteration keys
+	// In order to match the genesis migration with export genesis we must reorder the iteration keys to be last
+	// This isn't ideal, but it is better than modifying the genesis migration from a previous version to match the export genesis of a new version
+	// which provides no benefit except nicer testing
+	for i, clientMetadata := range expectedClientGenState.ClientsMetadata {
+		var updatedMetadata []types.GenesisMetadata
+		var iterationKeys []types.GenesisMetadata
+		for _, metadata := range clientMetadata.ClientMetadata {
+			if bytes.HasPrefix(metadata.Key, []byte(ibctmtypes.KeyIterateConsensusStatePrefix)) {
+				iterationKeys = append(iterationKeys, metadata)
+			} else {
+				updatedMetadata = append(updatedMetadata, metadata)
+			}
+		}
+		updatedMetadata = append(updatedMetadata, iterationKeys...)
+		expectedClientGenState.ClientsMetadata[i] = types.IdentifiedGenesisMetadata{
+			ClientId:       clientMetadata.ClientId,
+			ClientMetadata: updatedMetadata,
+		}
+	}
+
+	migrated, err := v100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &clientGenState, suite.coordinator.CurrentTime, types.GetSelfHeight(suite.chainA.GetContext()))
 	suite.Require().NoError(err)
 
 	// check path 1 client pruning

modules/core/02-client/legacy/v100/store.go

@@ -87,7 +87,16 @@ func MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, cdc codec.BinaryCodec)
 				return sdkerrors.Wrap(err, "failed to unmarshal client state bytes into tendermint client state")
 			}
 
-			if err = ibctmtypes.PruneAllExpiredConsensusStates(ctx, clientStore, cdc, clientState.(*ibctmtypes.ClientState)); err != nil {
+			tmClientState, ok := clientState.(*ibctmtypes.ClientState)
+			if !ok {
+				return sdkerrors.Wrap(types.ErrInvalidClient, "client state is not tendermint even though client id contains 07-tendermint")
+			}
+
+			if err = ibctmtypes.PruneAllExpiredConsensusStates(ctx, clientStore, cdc, tmClientState); err != nil {
+				return err
+			}
+
+			if err = addConsensusMetadata(ctx, clientStore, cdc, tmClientState); err != nil {
 				return err
 			}
 
@@ -139,3 +148,36 @@ func pruneSolomachineConsensusStates(clientStore sdk.KVStore) {
 		clientStore.Delete(host.ConsensusStateKey(height))
 	}
 }
+
+// addConsensusMetadata adds the iteration key and processed height for all unexpired tendermint consensus states
+// These keys were not included in the previous release of the IBC module.
+func addConsensusMetadata(ctx sdk.Context, clientStore sdk.KVStore, cdc codec.BinaryCodec, clientState *ibctmtypes.ClientState) error {
+	var heights []exported.Height
+
+	metadataCb := func(height exported.Height) bool {
+		consState, err := ibctmtypes.GetConsensusState(clientStore, cdc, height)
+		// this error should never occur
+		if err != nil {
+			return true
+		}
+
+		if !clientState.IsExpired(consState.Timestamp, ctx.BlockTime()) {
+			heights = append(heights, height)
+		}
+
+		return false
+	}
+
+	if err := ibctmtypes.IterateConsensusStateAscending(clientStore, metadataCb); err != nil {
+		return err
+	}
+
+	for _, height := range heights {
+		// set the iteration key and processed height
+		// these keys were not included in the SDK v0.42.0 release
+		ibctmtypes.SetProcessedHeight(clientStore, height, clienttypes.GetSelfHeight(ctx))
+		ibctmtypes.SetIterationKey(clientStore, height)
+	}
+
+	return nil
+}

modules/core/02-client/legacy/v100/store_test.go

@@ -185,4 +185,21 @@ func (suite *LegacyTestSuite) TestMigrateStoreTendermint() {
 		expectedConsKey := ibctmtypes.GetIterationKey(clientStore, pruneHeight)
 		suite.Require().Nil(expectedConsKey, i)
 	}
+
+	// ensure metadata is set for unexpired consensus state
+	height := path.EndpointA.GetClientState().GetLatestHeight()
+	consState, ok := path.EndpointA.Chain.GetConsensusState(path.EndpointA.ClientID, height)
+	suite.Require().True(ok)
+	suite.Require().NotNil(consState)
+
+	processedTime, ok := ibctmtypes.GetProcessedTime(clientStore, height)
+	suite.Require().True(ok)
+	suite.Require().NotEqual(uint64(0), processedTime)
+
+	processedHeight, ok := ibctmtypes.GetProcessedHeight(clientStore, height)
+	suite.Require().True(ok)
+	suite.Require().Equal(types.GetSelfHeight(path.EndpointA.Chain.GetContext()), processedHeight)
+
+	consKey := ibctmtypes.GetIterationKey(clientStore, height)
+	suite.Require().Equal(host.ConsensusStateKey(height), consKey)
 }