fix: Fix v0.45->v0.46 migration (backport cosmos#12028) (cosmos#12082)

* fix: Fix v0.45->v0.46 migration (cosmos#12028)

closes cosmos#12027

- Add `tendermint key-migrate` subcommand
- Fix in-place store migrations

Test:
- on v0.45 node, make a proposal to update software, make it pass
- wait for node to halt
- on v0.46 binary, run `simd tendermint key-migrate`
- on v0.46 binary, run `simd start --mode validator`
- make sure the v0.46 node runs correctly

---

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)

(cherry picked from commit ca0b8f9)

* fix conflicts

* Update changelog

Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>

CHANGELOG.md

@@ -37,9 +37,16 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ## [Unreleased]
 
+* (cli) [#12028](https://github.com/cosmos/cosmos-sdk/pull/12028) Add the `tendermint key-migrate` to perform Tendermint v0.35 DB key migration.
+
+### Bug Fixes
+
+* (migrations) [#12028](https://github.com/cosmos/cosmos-sdk/pull/12028) Fix v0.45->v0.46 in-place store migrations.
+
+## [v0.46.0-rc1](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.46.0-rc1) - 2022-05-23
+
 ### Features
 
-* (types) [#11985](https://github.com/cosmos/cosmos-sdk/pull/11985) Add a `Priority` field on `sdk.Context`, which represents the CheckTx priority field. It is only used during CheckTx.
 * (gRPC) [#11889](https://github.com/cosmos/cosmos-sdk/pull/11889) Support custom read and write gRPC options in `app.toml`. See `max-recv-msg-size` and `max-send-msg-size` respectively.
 * (cli) [\#11738](https://github.com/cosmos/cosmos-sdk/pull/11738) Add `tx auth multi-sign` as alias of `tx auth multisign` for consistency with `multi-send`.
 * (cli) [\#11738](https://github.com/cosmos/cosmos-sdk/pull/11738) Add `tx bank multi-send` command for bulk send of coins to multiple accounts.

server/tm_cmds.go

@@ -3,10 +3,14 @@ package server
 // DONTCOVER
 
 import (
+	"context"
 	"fmt"
 
 	"github.com/spf13/cobra"
+	cfg "github.com/tendermint/tendermint/config"
 	pvm "github.com/tendermint/tendermint/privval"
+	"github.com/tendermint/tendermint/scripts/keymigrate"
+	"github.com/tendermint/tendermint/scripts/scmigrate"
 	tversion "github.com/tendermint/tendermint/version"
 	"sigs.k8s.io/yaml"
 
@@ -123,3 +127,67 @@ func VersionCmd() *cobra.Command {
 		},
 	}
 }
+
+// makeKeyMigrateCmd is ported from tendermint's key-migrate command, but
+// uses the SDK's own server.Context.
+// ref: https://github.com/tendermint/tendermint/blob/master/UPGRADING.md#database-key-format-changes
+func makeKeyMigrateCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "key-migrate",
+		Short: "Run Tendermint database key migration",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			ctx, cancel := context.WithCancel(cmd.Context())
+			defer cancel()
+
+			serverCtx := GetServerContextFromCmd(cmd)
+			config := serverCtx.Config
+
+			contexts := []string{
+				// this is ordered to put the
+				// (presumably) biggest/most important
+				// subsets first.
+				"blockstore",
+				"state",
+				"peerstore",
+				"tx_index",
+				"evidence",
+				"light",
+			}
+
+			for idx, dbctx := range contexts {
+				serverCtx.Logger.Info("beginning a key migration",
+					"dbctx", dbctx,
+					"num", idx+1,
+					"total", len(contexts),
+				)
+
+				db, err := cfg.DefaultDBProvider(&cfg.DBContext{
+					ID:     dbctx,
+					Config: config,
+				})
+
+				if err != nil {
+					return fmt.Errorf("constructing database handle: %w", err)
+				}
+
+				if err = keymigrate.Migrate(ctx, db); err != nil {
+					return fmt.Errorf("running migration for context %q: %w",
+						dbctx, err)
+				}
+
+				if dbctx == "blockstore" {
+					if err := scmigrate.Migrate(ctx, db); err != nil {
+						return fmt.Errorf("running seen commit migration: %w", err)
+
+					}
+				}
+			}
+
+			serverCtx.Logger.Info("completed database migration successfully")
+
+			return nil
+		},
+	}
+
+	return cmd
+}

server/util.go

@@ -283,6 +283,7 @@ func AddCommands(rootCmd *cobra.Command, defaultNodeHome string, appCreator type
 		tmcmd.ResetAllCmd,
 		tmcmd.ResetStateCmd,
 		tmcmd.InspectCmd,
+		makeKeyMigrateCmd(),
 	)
 
 	startCmd := StartCmd(appCreator, defaultNodeHome)

simapp/app.go

@@ -296,6 +296,8 @@ func NewSimApp(
 	// set the BaseApp's parameter store
 	bApp.SetParamStore(app.ParamsKeeper.Subspace(baseapp.Paramspace).WithKeyTable(paramstypes.ConsensusParamsKeyTable()))
 
+	app.UpgradeKeeper = upgradeKeeper
+
 	app.CapabilityKeeper = capabilitykeeper.NewKeeper(appCodec, keys[capabilitytypes.StoreKey], memKeys[capabilitytypes.MemStoreKey])
 	// Applications that wish to enforce statically created ScopedKeepers should call `Seal` after creating
 	// their scoped modules in `NewApp` with `ScopeToModule`
@@ -365,11 +367,6 @@ func NewSimApp(
 		),
 	)
 
-	upgradeKeeper.SetVersionSetter(app.BaseApp)
-	app.UpgradeKeeper = upgradeKeeper
-	// RegisterUpgradeHandlers is used for registering any on-chain upgrades
-	app.RegisterUpgradeHandlers()
-
 	app.NFTKeeper = nftkeeper.NewKeeper(keys[nftkeeper.StoreKey], appCodec, app.AccountKeeper, app.BankKeeper)
 
 	// create evidence keeper with router
@@ -454,6 +451,10 @@ func NewSimApp(
 	app.configurator = module.NewConfigurator(app.appCodec, app.MsgServiceRouter(), app.GRPCQueryRouter())
 	app.mm.RegisterServices(app.configurator)
 
+	// RegisterUpgradeHandlers is used for registering any on-chain upgrades.
+	// Make sure it's called after `app.mm` and `app.configurator` are set.
+	app.RegisterUpgradeHandlers()
+
 	// add test gRPC service for testing gRPC queries in isolation
 	testdata_pulsar.RegisterQueryServer(app.GRPCQueryRouter(), testdata_pulsar.QueryImpl{})
 

simapp/upgrades.go

@@ -39,35 +39,7 @@ func GetUpgradeStoreOption(keeper upgradekeeper.Keeper) baseapp.StoreOption {
 
 func (app SimApp) RegisterUpgradeHandlers() {
 	app.UpgradeKeeper.SetUpgradeHandler(UpgradeName,
-		func(ctx sdk.Context, plan upgradetypes.Plan, _ module.VersionMap) (module.VersionMap, error) {
-			// We set fromVersion to 1 to avoid running InitGenesis for modules for
-			// in-store migrations.
-			//
-			// If you wish to skip any module migrations, i.e. they were already migrated
-			// in an older version, you can use `modulename.AppModule{}.ConsensusVersion()`
-			// instead of `1` below.
-			//
-			// For example:
-			// "auth":	auth.AppModule{}.ConsensusVersion()
-			fromVM := map[string]uint64{
-				"auth":         1,
-				"authz":        1,
-				"bank":         1,
-				"capability":   1,
-				"crisis":       1,
-				"distribution": 1,
-				"evidence":     1,
-				"feegrant":     1,
-				"gov":          1,
-				"mint":         1,
-				"params":       1,
-				"slashing":     1,
-				"staking":      1,
-				"upgrade":      1,
-				"vesting":      1,
-				"genutil":      1,
-			}
-
+		func(ctx sdk.Context, plan upgradetypes.Plan, fromVM module.VersionMap) (module.VersionMap, error) {
 			return app.mm.RunMigrations(ctx, app.configurator, fromVM)
 		})
 }

x/staking/migrations/v046/store.go

@@ -8,7 +8,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/staking/types"
 )
 
-// MigrateStore performs in-place store migrations from v0.43/v0.44 to v0.45.
+// MigrateStore performs in-place store migrations from v0.43/v0.44/v0.45 to v0.46.
 // The migration includes:
 //
 // - Setting the MinCommissionRate param in the paramstore
@@ -19,6 +19,10 @@ func MigrateStore(ctx sdk.Context, storeKey storetypes.StoreKey, cdc codec.Binar
 }
 
 func migrateParamsStore(ctx sdk.Context, paramstore paramtypes.Subspace) {
-	paramstore.WithKeyTable(types.ParamKeyTable())
-	paramstore.Set(ctx, types.KeyMinCommissionRate, types.DefaultMinCommissionRate)
+	if paramstore.HasKeyTable() {
+		paramstore.Set(ctx, types.KeyMinCommissionRate, types.DefaultMinCommissionRate)
+	} else {
+		paramstore.WithKeyTable(types.ParamKeyTable())
+		paramstore.Set(ctx, types.KeyMinCommissionRate, types.DefaultMinCommissionRate)
+	}
 }