docs: Improve markdownlint configuration (#11104)
## Description Closes: #9404 --- ### 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 [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 - [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 - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/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 - [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... - [ ] 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)
This commit is contained in:
Julien Robert
@@ -12,9 +12,9 @@ You must upgrade to Stargate v0.42 before upgrading to v0.44. If you have not do
|
||||
|
||||
## Prerequisite Readings
|
||||
|
||||
- [Upgrading Modules](../building-modules/upgrade.html) {prereq}
|
||||
- [In-Place Store Migrations](../core/upgrade.html) {prereq}
|
||||
- [Cosmovisor](../run-node/cosmovisor.html) {prereq}
|
||||
* [Upgrading Modules](../building-modules/upgrade.html) {prereq}
|
||||
* [In-Place Store Migrations](../core/upgrade.html) {prereq}
|
||||
* [Cosmovisor](../run-node/cosmovisor.html) {prereq}
|
||||
|
||||
Cosmos SDK v0.44 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.
|
||||
|
||||
@@ -56,25 +56,25 @@ In the following example, we start a new chain from `v0.42`. The binary for this
|
||||
|
||||
From within the `cosmos-sdk` repository, check out the latest `v0.42.x` release:
|
||||
|
||||
```
|
||||
```sh
|
||||
git checkout release/v0.42.x
|
||||
```
|
||||
|
||||
Build the `simd` binary for the latest `v0.42.x` release (the genesis binary):
|
||||
|
||||
```
|
||||
```sh
|
||||
make build
|
||||
```
|
||||
|
||||
Reset `~/.simapp` (never do this in a production environment):
|
||||
|
||||
```
|
||||
```sh
|
||||
./build/simd unsafe-reset-all
|
||||
```
|
||||
|
||||
Configure the `simd` binary for testing:
|
||||
|
||||
```
|
||||
```sh
|
||||
./build/simd config chain-id test
|
||||
./build/simd config keyring-backend test
|
||||
./build/simd config broadcast-mode block
|
||||
@@ -84,19 +84,19 @@ Initialize the node and overwrite any previous genesis file (never do this in a
|
||||
|
||||
<!-- TODO: init does not read chain-id from config -->
|
||||
|
||||
```
|
||||
```sh
|
||||
./build/simd init test --chain-id test --overwrite
|
||||
```
|
||||
|
||||
Set the minimum gas price to `0stake` in `~/.simapp/config/app.toml`:
|
||||
|
||||
```
|
||||
```sh
|
||||
minimum-gas-prices = "0stake"
|
||||
```
|
||||
|
||||
For the purpose of this demonstration, change `voting_period` in `genesis.json` to a reduced time of 20 seconds (`20s`):
|
||||
|
||||
```
|
||||
```sh
|
||||
cat <<< $(jq '.app_state.gov.voting_params.voting_period = "20s"' $HOME/.simapp/config/genesis.json) > $HOME/.simapp/config/genesis.json
|
||||
```
|
||||
|
||||
@@ -105,7 +105,7 @@ 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 -->
|
||||
|
||||
```
|
||||
```sh
|
||||
./build/simd keys add validator
|
||||
./build/simd add-genesis-account validator 5000000000stake --keyring-backend test
|
||||
./build/simd gentx validator 1000000stake --chain-id test
|
||||
@@ -118,7 +118,7 @@ Now that our node is initialized and we are ready to start a new `simapp` chain,
|
||||
|
||||
Install the `cosmovisor` binary:
|
||||
|
||||
```
|
||||
```sh
|
||||
go install github.com/cosmos/cosmos-sdk/cosmovisor/cmd/cosmovisor@v0.1.0
|
||||
```
|
||||
|
||||
@@ -128,20 +128,20 @@ If you are using go `v1.15` or earlier, you will need to change out of the `cosm
|
||||
|
||||
Set the required environment variables:
|
||||
|
||||
```
|
||||
```sh
|
||||
export DAEMON_NAME=simd
|
||||
export DAEMON_HOME=$HOME/.simapp
|
||||
```
|
||||
|
||||
Set the optional environment variable to trigger an automatic restart:
|
||||
|
||||
```
|
||||
```sh
|
||||
export DAEMON_RESTART_AFTER_UPGRADE=true
|
||||
```
|
||||
|
||||
Create the folder for the genesis binary and copy the `v0.42.x` binary:
|
||||
|
||||
```
|
||||
```sh
|
||||
mkdir -p $DAEMON_HOME/cosmovisor/genesis/bin
|
||||
cp ./build/simd $DAEMON_HOME/cosmovisor/genesis/bin
|
||||
```
|
||||
@@ -154,7 +154,7 @@ Now that `cosmovisor` is installed and the genesis binary has been added, let's
|
||||
|
||||
Check out `release/v0.44.x`:
|
||||
|
||||
```
|
||||
```sh
|
||||
git checkout release/v0.44.x
|
||||
```
|
||||
|
||||
@@ -217,13 +217,13 @@ Add `storetypes` to imports:
|
||||
|
||||
Build the `simd` binary for `v0.44.x` (the upgrade binary):
|
||||
|
||||
```
|
||||
```sh
|
||||
make build
|
||||
```
|
||||
|
||||
Create the folder for the upgrade binary and copy the `v0.44.x` binary:
|
||||
|
||||
```
|
||||
```sh
|
||||
mkdir -p $DAEMON_HOME/cosmovisor/upgrades/v0.44/bin
|
||||
cp ./build/simd $DAEMON_HOME/cosmovisor/upgrades/v0.44/bin
|
||||
```
|
||||
@@ -234,13 +234,13 @@ Now that we have added the upgrade handler and prepared the upgrade binary, we a
|
||||
|
||||
Start the node using `cosmovisor`:
|
||||
|
||||
```
|
||||
```sh
|
||||
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):
|
||||
|
||||
```
|
||||
```sh
|
||||
./build/simd tx gov submit-proposal software-upgrade v0.44 --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
|
||||
|
||||
Reference in New Issue
Block a user