Add in-place store migrations

simapp/app.go

@@ -598,6 +598,32 @@ func (app *SimApp) RegisterTendermintService(clientCtx client.Context) {
  tmservice.RegisterTendermintService(app.BaseApp.GRPCQueryRouter(), clientCtx, app.interfaceRegistry)
 }
 
+// MigrateStore performs in-place store migrations. This function is not called
+// automatically, it is meant to be called from an x/upgrade UpgradeHandler.
+// `migrationsMap` is a map of moduleName to fromVersion (unit64), where
+// fromVersion denotes the version from which we should migrate the module.
+//
+// Example:
+// app.UpgradeKeeper.SetUpgradeHandler("store-migration", func(ctx sdk.Context, plan upgradetypes.Plan) {
+// err := app.MigrateStore(ctx, map[string]unint64{
+// "bank": 1, // Migrate x/bank from v1 to current x/bank's ConsensusVersion
+// "staking": 8, // Migrate x/staking from v8 to current x/staking's ConsensusVersion
+// })
+// if err != nil {
+// panic(err)
+// }
+// })
+func (app *SimApp) MigrateStore(ctx sdk.Context, migrationsMap map[string]uint64) error {
+ for moduleName, module := range app.mm.Modules {
+ err := module.MigrateStore(ctx, app.keys[moduleName], migrationsMap[moduleName])
+ if err != nil {
+ return err
+ }
+ }
+
+ return nil
+}
+
 // RegisterSwaggerAPI registers swagger route with API Server
 func RegisterSwaggerAPI(ctx client.Context, rtr *mux.Router) {
  statikFS, err := fs.New()

types/module/module.go

@@ -174,6 +174,12 @@ type AppModule interface {
  // RegisterServices allows a module to register services
  RegisterServices(Configurator)
 
+ // ConsensusVersion tracks state-breaking versions of the module
+ ConsensusVersion() uint64
+
+ // MigrateStore performs in-place store migrations.
+ MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error
+
  // ABCI
  BeginBlock(sdk.Context, abci.RequestBeginBlock)
  EndBlock(sdk.Context, abci.RequestEndBlock) []abci.ValidatorUpdate
@@ -208,6 +214,14 @@ func (gam GenesisOnlyAppModule) LegacyQuerierHandler(*codec.LegacyAmino) sdk.Que
 // RegisterServices registers all services.
 func (gam GenesisOnlyAppModule) RegisterServices(Configurator) {}
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (gam GenesisOnlyAppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (gam GenesisOnlyAppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns an empty module begin-block
 func (gam GenesisOnlyAppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {}
 

x/auth/legacy/v040/store.go

@@ -0,0 +1,4 @@
+package v040
+
+// AddrLen defines a valid address length
+const AddrLen = 20

x/auth/module.go

@@ -147,6 +147,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns the begin blocker for the auth module.
 func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/auth/vesting/module.go

@@ -127,3 +127,11 @@ func (am AppModule) EndBlock(_ sdk.Context, _ abci.RequestEndBlock) []abci.Valid
 func (am AppModule) ExportGenesis(_ sdk.Context, cdc codec.JSONMarshaler) json.RawMessage {
  return am.DefaultGenesis(cdc)
 }
+
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}

x/authz/module.go

@@ -152,6 +152,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {}
 
 // EndBlock does nothing

x/bank/legacy/v040/store.go

@@ -0,0 +1,25 @@
+package v040
+
+import (
+ "fmt"
+
+ sdk "github.com/cosmos/cosmos-sdk/types"
+ v040auth "github.com/cosmos/cosmos-sdk/x/auth/legacy/v040"
+)
+
+// KVStore keys
+var (
+ BalancesPrefix = []byte("balances")
+)
+
+// AddressFromBalancesStore returns an account address from a balances prefix
+// store. The key must not contain the perfix BalancesPrefix as the prefix store
+// iterator discards the actual prefix.
+func AddressFromBalancesStore(key []byte) sdk.AccAddress {
+ addr := key[:v040auth.AddrLen]
+ if len(addr) != v040auth.AddrLen {
+ panic(fmt.Sprintf("unexpected account address key length; got: %d, expected: %d", len(addr), v040auth.AddrLen))
+ }
+
+ return sdk.AccAddress(addr)
+}

x/bank/legacy/v042/store.go

@@ -0,0 +1,59 @@
+package v042
+
+import (
+ "github.com/cosmos/cosmos-sdk/store/prefix"
+ sdk "github.com/cosmos/cosmos-sdk/types"
+ "github.com/cosmos/cosmos-sdk/types/address"
+ v040auth "github.com/cosmos/cosmos-sdk/x/auth/legacy/v040"
+ v040bank "github.com/cosmos/cosmos-sdk/x/bank/legacy/v040"
+)
+
+// KVStore keys
+var (
+ // BalancesPrefix is the for the account balances store. We use a byte
+ // (instead of say `[]]byte("balances")` to save some disk space).
+ BalancesPrefix = []byte{0x02}
+)
+
+// AddressFromBalancesStore returns an account address from a balances prefix
+// store. The key must not contain the perfix BalancesPrefix as the prefix store
+// iterator discards the actual prefix.
+func AddressFromBalancesStore(key []byte) sdk.AccAddress {
+ addrLen := key[0]
+ addr := key[1 : addrLen+1]
+
+ return sdk.AccAddress(addr)
+}
+
+// CreateAccountBalancesPrefix creates the prefix for an account's balances.
+func CreateAccountBalancesPrefix(addr []byte) []byte {
+ return append(BalancesPrefix, address.MustLengthPrefix(addr)...)
+}
+
+// StoreMigration performs in-place store migrations from v0.40 to v0.42. The
+// migration includes:
+//
+// - Change addresses to be length-prefixed.
+// - Change balances prefix to 1 byte
+func StoreMigration(store sdk.KVStore) error {
+ // old key is of format:
+ // prefix ("balances") || addrBytes (20 bytes) || denomBytes
+ // new key is of format
+ // prefix (0x02) || addrLen (1 byte) || addrBytes || denomBytes
+ oldStore := prefix.NewStore(store, v040bank.BalancesPrefix)
+ newStore := prefix.NewStore(store, BalancesPrefix)
+
+ oldStoreIter := oldStore.Iterator(nil, nil)
+ defer oldStoreIter.Close()
+
+ for ; oldStoreIter.Valid(); oldStoreIter.Next() {
+ addr := v040bank.AddressFromBalancesStore(oldStoreIter.Key())
+ denom := oldStoreIter.Key()[1+v040auth.AddrLen:]
+ newStoreKey := append(CreateAccountBalancesPrefix(addr), denom...)
+
+ newStore.Set(newStoreKey, oldStoreIter.Value()) // Values don't change.
+ oldStore.Delete(oldStoreIter.Key())
+ }
+
+ return nil
+}

x/bank/legacy/v042/store_test.go

@@ -0,0 +1,7 @@
+package v042_test
+
+import "testing"
+
+func TestStoreMigration(t *testing.T) {
+ // TODO
+}

x/bank/legacy/v042/types.go

@@ -0,0 +1,5 @@
+package v042
+
+const (
+ ModuleName = "bank"
+)

x/bank/module.go

@@ -22,6 +22,7 @@ import (
  "github.com/cosmos/cosmos-sdk/x/bank/client/cli"
  "github.com/cosmos/cosmos-sdk/x/bank/client/rest"
  "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+ v042bank "github.com/cosmos/cosmos-sdk/x/bank/legacy/v042"
  "github.com/cosmos/cosmos-sdk/x/bank/simulation"
  "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
@@ -151,6 +152,30 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 1 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ // Map of version n -> migrate function from version n to version n+1.
+ migrationsMap := map[uint64]func(store sdk.KVStore) error{
+ 0: v042bank.StoreMigration,
+ }
+
+ // Run in-place migrations sequentially until current ConsensusVersion.
+ for i := fromVersion; i < am.ConsensusVersion(); i++ {
+ migrateFn, found := migrationsMap[i]
+ if found {
+ err := migrateFn(ctx.KVStore(storeKey))
+ if err != nil {
+ return err
+ }
+ }
+ }
+
+ return nil
+}
+
 // BeginBlock performs a no-op.
 func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/capability/module.go

@@ -136,6 +136,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(genState)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock executes all ABCI BeginBlock logic respective to the capability module.
 func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/crisis/module.go

@@ -158,6 +158,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock performs a no-op.
 func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/distribution/module.go

@@ -161,6 +161,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns the begin blocker for the distribution module.
 func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
  BeginBlocker(ctx, req, am.keeper)

x/evidence/module.go

@@ -175,6 +175,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(ExportGenesis(ctx, am.keeper))
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock executes all ABCI BeginBlock logic respective to the evidence module.
 func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
  BeginBlocker(ctx, req, am.keeper)

x/feegrant/module.go

@@ -167,6 +167,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns the begin blocker for the feegrant module.
 func (am AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/genutil/module.go

@@ -110,3 +110,11 @@ func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONMarshaler, data j
 func (am AppModule) ExportGenesis(_ sdk.Context, cdc codec.JSONMarshaler) json.RawMessage {
  return am.DefaultGenesis(cdc)
 }
+
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}

x/gov/module.go

@@ -177,6 +177,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock performs a no-op.
 func (AppModule) BeginBlock(_ sdk.Context, _ abci.RequestBeginBlock) {}
 

x/ibc/applications/transfer/module.go

@@ -145,6 +145,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock implements the AppModule interface
 func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
 }

x/ibc/core/module.go

@@ -156,6 +156,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(ExportGenesis(ctx, *am.keeper))
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns the begin blocker for the ibc module.
 func (am AppModule) BeginBlock(ctx sdk.Context, req abci.RequestBeginBlock) {
  ibcclient.BeginBlocker(ctx, am.keeper.ClientKeeper)

x/mint/module.go

@@ -146,6 +146,14 @@ func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) json
  return cdc.MustMarshalJSON(gs)
 }
 
+// ConsensusVersion tracks state-breaking versions of the module.
+func (AppModule) ConsensusVersion() uint64 { return 0 }
+
+// MigrateStore performs in-place store migrations.
+func (am AppModule) MigrateStore(ctx sdk.Context, storeKey sdk.StoreKey, fromVersion uint64) error {
+ return nil
+}
+
 // BeginBlock returns the begin blocker for the mint module.
 func (am AppModule) BeginBlock(ctx sdk.Context, _ abci.RequestBeginBlock) {
  BeginBlocker(ctx, am.keeper)