fix: Fix v0.45->v0.46 migration #12028

amaury1093 · 2022-05-24T14:07:56Z

Description

closes #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

Author Checklist

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...

Reviewers Checklist

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 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)

…-045-046-mig

amaury1093 · 2022-05-24T14:38:07Z

x/staking/migrations/v046/store.go

@@ -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() {


encountered the same bug as in #9484, so applied the same fix

server/tm_cmds.go

facundomedica · 2022-05-24T17:00:29Z

Is there a way of adding this inside the upgrade handler somehow? Has this happened before (the fact that we need to run another separate command for an upgrade)?

tac0turtle

utACK

server/tm_cmds.go

fedekunze · 2022-05-25T06:39:52Z

simapp/app.go

+	// RegisterUpgradeHandlers is used for registering any on-chain upgrades.
+	// Make sure it's called after `app.mm` and `app.configurator` are set.
+	app.RegisterUpgradeHandlers()


I feel this should be communicated in the release notes too

Release notes imo are brief & high-level (see proposed defs in #11587).

How about int he UPGRADING.md document?

amaury1093 · 2022-05-25T09:56:14Z

server/tm_cmds.go

+// ref: https://github.com/tendermint/tendermint/blob/master/UPGRADING.md#database-key-format-changes
+func makeKeyMigrateCmd() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "key-migrate",


Is there a way of adding this inside the upgrade handler somehow? Has this happened before (the fact that we need to run another separate command for an upgrade)?

@facundomedica In the upgrade handler, no. See the original issue, we need to run the key migration before starting tendermint, so way before the upgrade handler is called.

Alternative solution, the SDK's start command is a combination of TM's key-migrate + start.
key-migrate is idempotent, so it can be run multiple times.

However, if we decide to show logs, as we do in this PR and as it's done in tendermint, then those logs will be shown on each startup:

11:55AM INF beginning a key migration dbctx=blockstore num=1 total=6 11:55AM INF beginning a key migration dbctx=state num=2 total=6 11:55AM INF beginning a key migration dbctx=peerstore num=3 total=6 11:55AM INF beginning a key migration dbctx=tx_index num=4 total=6 11:55AM INF beginning a key migration dbctx=evidence num=5 total=6 11:55AM INF beginning a key migration dbctx=light num=6 total=6

Any opinions on separate key-migrate and start commands VS one start command which runs key-migrate under the hood?

…-045-046-mig

alexanderbez · 2022-05-26T14:51:15Z

server/tm_cmds.go

+			serverCtx := GetServerContextFromCmd(cmd)
+			config := serverCtx.Config
+
+			contexts := []string{


I'm shocked we have to actually write any substantial code here. I would've presumed Tendermint would've exposed a command that'll do all of this for us?

In any case, does Tendermint not expose the contexts we want to migrate?

TM exposes:

https://github.com/tendermint/tendermint/blob/f33722b4233159a31cdf6c33258fbc601cdbd1d4/cmd/tendermint/commands/key_migrate.go#L15

But it needs additional flags to get the DB dir right. In this PR, we use the same code, but with serverCtx.

I couldn't think of less code re-use, best I could do was to mention this was copy-pasted from tendermint - like other commands in that file.

I see. Such an easy problem to solve if the TM command just had a function that the command called instead. Sigh...

alexanderbez · 2022-05-26T14:53:04Z

I don't like that we have to implement the command in such a manner, but if there's no other choice, then oh well.

tac0turtle · 2022-05-27T08:19:21Z

I don't like that we have to implement the command in such a manner, but if there's no other choice, then oh well.

tendermint should of made it automatic, imo. having a command like this will cause sooooooooo many problems.

amaury1093 · 2022-05-27T09:29:52Z

tendermint should of made it automatic, imo. having a command like this will cause sooooooooo many problems.

Is this a better UX for sdk users? #12028 (comment)

amaury1093 · 2022-05-27T12:58:17Z

I'll automerge this, so that we can fix the network issues more easily, e.g. have #12067 also incorporate these changes here.

…-045-046-mig

## Description closes #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 --- ### Author Checklist *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 ### Reviewers Checklist *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) # Conflicts: # simapp/upgrades.go

* fix: Fix v0.45->v0.46 migration (#12028) ## Description closes #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 --- ### Author Checklist *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 ### Reviewers Checklist *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) # Conflicts: # simapp/upgrades.go * fix conflicts * Update changelog Co-authored-by: Amaury <[email protected]>

* 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 <[email protected]>

## Description 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 --- ### Author Checklist *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 ### Reviewers Checklist *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)

* fix: Fix v0.45->v0.46 migration (cosmos#12028) ## Description 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 --- ### Author Checklist *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 ### Reviewers Checklist *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) # Conflicts: # simapp/upgrades.go * fix conflicts * Update changelog Co-authored-by: Amaury <[email protected]>

fix: Fix v0.45->v0.46 migration

f7f181b

amaury1093 added the backport/0.46.x PR scheduled for inclusion in the v0.46's next stable release label May 24, 2022

Add comment

543fe08

amaury1093 mentioned this pull request May 24, 2022

Software upgrade fails from v0.45.4 to v0.46.0-rc1 #12027

Closed

4 tasks

amaury1093 added 2 commits May 24, 2022 16:21

Merge branch 'main' of ssh://github.com/cosmos/cosmos-sdk into am/fix…

11a48e4

…-045-046-mig

Make migration work

9884ac5

github-actions bot added the C:x/staking label May 24, 2022

amaury1093 added 2 commits May 24, 2022 16:34

changelog

fbb5bab

Add comment

3146574

amaury1093 marked this pull request as ready for review May 24, 2022 14:37

amaury1093 requested a review from a team as a code owner May 24, 2022 14:37

amaury1093 commented May 24, 2022

View reviewed changes

private function

8a8b57b

amaury1093 requested review from anilcse and kaustubhkapatral May 24, 2022 14:39

amaury1093 mentioned this pull request May 24, 2022

Manual Testing for v0.46 #11880

Closed

72 tasks

amaury1093 commented May 24, 2022

View reviewed changes

server/tm_cmds.go Outdated Show resolved Hide resolved

Update server/tm_cmds.go

73dfe79

tac0turtle approved these changes May 24, 2022

View reviewed changes

server/tm_cmds.go Show resolved Hide resolved

fedekunze reviewed May 25, 2022

View reviewed changes

amaury1093 commented May 25, 2022

View reviewed changes

Merge branch 'main' of ssh://github.com/cosmos/cosmos-sdk into am/fix…

55ae6b7

…-045-046-mig

kaustubhkapatral mentioned this pull request May 25, 2022

Network stops producing blocks after upgrade from v0.45.x to v0.46.0-rc1 #12041

Closed

4 tasks

amaury1093 assigned blushi May 25, 2022

alexanderbez approved these changes May 26, 2022

View reviewed changes

Merge branch 'main' into am/fix-045-046-mig

881179a

Merge branch 'main' into am/fix-045-046-mig

d8b5f0c

amaury1093 added the A:automerge Automatically merge PR once all prerequisites pass. label May 27, 2022

amaury1093 added 2 commits May 27, 2022 17:34

Merge branch 'main' into am/fix-045-046-mig

f9e46fb

Merge branch 'main' of ssh://github.com/cosmos/cosmos-sdk into am/fix…

26eebaf

…-045-046-mig

mergify bot merged commit ca0b8f9 into main May 30, 2022

mergify bot deleted the am/fix-045-046-mig branch May 30, 2022 08:17

mergify bot mentioned this pull request May 30, 2022

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

Merged

gsk967 mentioned this pull request Jun 10, 2022

Upgrade IAVL to SMT vulcanize/chiba-clonk#49

Closed

4 tasks

okwme mentioned this pull request Nov 8, 2022

Bank Metadata store key format changed between v0.45 and v0.46 #13797

Closed

alchemist-ti mentioned this pull request May 28, 2023

feat: add MinCommissionRate param classic-terra/cosmos-sdk#3

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Fix v0.45->v0.46 migration #12028

fix: Fix v0.45->v0.46 migration #12028

amaury1093 commented May 24, 2022 •

edited

Loading

amaury1093 May 24, 2022

facundomedica commented May 24, 2022

tac0turtle left a comment

fedekunze May 25, 2022

amaury1093 May 25, 2022

amaury1093 May 25, 2022

amaury1093 May 25, 2022

alexanderbez May 26, 2022

amaury1093 May 27, 2022 •

edited

Loading

alexanderbez May 27, 2022

alexanderbez commented May 26, 2022

tac0turtle commented May 27, 2022

amaury1093 commented May 27, 2022 •

edited

Loading

amaury1093 commented May 27, 2022

fix: Fix v0.45->v0.46 migration #12028

fix: Fix v0.45->v0.46 migration #12028

Conversation

amaury1093 commented May 24, 2022 • edited Loading

Description

Author Checklist

Reviewers Checklist

amaury1093 May 24, 2022

Choose a reason for hiding this comment

facundomedica commented May 24, 2022

tac0turtle left a comment

Choose a reason for hiding this comment

fedekunze May 25, 2022

Choose a reason for hiding this comment

amaury1093 May 25, 2022

Choose a reason for hiding this comment

amaury1093 May 25, 2022

Choose a reason for hiding this comment

amaury1093 May 25, 2022

Choose a reason for hiding this comment

alexanderbez May 26, 2022

Choose a reason for hiding this comment

amaury1093 May 27, 2022 • edited Loading

Choose a reason for hiding this comment

alexanderbez May 27, 2022

Choose a reason for hiding this comment

alexanderbez commented May 26, 2022

tac0turtle commented May 27, 2022

amaury1093 commented May 27, 2022 • edited Loading

amaury1093 commented May 27, 2022

amaury1093 commented May 24, 2022 •

edited

Loading

amaury1093 May 27, 2022 •

edited

Loading

amaury1093 commented May 27, 2022 •

edited

Loading