x{stake,slash,gov,distrib} In-place Store Migrations

simapp/app_test.go

@@ -11,8 +11,28 @@ import (
 	tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
 	dbm "github.com/tendermint/tm-db"
 
+	"github.com/cosmos/cosmos-sdk/baseapp"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
+	"github.com/cosmos/cosmos-sdk/version"
+	"github.com/cosmos/cosmos-sdk/x/auth"
+	"github.com/cosmos/cosmos-sdk/x/auth/vesting"
+	"github.com/cosmos/cosmos-sdk/x/authz"
+	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
+	"github.com/cosmos/cosmos-sdk/x/capability"
+	"github.com/cosmos/cosmos-sdk/x/crisis"
+	"github.com/cosmos/cosmos-sdk/x/distribution"
+	"github.com/cosmos/cosmos-sdk/x/evidence"
+	feegrant "github.com/cosmos/cosmos-sdk/x/feegrant"
+	"github.com/cosmos/cosmos-sdk/x/genutil"
+	"github.com/cosmos/cosmos-sdk/x/gov"
+	transfer "github.com/cosmos/cosmos-sdk/x/ibc/applications/transfer"
+	ibc "github.com/cosmos/cosmos-sdk/x/ibc/core"
+	"github.com/cosmos/cosmos-sdk/x/mint"
+	"github.com/cosmos/cosmos-sdk/x/params"
+	"github.com/cosmos/cosmos-sdk/x/slashing"
+	"github.com/cosmos/cosmos-sdk/x/staking"
+	"github.com/cosmos/cosmos-sdk/x/upgrade"
 )
 
 func TestSimAppExportAndBlockedAddrs(t *testing.T) {
@@ -52,11 +72,34 @@ func TestGetMaccPerms(t *testing.T) {
 func TestRunMigrations(t *testing.T) {
 	db := dbm.NewMemDB()
 	encCfg := MakeTestEncodingConfig()
-	app := NewSimApp(log.NewTMLogger(log.NewSyncWriter(os.Stdout)), db, nil, true, map[int64]bool{}, DefaultNodeHome, 0, encCfg, EmptyAppOptions{})
-
-	// Create a new configurator for the purpose of this test.
+	logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
+	app := NewSimApp(logger, db, nil, true, map[int64]bool{}, DefaultNodeHome, 0, encCfg, EmptyAppOptions{})
+
+	// Create a new baseapp and configurator for the purpose of this test.
+	bApp := baseapp.NewBaseApp(appName, logger, db, encCfg.TxConfig.TxDecoder())
+	bApp.SetCommitMultiStoreTracer(nil)
+	bApp.SetAppVersion(version.Version)
+	bApp.SetInterfaceRegistry(encCfg.InterfaceRegistry)
+	app.BaseApp = bApp
 	app.configurator = module.NewConfigurator(app.MsgServiceRouter(), app.GRPCQueryRouter())
 
+	// We register all modules on the Configurator, except x/bank. x/bank will
+	// serve as the test subject on which we run the migration tests.
+	//
+	// The loop below is the same as calling `RegisterServices` on
+	// ModuleManager, except that we skip x/bank.
+	for _, module := range app.mm.Modules {
+		if module.Name() == banktypes.ModuleName {
+			continue
+		}
+
+		module.RegisterServices(app.configurator)
+	}
+
+	// Initialize the chain
+	app.InitChain(abci.RequestInitChain{})
+	app.Commit()
+
 	testCases := []struct {
 		name         string
 		moduleName   string
@@ -115,12 +158,30 @@ func TestRunMigrations(t *testing.T) {
 			}
 			require.NoError(t, err)
 
+			// Run migrations for all modules from their current
+			// Consensusversion, except x/bank, which we start from the initial
+			// version 1, as we are specifically testing x/bank.
 			err = app.RunMigrations(
 				app.NewContext(true, tmproto.Header{Height: app.LastBlockHeight()}),
 				module.MigrationMap{
-					"auth": 1, "authz": 1, "bank": 1, "staking": 1, "mint": 1, "distribution": 1,
-					"slashing": 1, "gov": 1, "params": 1, "ibc": 1, "upgrade": 1, "vesting": 1,
-					"feegrant": 1, "transfer": 1, "evidence": 1, "crisis": 1, "genutil": 1, "capability": 1,
+					"bank":         1,
+					"auth":         auth.AppModule{}.ConsensusVersion(),
+					"authz":        authz.AppModule{}.ConsensusVersion(),
+					"staking":      staking.AppModule{}.ConsensusVersion(),
+					"mint":         mint.AppModule{}.ConsensusVersion(),
+					"distribution": distribution.AppModule{}.ConsensusVersion(),
+					"slashing":     slashing.AppModule{}.ConsensusVersion(),
+					"gov":          gov.AppModule{}.ConsensusVersion(),
+					"params":       params.AppModule{}.ConsensusVersion(),
+					"ibc":          ibc.AppModule{}.ConsensusVersion(),
+					"upgrade":      upgrade.AppModule{}.ConsensusVersion(),
+					"vesting":      vesting.AppModule{}.ConsensusVersion(),
+					"feegrant":     feegrant.AppModule{}.ConsensusVersion(),
+					"transfer":     transfer.AppModule{}.ConsensusVersion(),
+					"evidence":     evidence.AppModule{}.ConsensusVersion(),
+					"crisis":       crisis.AppModule{}.ConsensusVersion(),
+					"genutil":      genutil.AppModule{}.ConsensusVersion(),
+					"capability":   capability.AppModule{}.ConsensusVersion(),
 				},
 			)
 			if tc.expRunErr {

types/module/module.go

@@ -339,7 +339,7 @@ func (m *Manager) ExportGenesis(ctx sdk.Context, cdc codec.JSONMarshaler) map[st
 }
 
 // MigrationHandler is the migration function that each module registers.
-type MigrationHandler func(store sdk.Context) error
+type MigrationHandler func(sdk.Context) error
 
 // MigrationMap is a map of moduleName -> version, where version denotes the
 // version from which we should perform the migration for each module.

x/bank/legacy/v040/keys.go

@@ -1,3 +1,5 @@
+// Package v040 is copy-pasted from:
+// https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/bank/types/key.go
 package v040
 
 import (

x/bank/legacy/v042/keys.go

@@ -1,3 +1,5 @@
+// Package v042 is copy-pasted from:
+// https://github.com/cosmos/cosmos-sdk/blob/bddbc131fd232a0c4c3acf402eb5880109c96281/x/bank/types/key.go
 package v042
 
 import (

x/bank/module.go

@@ -100,7 +100,7 @@ type AppModule struct {
 func (am AppModule) RegisterServices(cfg module.Configurator) {
 	types.RegisterMsgServer(cfg.MsgServer(), keeper.NewMsgServerImpl(am.keeper))
 	types.RegisterQueryServer(cfg.QueryServer(), am.keeper)
-	cfg.RegisterMigration(types.ModuleName, 0, func(ctx sdk.Context) error {
+	cfg.RegisterMigration(types.ModuleName, 1, func(ctx sdk.Context) error {
 		return am.keeper.(keeper.MigrationKeeper).Migrate1(ctx)
 	})
 }

x/distribution/keeper/migrations.go

@@ -0,0 +1,20 @@
+package keeper
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	v042 "github.com/cosmos/cosmos-sdk/x/distribution/legacy/v042"
+)
+
+// MigrationKeeper is an interface that the keeper implements for handling
+// in-place store migrations.
+type MigrationKeeper interface {
+	// Migrate1 migrates the store from version 1 to 2.
+	Migrate1(ctx sdk.Context) error
+}
+
+var _ MigrationKeeper = (*Keeper)(nil)
+
+// Migrate1 implements MigrationKeeper.Migrate1 method.
+func (keeper Keeper) Migrate1(ctx sdk.Context) error {
+	return v042.MigrateStore(ctx, keeper.storeKey)
+}

x/distribution/legacy/v040/keys.go

@@ -0,0 +1,196 @@
+// Package v040 is copy-pasted from:
+// https://github.com/cosmos/cosmos-sdk/blob/v0.41.0/x/distribution/types/keys.go
+package v040
+
+import (
+	"encoding/binary"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	v040auth "github.com/cosmos/cosmos-sdk/x/auth/legacy/v040"
+)
+
+const (
+	// ModuleName is the module name constant used in many places
+	ModuleName = "distribution"
+
+	// StoreKey is the store key string for distribution
+	StoreKey = ModuleName
+
+	// RouterKey is the message route for distribution
+	RouterKey = ModuleName
+
+	// QuerierRoute is the querier route for distribution
+	QuerierRoute = ModuleName
+)
+
+// Keys for distribution store
+// Items are stored with the following key: values
+//
+// - 0x00<proposalID_Bytes>: FeePol
+//
+// - 0x01: sdk.ConsAddress
+//
+// - 0x02<valAddr_Bytes>: ValidatorOutstandingRewards
+//
+// - 0x03<accAddr_Bytes>: sdk.AccAddress
+//
+// - 0x04<valAddr_Bytes><accAddr_Bytes>: DelegatorStartingInfo
+//
+// - 0x05<valAddr_Bytes><period_Bytes>: ValidatorHistoricalRewards
+//
+// - 0x06<valAddr_Bytes>: ValidatorCurrentRewards
+//
+// - 0x07<valAddr_Bytes>: ValidatorCurrentRewards
+//
+// - 0x08<valAddr_Bytes><height>: ValidatorSlashEvent
+var (
+	FeePoolKey                        = []byte{0x00} // key for global distribution state
+	ProposerKey                       = []byte{0x01} // key for the proposer operator address
+	ValidatorOutstandingRewardsPrefix = []byte{0x02} // key for outstanding rewards
+
+	DelegatorWithdrawAddrPrefix          = []byte{0x03} // key for delegator withdraw address
+	DelegatorStartingInfoPrefix          = []byte{0x04} // key for delegator starting info
+	ValidatorHistoricalRewardsPrefix     = []byte{0x05} // key for historical validators rewards / stake
+	ValidatorCurrentRewardsPrefix        = []byte{0x06} // key for current validator rewards
+	ValidatorAccumulatedCommissionPrefix = []byte{0x07} // key for accumulated validator commission
+	ValidatorSlashEventPrefix            = []byte{0x08} // key for validator slash fraction
+)
+
+// gets an address from a validator's outstanding rewards key
+func GetValidatorOutstandingRewardsAddress(key []byte) (valAddr sdk.ValAddress) {
+	addr := key[1:]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	return sdk.ValAddress(addr)
+}
+
+// gets an address from a delegator's withdraw info key
+func GetDelegatorWithdrawInfoAddress(key []byte) (delAddr sdk.AccAddress) {
+	addr := key[1:]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	return sdk.AccAddress(addr)
+}
+
+// gets the addresses from a delegator starting info key
+func GetDelegatorStartingInfoAddresses(key []byte) (valAddr sdk.ValAddress, delAddr sdk.AccAddress) {
+	addr := key[1 : 1+v040auth.AddrLen]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	valAddr = sdk.ValAddress(addr)
+	addr = key[1+v040auth.AddrLen:]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	delAddr = sdk.AccAddress(addr)
+	return
+}
+
+// gets the address & period from a validator's historical rewards key
+func GetValidatorHistoricalRewardsAddressPeriod(key []byte) (valAddr sdk.ValAddress, period uint64) {
+	addr := key[1 : 1+v040auth.AddrLen]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	valAddr = sdk.ValAddress(addr)
+	b := key[1+v040auth.AddrLen:]
+	if len(b) != 8 {
+		panic("unexpected key length")
+	}
+	period = binary.LittleEndian.Uint64(b)
+	return
+}
+
+// gets the address from a validator's current rewards key
+func GetValidatorCurrentRewardsAddress(key []byte) (valAddr sdk.ValAddress) {
+	addr := key[1:]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	return sdk.ValAddress(addr)
+}
+
+// gets the address from a validator's accumulated commission key
+func GetValidatorAccumulatedCommissionAddress(key []byte) (valAddr sdk.ValAddress) {
+	addr := key[1:]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	return sdk.ValAddress(addr)
+}
+
+// gets the height from a validator's slash event key
+func GetValidatorSlashEventAddressHeight(key []byte) (valAddr sdk.ValAddress, height uint64) {
+	addr := key[1 : 1+v040auth.AddrLen]
+	if len(addr) != v040auth.AddrLen {
+		panic("unexpected key length")
+	}
+	valAddr = sdk.ValAddress(addr)
+	startB := 1 + v040auth.AddrLen
+	b := key[startB : startB+8] // the next 8 bytes represent the height
+	height = binary.BigEndian.Uint64(b)
+	return
+}
+
+// gets the outstanding rewards key for a validator
+func GetValidatorOutstandingRewardsKey(valAddr sdk.ValAddress) []byte {
+	return append(ValidatorOutstandingRewardsPrefix, valAddr.Bytes()...)
+}
+
+// gets the key for a delegator's withdraw addr
+func GetDelegatorWithdrawAddrKey(delAddr sdk.AccAddress) []byte {
+	return append(DelegatorWithdrawAddrPrefix, delAddr.Bytes()...)
+}
+
+// gets the key for a delegator's starting info
+func GetDelegatorStartingInfoKey(v sdk.ValAddress, d sdk.AccAddress) []byte {
+	return append(append(DelegatorStartingInfoPrefix, v.Bytes()...), d.Bytes()...)
+}
+
+// gets the prefix key for a validator's historical rewards
+func GetValidatorHistoricalRewardsPrefix(v sdk.ValAddress) []byte {
+	return append(ValidatorHistoricalRewardsPrefix, v.Bytes()...)
+}
+
+// gets the key for a validator's historical rewards
+func GetValidatorHistoricalRewardsKey(v sdk.ValAddress, k uint64) []byte {
+	b := make([]byte, 8)
+	binary.LittleEndian.PutUint64(b, k)
+	return append(append(ValidatorHistoricalRewardsPrefix, v.Bytes()...), b...)
+}
+
+// gets the key for a validator's current rewards
+func GetValidatorCurrentRewardsKey(v sdk.ValAddress) []byte {
+	return append(ValidatorCurrentRewardsPrefix, v.Bytes()...)
+}
+
+// gets the key for a validator's current commission
+func GetValidatorAccumulatedCommissionKey(v sdk.ValAddress) []byte {
+	return append(ValidatorAccumulatedCommissionPrefix, v.Bytes()...)
+}
+
+// gets the prefix key for a validator's slash fractions
+func GetValidatorSlashEventPrefix(v sdk.ValAddress) []byte {
+	return append(ValidatorSlashEventPrefix, v.Bytes()...)
+}
+
+// gets the prefix key for a validator's slash fraction (ValidatorSlashEventPrefix + height)
+func GetValidatorSlashEventKeyPrefix(v sdk.ValAddress, height uint64) []byte {
+	heightBz := make([]byte, 8)
+	binary.BigEndian.PutUint64(heightBz, height)
+	return append(
+		ValidatorSlashEventPrefix,
+		append(v.Bytes(), heightBz...)...,
+	)
+}
+
+// gets the key for a validator's slash fraction
+func GetValidatorSlashEventKey(v sdk.ValAddress, height, period uint64) []byte {
+	periodBz := make([]byte, 8)
+	binary.BigEndian.PutUint64(periodBz, period)
+	prefix := GetValidatorSlashEventKeyPrefix(v, height)
+	return append(prefix, periodBz...)
+}