Add in-place and genesis migrations

docs/migrations/ibc-migration-043.md

@@ -56,13 +56,13 @@ import (
 ...
 
 // add in migrate cmd function
-newGenState, err = ibcv100.MigrateGenesis(clientCtx.InterfaceRegistry, newGenState, genDoc.GenesisTime)
+newGenState, err = ibcv100.MigrateGenesis(clientCtx.InterfaceRegistry, newGenState, genDoc)
 if err != nil {
     return err
 }
 ```
 
-**NOTE:** The genesis time MUST be updated before migrating IBC, otherwise the tendermint consensus state will not be pruned.
+**NOTE:** The genesis chain-id, time and height MUST be updated before migrating IBC, otherwise the tendermint consensus state will not be pruned.
 
 ## IBC Keeper Changes
 

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

@@ -17,12 +17,11 @@ func NewMigrator(keeper Keeper) Migrator {
 }
 
 // Migrate1to2 migrates from version 1 to 2.
-// This migration prunes:
-// - solo machine consensus states
-// - expired tendermint consensus states
-//
-// This migration migrates:
-// - solo machine client states from v1 to v2 protobuf definition
+// This migration
+// - migrates solo machine client states from v1 to v2 protobuf definition
+// - prunes solo machine consensus states
+// - prunes expired tendermint consensus states
+// - adds iteration and processed height keys for unexpired tendermint consensus states
 func (m Migrator) Migrate1to2(ctx sdk.Context) error {
 	return v100.MigrateStore(ctx, m.keeper.storeKey, m.keeper.cdc)
 }

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

@@ -18,6 +18,7 @@ import (
 // - Update solo machine client state protobuf definition (v1 to v2)
 // - Remove all solo machine consensus states
 // - Remove all expired tendermint consensus states
+// - Adds ProcessedHeight and Iteration keys for unexpired tendermint consensus states
 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

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

@@ -0,0 +1,208 @@
+package v100
+
+import (
+	ics23 "github.com/confio/ics23/go"
+	"github.com/cosmos/cosmos-sdk/codec"
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/cosmos/ibc-go/modules/core/exported"
+)
+
+// NOTE: this is a mock implmentation for exported.ClientState. This implementation
+// should only be registered on the InterfaceRegistry during cli command genesis migration.
+// This implementation is only used to successfully unmarshal the previous solo machine
+// client state and consensus state and migrate them to the new implementations. When the proto
+// codec unmarshals, it calls UnpackInterfaces() to create a cached value of the any. The
+// UnpackInterfaces function for IdenitifiedClientState will attempt to unpack the any to
+// exported.ClientState. If the solomachine v1 type is not registered against the exported.ClientState
+// the unmarshal will fail. This implementation will panic on every interface function.
+// The same is done for the ConsensusState.
+
+// Interface implementation checks.
+var (
+	_, _ codectypes.UnpackInterfacesMessage = &ClientState{}, &ConsensusState{}
+	_    exported.ClientState               = (*ClientState)(nil)
+	_    exported.ConsensusState            = &ConsensusState{}
+)
+
+func RegisterInterfaces(registry codectypes.InterfaceRegistry) {
+	registry.RegisterImplementations(
+		(*exported.ClientState)(nil),
+		&ClientState{},
+	)
+	registry.RegisterImplementations(
+		(*exported.ConsensusState)(nil),
+		&ConsensusState{},
+	)
+}
+
+// UnpackInterfaces implements the UnpackInterfaceMessages.UnpackInterfaces method
+func (cs ClientState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
+	return cs.ConsensusState.UnpackInterfaces(unpacker)
+}
+
+// UnpackInterfaces implements the UnpackInterfaceMessages.UnpackInterfaces method
+func (cs ConsensusState) UnpackInterfaces(unpacker codectypes.AnyUnpacker) error {
+	return unpacker.UnpackAny(cs.PublicKey, new(cryptotypes.PubKey))
+}
+
+// ClientType panics!
+func (cs ClientState) ClientType() string {
+	panic("legacy solo machine is deprecated!")
+}
+
+// GetLatestHeight panics!
+func (cs ClientState) GetLatestHeight() exported.Height {
+	panic("legacy solo machine is deprecated!")
+}
+
+// Status panics!
+func (cs ClientState) Status(_ sdk.Context, _ sdk.KVStore, _ codec.BinaryCodec) exported.Status {
+	panic("legacy solo machine is deprecated!")
+}
+
+// Validate panics!
+func (cs ClientState) Validate() error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// GetProofSpecs panics!
+func (cs ClientState) GetProofSpecs() []*ics23.ProofSpec {
+	panic("legacy solo machine is deprecated!")
+}
+
+// ZeroCustomFields panics!
+func (cs ClientState) ZeroCustomFields() exported.ClientState {
+	panic("legacy solo machine is deprecated!")
+}
+
+// Initialize panics!
+func (cs ClientState) Initialize(_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, consState exported.ConsensusState) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// ExportMetadata panics!
+func (cs ClientState) ExportMetadata(_ sdk.KVStore) []exported.GenesisMetadata {
+	panic("legacy solo machine is deprecated!")
+}
+
+// CheckHeaderAndUpdateState panics!
+func (cs *ClientState) CheckHeaderAndUpdateState(
+	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.Header,
+) (exported.ClientState, exported.ConsensusState, error) {
+	panic("legacy solo machine is deprecated!")
+}
+
+// CheckMisbehaviourAndUpdateState panics!
+func (cs ClientState) CheckMisbehaviourAndUpdateState(
+	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore, _ exported.Misbehaviour,
+) (exported.ClientState, error) {
+	panic("legacy solo machine is deprecated!")
+}
+
+// CheckSubstituteAndUpdateState panics!
+func (cs ClientState) CheckSubstituteAndUpdateState(
+	ctx sdk.Context, _ codec.BinaryCodec, _, _ sdk.KVStore,
+	_ exported.ClientState,
+) (exported.ClientState, error) {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyUpgradeAndUpdateState panics!
+func (cs ClientState) VerifyUpgradeAndUpdateState(
+	_ sdk.Context, _ codec.BinaryCodec, _ sdk.KVStore,
+	_ exported.ClientState, _ exported.ConsensusState, _, _ []byte,
+) (exported.ClientState, exported.ConsensusState, error) {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyClientState panics!
+func (cs ClientState) VerifyClientState(
+	store sdk.KVStore, cdc codec.BinaryCodec,
+	_ exported.Height, _ exported.Prefix, _ string, _ []byte, clientState exported.ClientState,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyClientConsensusState panics!
+func (cs ClientState) VerifyClientConsensusState(
+	sdk.KVStore, codec.BinaryCodec,
+	exported.Height, string, exported.Height, exported.Prefix,
+	[]byte, exported.ConsensusState,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyConnectionState panics!
+func (cs ClientState) VerifyConnectionState(
+	sdk.KVStore, codec.BinaryCodec, exported.Height,
+	exported.Prefix, []byte, string, exported.ConnectionI,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyChannelState panics!
+func (cs ClientState) VerifyChannelState(
+	sdk.KVStore, codec.BinaryCodec, exported.Height, exported.Prefix,
+	[]byte, string, string, exported.ChannelI,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyPacketCommitment panics!
+func (cs ClientState) VerifyPacketCommitment(
+	sdk.Context, sdk.KVStore, codec.BinaryCodec, exported.Height,
+	uint64, uint64, exported.Prefix, []byte,
+	string, string, uint64, []byte,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyPacketAcknowledgement panics!
+func (cs ClientState) VerifyPacketAcknowledgement(
+	sdk.Context, sdk.KVStore, codec.BinaryCodec, exported.Height,
+	uint64, uint64, exported.Prefix, []byte,
+	string, string, uint64, []byte,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyPacketReceiptAbsence panics!
+func (cs ClientState) VerifyPacketReceiptAbsence(
+	sdk.Context, sdk.KVStore, codec.BinaryCodec, exported.Height,
+	uint64, uint64, exported.Prefix, []byte,
+	string, string, uint64,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// VerifyNextSequenceRecv panics!
+func (cs ClientState) VerifyNextSequenceRecv(
+	sdk.Context, sdk.KVStore, codec.BinaryCodec, exported.Height,
+	uint64, uint64, exported.Prefix, []byte,
+	string, string, uint64,
+) error {
+	panic("legacy solo machine is deprecated!")
+}
+
+// ClientType panics!
+func (ConsensusState) ClientType() string {
+	panic("legacy solo machine is deprecated!")
+}
+
+// GetTimestamp panics!
+func (cs ConsensusState) GetTimestamp() uint64 {
+	panic("legacy solo machine is deprecated!")
+}
+
+// GetRoot panics!
+func (cs ConsensusState) GetRoot() exported.Root {
+	panic("legacy solo machine is deprecated!")
+}
+
+// ValidateBasic panics!
+func (cs ConsensusState) ValidateBasic() error {
+	panic("legacy solo machine is deprecated!")
+}

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

@@ -24,6 +24,7 @@ import (
 // - Migrating solo machine client states from v1 to v2 protobuf definition
 // - Pruning all solo machine consensus states
 // - Pruning expired tendermint consensus states
+// - Adds ProcessedHeight and Iteration keys for unexpired tendermint consensus states
 func MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, cdc codec.BinaryCodec) (err error) {
 	store := ctx.KVStore(storeKey)
 	iterator := sdk.KVStorePrefixIterator(store, host.KeyClientStorePrefix)

modules/core/exported/client.go

@@ -2,10 +2,9 @@ package exported
 
 import (
 	ics23 "github.com/confio/ics23/go"
-	proto "github.com/gogo/protobuf/proto"
-
 	"github.com/cosmos/cosmos-sdk/codec"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	proto "github.com/gogo/protobuf/proto"
 )
 
 // Status represents the status of a client

modules/core/keeper/migrations.go

@@ -18,11 +18,10 @@ func NewMigrator(keeper Keeper) Migrator {
 
 // Migrate1to2 migrates from version 1 to 2.
 // This migration prunes:
-// - solo machine consensus states
-// - expired tendermint consensus states
-//
-// This migration migrates:
-// - solo machine client state from protobuf definition v1 to v2
+// - migrates solo machine client state from protobuf definition v1 to v2
+// - prunes solo machine consensus states
+// - prunes expired tendermint consensus states
+// - adds ProcessedHeight and Iteration keys for unexpired tendermint consensus states
 func (m Migrator) Migrate1to2(ctx sdk.Context) error {
 	clientMigrator := clientkeeper.NewMigrator(m.keeper.ClientKeeper)
 	if err := clientMigrator.Migrate1to2(ctx); err != nil {

modules/core/legacy/v100/genesis.go

@@ -1,13 +1,13 @@
 package v100
 
 import (
-	"time"
-
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/codec"
 	genutiltypes "github.com/cosmos/cosmos-sdk/x/genutil/types"
+	tmtypes "github.com/tendermint/tendermint/types"
 
 	clientv100 "github.com/cosmos/ibc-go/modules/core/02-client/legacy/v100"
+	clienttypes "github.com/cosmos/ibc-go/modules/core/02-client/types"
 	host "github.com/cosmos/ibc-go/modules/core/24-host"
 	"github.com/cosmos/ibc-go/modules/core/types"
 )
@@ -17,13 +17,16 @@ 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(appState genutiltypes.AppMap, clientCtx client.Context, genesisBlockTime time.Time) (genutiltypes.AppMap, error) {
+func MigrateGenesis(appState genutiltypes.AppMap, clientCtx client.Context, genDoc tmtypes.GenesisDoc) (genutiltypes.AppMap, error) {
 	if appState[host.ModuleName] != nil {
+		// ensure legacy solo machines are registered
+		clientv100.RegisterInterfaces(clientCtx.InterfaceRegistry)
+
 		// unmarshal relative source genesis application state
 		ibcGenState := &types.GenesisState{}
 		clientCtx.JSONCodec.MustUnmarshalJSON(appState[host.ModuleName], ibcGenState)
 
-		clientGenState, err := clientv100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &ibcGenState.ClientGenesis, genesisBlockTime)
+		clientGenState, err := clientv100.MigrateGenesis(codec.NewProtoCodec(clientCtx.InterfaceRegistry), &ibcGenState.ClientGenesis, genDoc.GenesisTime, clienttypes.NewHeight(clienttypes.ParseChainID(genDoc.ChainID), uint64(genDoc.InitialHeight)))
 		if err != nil {
 			return nil, err
 		}