forked from celestiaorg/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add chain upgrade guide v0.43 (backport cosmos#9567) (cosmos#9725)
* docs: add chain upgrade guide v0.43 (cosmos#9567) ## Description <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> This pull request adds a chain upgrade guide and example for v0.43. This pull request also removes migration documentation specific to v0.42 and adds links to v0.42 documentation when referencing genesis migrations. --- ### 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... - [x] included the correct `docs:` prefix in the PR title - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - n/a - [x] followed the [documentation writing guidelines](https://github.com/cosmos/cosmos-sdk/blob/master/docs/DOC_WRITING_GUIDELINES.md) - [x] reviewed "Files changed" and left comments if necessary - [x] 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... - [x] confirmed the correct `docs:` prefix in the PR title - [x] confirmed all author checklist items have been addressed - [ ] confirmed that this PR only changes documentation - [ ] reviewed content for consistency - [ ] reviewed content for thoroughness - [ ] reviewed content for spelling and grammar - [ ] tested instructions (if applicable) (cherry picked from commit 6098d7e) # Conflicts: # cosmovisor/README.md * resolve conflicts Co-authored-by: Ryan Christoffersen <[email protected]> Co-authored-by: ryanchrypto <[email protected]>
- Loading branch information
3 people
authored
Oct 12, 2021
1 parent
31e9ef5
commit 08fe818
Showing
4 changed files
with
244 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,237 @@ | ||
| <!-- | ||
| order: 1 | ||
| --> | ||
|
|
||
| # Chain Upgrade Guide to v0.43 | ||
|
|
||
| This document provides guidelines for a chain upgrade from v0.42 to v0.43 and an example of the upgrade process using `simapp`. {synopsis} | ||
|
|
||
| ::: tip | ||
| You must upgrade to Stargate v0.42 before upgrading to v0.43. If you have not done so, please see [Chain Upgrade Guide to v0.42](/v0.42/migrations/chain-upgrade-guide-040.html). | ||
| ::: | ||
|
|
||
| ## Prerequisite Readings | ||
|
|
||
| - [Upgrading Modules](../building-modules/upgrade.html) {prereq} | ||
| - [In-Place Store Migrations](../core/upgrade.html) {prereq} | ||
| - [Cosmovisor](../run-node/cosmovisor.html) {prereq} | ||
|
|
||
| Cosmos SDK v0.43 introduces a new way of handling chain upgrades that no longer requires exporting state to JSON, making the necesssary changes, and then creating a new chain with the modified JSON as the new genesis file. | ||
|
|
||
| Instead of starting a new chain, the upgrade binary will read the existing database and perform in-place store migrations. This new way of handling chain upgrades can be used alongside [Cosmovisor](../run-node/cosmovisor.html) to make the upgrade process seamless. | ||
|
|
||
| ## In-Place Store Migrations | ||
|
|
||
| We recommend using [In-Place Store Migrations](../core/upgrade.html) to upgrade your chain from v0.42 to v0.43. The first step is to make sure all your modules follow the [Module Upgrade Guide](../building-modules/upgrade.html). The second step is to add an [upgrade handler](../core/upgrade.html#running-migrations) to `app.go`. | ||
|
|
||
| In this document, we'll provide an example of what the upgrade handler looks like for a chain upgrading module versions for the first time. It's critical to note that the initial version of each module must be set to `1` rather than `0` or else the upgrade handler will re-initialize each module. | ||
|
|
||
| In addition to migrating existing modules, the upgrade handler also performs store upgrades for new modules. In the example below, we'll be adding store migrations for two new modules made available in v0.43: `x/authz` and `x/feegrant`. | ||
|
|
||
| ## Using Cosmovisor | ||
|
|
||
| We recommend validators use [Cosmovisor](../run-node/cosmovisor.html), which is a process manager for running application binaries. For security reasons, we recommend validators build their own upgrade binaries rather than enabling the auto-download option. Validators may still choose to use the auto-download option if the necessary security guarantees are in place (i.e. the URL provided in the upgrade proposal for the downloadable upgrade binary includes a proper checksum). | ||
|
|
||
| Validators can use the auto-restart option to prevent unecessary downtime during the upgrade process. The auto-restart option will automatically restart the chain with the upgrade binary once the chain has halted at the proposed upgrade height. With the auto-restart option, validators can prepare the upgrade binary in advance and then relax at the time of the upgrade. | ||
|
|
||
| ## Migrating app.toml | ||
|
|
||
| With the update to `v0.43`, new server configuration options have been added to `app.toml`. The updates include new configuration sections for Rosetta and gRPC Web as well as a new configuration option for State Sync. Check out the default [`app.toml`](https://github.com/cosmos/cosmos-sdk/blob/release/v0.43.x/server/config/toml.go) file in the latest version of `v0.43` for more information. | ||
|
|
||
| ## Example: Simapp Upgrade | ||
|
|
||
| The following example will walk through the upgrade process using `simapp` as our blockchain application. We will be upgrading `simapp` from v0.42 to v0.43. We will be building the upgrade binary ourselves and enabling the auto-restart option. | ||
|
|
||
| *Note: In this example, we will be starting a new chain from `v0.42`. The binary for this version will be the genesis binary. For validators using Cosmovisor for the first time, the binary for the current version of the chain should be used as the genesis binary (i.e. the starting binary). For more information, see [Cosmovisor](../run-node/cosmovisor.html).* | ||
|
|
||
| ### Initial Setup | ||
|
|
||
| From within the `cosmos-sdk` repository, check out the latest `v0.42.x` release: | ||
|
|
||
| ``` | ||
| git checkout release/v0.42.x | ||
| ``` | ||
|
|
||
| Build the `simd` binary for the latest `v0.42.x` release (the genesis binary): | ||
|
|
||
| ``` | ||
| make build | ||
| ``` | ||
|
|
||
| Reset `~/.simapp` (never do this in a production environment): | ||
|
|
||
| ``` | ||
| ./build/simd unsafe-reset-all | ||
| ``` | ||
|
|
||
| Configure the `simd` binary for testing: | ||
|
|
||
| ``` | ||
| ./build/simd config chain-id test | ||
| ./build/simd config keyring-backend test | ||
| ./build/simd config broadcast-mode block | ||
| ``` | ||
|
|
||
| Initialize the node and overwrite any previous genesis file (never do this in a production environment): | ||
|
|
||
| <!-- TODO: init does not read chain-id from config --> | ||
|
|
||
| ``` | ||
| ./build/simd init test --chain-id test --overwrite | ||
| ``` | ||
|
|
||
| Set the minimum gas price to `0stake` in `~/.simapp/config/app.toml`: | ||
|
|
||
| ``` | ||
| minimum-gas-prices = "0stake" | ||
| ``` | ||
|
|
||
| For the purpose of this demonstration, change `voting_period` in `genesis.json` to a reduced time of 20 seconds (`20s`): | ||
|
|
||
| ``` | ||
| cat <<< $(jq '.app_state.gov.voting_params.voting_period = "20s"' $HOME/.simapp/config/genesis.json) > $HOME/.simapp/config/genesis.json | ||
| ``` | ||
|
|
||
| Create a new key for the validator, then add a genesis account and transaction: | ||
|
|
||
| <!-- TODO: add-genesis-account does not read keyring-backend from config --> | ||
| <!-- TODO: gentx does not read chain-id from config --> | ||
|
|
||
| ``` | ||
| ./build/simd keys add validator | ||
| ./build/simd add-genesis-account validator 5000000000stake --keyring-backend test | ||
| ./build/simd gentx validator 1000000stake --chain-id test | ||
| ./build/simd collect-gentxs | ||
| ``` | ||
|
|
||
| Now that our node is initialized and we are ready to start a new `simapp` chain, let's set up `cosmovisor` and the genesis binary. | ||
|
|
||
| ### Cosmovisor Setup | ||
|
|
||
| First, install or update `cosmovisor`: | ||
|
|
||
| ``` | ||
| go get github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor | ||
| ``` | ||
|
|
||
| Set the required environment variables: | ||
|
|
||
| ``` | ||
| export DAEMON_NAME=simd | ||
| export DAEMON_HOME=$HOME/.simapp | ||
| ``` | ||
|
|
||
| Set the optional environment variable to trigger an automatic restart: | ||
|
|
||
| ``` | ||
| export DAEMON_RESTART_AFTER_UPGRADE=true | ||
| ``` | ||
|
|
||
| Create the folder for the genesis binary and copy the `v0.42.x` binary: | ||
|
|
||
| ``` | ||
| mkdir -p $DAEMON_HOME/cosmovisor/genesis/bin | ||
| cp ./build/simd $DAEMON_HOME/cosmovisor/genesis/bin | ||
| ``` | ||
|
|
||
| Now that `cosmovisor` is installed and the genesis binary has been added, let's add the upgrade handler to `simapp/app.go` and prepare the upgrade binary. | ||
|
|
||
| ### Chain Upgrade | ||
|
|
||
| <!-- TODO: update example to use v0.43.x --> | ||
|
|
||
| Check out `release/v0.43.x`: | ||
|
|
||
| ``` | ||
| git checkout release/v0.43.x | ||
| ``` | ||
|
|
||
| Add the following to `simapp/app.go` inside `NewSimApp` and after `app.UpgradeKeeper`: | ||
|
|
||
| ```go | ||
| app.registerUpgradeHandlers() | ||
| ``` | ||
|
|
||
| Add the following to `simapp/app.go` after `NewSimApp` (to learn more about the upgrade handler, see the [In-Place Store Migrations](../core/upgrade.html)): | ||
|
|
||
| ```go | ||
| func (app *SimApp) registerUpgradeHandlers() { | ||
| app.UpgradeKeeper.SetUpgradeHandler("v0.43", func(ctx sdk.Context, plan upgradetypes.Plan, _ module.VersionMap) (module.VersionMap, error) { | ||
| // 1st-time running in-store migrations, using 1 as fromVersion to | ||
| // avoid running InitGenesis. | ||
| fromVM := map[string]uint64{ | ||
| "auth": 1, | ||
| "bank": 1, | ||
| "capability": 1, | ||
| "crisis": 1, | ||
| "distribution": 1, | ||
| "evidence": 1, | ||
| "gov": 1, | ||
| "mint": 1, | ||
| "params": 1, | ||
| "slashing": 1, | ||
| "staking": 1, | ||
| "upgrade": 1, | ||
| "vesting": 1, | ||
| "ibc": 1, | ||
| "genutil": 1, | ||
| "transfer": 1, | ||
| } | ||
|
|
||
| return app.mm.RunMigrations(ctx, app.configurator, fromVM) | ||
| }) | ||
|
|
||
| upgradeInfo, err := app.UpgradeKeeper.ReadUpgradeInfoFromDisk() | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| if upgradeInfo.Name == "v0.43" && !app.UpgradeKeeper.IsSkipHeight(upgradeInfo.Height) { | ||
| storeUpgrades := storetypes.StoreUpgrades{ | ||
| Added: []string{"authz", "feegrant"}, | ||
| } | ||
|
|
||
| // configure store loader that checks if version == upgradeHeight and applies store upgrades | ||
| app.SetStoreLoader(upgradetypes.UpgradeStoreLoader(upgradeInfo.Height, &storeUpgrades)) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Add `storetypes` to imports: | ||
|
|
||
| ```go | ||
| storetypes "github.com/cosmos/cosmos-sdk/store/types" | ||
| ``` | ||
|
|
||
| Build the `simd` binary for `v0.43.x` (the upgrade binary): | ||
|
|
||
| ``` | ||
| make build | ||
| ``` | ||
|
|
||
| Create the folder for the upgrade binary and copy the `v0.43.x` binary: | ||
|
|
||
| ``` | ||
| mkdir -p $DAEMON_HOME/cosmovisor/upgrades/v0.43/bin | ||
| cp ./build/simd $DAEMON_HOME/cosmovisor/upgrades/v0.43/bin | ||
| ``` | ||
|
|
||
| Now that we have added the upgrade handler and prepared the upgrade binary, we are ready to start `cosmovisor` and simulate the upgrade proposal process. | ||
|
|
||
| ### Upgrade Proposal | ||
|
|
||
| Start the node using `cosmovisor`: | ||
|
|
||
| ``` | ||
| cosmovisor start | ||
| ``` | ||
|
|
||
| Open a new terminal window and submit an upgrade proposal along with a deposit and a vote (these commands must be run within 20 seconds of each other): | ||
|
|
||
| ``` | ||
| ./build/simd tx gov submit-proposal software-upgrade v0.43 --title upgrade --description upgrade --upgrade-height 20 --from validator --yes | ||
| ./build/simd tx gov deposit 1 10000000stake --from validator --yes | ||
| ./build/simd tx gov vote 1 yes --from validator --yes | ||
| ``` | ||
|
|
||
| Confirm the chain automatically upgrades at height 20. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters