From 48becdf19a342e7478aa5839e6c10c985cbfc63b Mon Sep 17 00:00:00 2001 From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com> Date: Tue, 6 Jun 2023 18:22:35 +0200 Subject: [PATCH] docs: improve upgrading.md and changelog (backport #16429) (#16431) Co-authored-by: Julien Robert --- UPGRADING.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/UPGRADING.md b/UPGRADING.md index f4311b7eb620..db7994f36fbb 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -178,6 +178,19 @@ The `params` module will be removed in `v0.48`, as mentioned [in v0.46 release]( When performing a chain migration, the params table must be initizalied manually. This was done in the modules keepers in previous versions. Have a look at `simapp.RegisterUpgradeHandlers()` for an example. +#### `x/crisis` + +With the migrations of all modules away from `x/params`, the crisis module now has a store. +The store must be created during a chain upgrade to v0.47.x. + +```go +storetypes.StoreUpgrades{ + Added: []string{ + crisistypes.ModuleName, + }, +} +``` + #### `x/gov` ##### Minimum Proposal Deposit At Time of Submission @@ -190,7 +203,7 @@ By default, the new `MinInitialDepositRatio` parameter is set to zero during mig feature is disabled. If chains wish to utilize the minimum proposal deposits at time of submission, the migration logic needs to be modified to set the new parameter to the desired value. -##### New Proposal.Proposer field +##### New `Proposal.Proposer` field The `Proposal` proto has been updated with proposer field. For proposal state migraton developers can call `v4.AddProposerAddressToProposal` in their upgrade handler to update all existing proposal and make them compatible and **this migration is optional**. @@ -246,7 +259,17 @@ func (app SimApp) RegisterUpgradeHandlers() { } ``` -The old params module is required to still be imported in your app.go in order to handle this migration. +The `x/params` module should still be imported in your app.go in order to handle this migration. + +Because the `x/consensus` module is a new module, its store must be added while upgrading to v0.47.x: + +```go +storetypes.StoreUpgrades{ + Added: []string{ + consensustypes.ModuleName, + }, +} +``` ##### `app.go` changes