Skip to content

Commit

Permalink
docs: improve upgrading.md and changelog (backport #16429) (#16431)
Browse files Browse the repository at this point in the history
Co-authored-by: Julien Robert <julien@rbrt.fr>
  • Loading branch information
mergify[bot] and julienrbrt authored Jun 6, 2023
1 parent dda81a2 commit 48becdf
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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**.

Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 48becdf

Please sign in to comment.