Skip to content

Latest commit

 

History

History
162 lines (111 loc) · 7.58 KB

chain-upgrade-guide-040.md

File metadata and controls

162 lines (111 loc) · 7.58 KB
Raw

Chain Upgrade Guide to v0.40

This document explains how to perform a chain upgrade from v0.39 to v0.40. {synopsis}

Risks

As a validator, performing the upgrade procedure on your consensus nodes carries a heightened risk of double-signing and being slashed: if your validator node votes for a block, and, in the same block time, restarts the upgraded node, this may lead to double-voting on a block.

The riskiest thing a validator can do is to discover that they made a mistake and repeat the upgrade procedure again during the network startup. If you discover a mistake in the process, the best thing to do is wait for the network to start before correcting it. If the network is halted and you have started with a different genesis file than the expected one, seek advice from the validator community.

Recovery

  • Prior to exporting the state, the validators are encouraged to take a full data snapshot at exported height. Exported height will be determined by a governance proposal. Data backup is usually done by copying daemon home directory, e.g.: ~/.simd

Note: we use "simd" as our app throughout this doc, be sure to replace with the name of your own binary.

It is critically important to back-up the validator state file, e.g.: ~/.simd/data/priv_validator_state.json file after stopping your daemon process. This file is updated every block as your validator participates in a consensus rounds. It is a critical file needed to prevent double-signing, in case the upgrade fails, and the previous chain needs to be restarted.

In the event that the upgrade does not succeed, validators and operators must downgrade back to old version of the software and restore to their latest snapshot before restarting their nodes.

Upgrade procedure

  1. The procedure is to export the state from the old binary, and import it with the new binary. First, verify your old binary version (which should use github.com/cosmos/[email protected].*) before exporting the state.

    simd version --long

  2. Export the state from existing chain using the old binary.

    simd export --for-zero-height --height <height> > v039_exported_state.json

  3. Verify the SHA256 of the (sorted) exported genesis file:

    $ jq -S -c -M '' v039_exported_state.json | shasum -a 256
[SHASUM_PLACEHOLDER]  v039_exported_state.json

  4. Cross check the hash with other peers (other validators) in the chat rooms.

  5. Install the latest binary (which uses github.com/cosmos/[email protected].*).

  6. Migrate the exported state to github.com/cosmos/[email protected].* compatible genesis state.

    simd migrate v0.40 v039_exported_state.json --chain-id <new_chain_id> --genesis-time <new_genesis_time_in_utc> > new_v040_genesis.json

    Note: The migrate command takes an input genesis state and migrates it to a targeted version. New genesis-time will be as mentioned in the governance proposal.

  7. All the necessary state changes are handled in the simd migrate v0.40 migration command. However, Tendermint parameters are not handled in this command. You might need to update these parameters manually.

    In the recent versions of Tendermint, the following changes have been made:

    • consensus_params.evidence.max_num has been renamed to consensus_params.evidence.max_bytes.
    • consensus_params.evidence.max_age has been removed, and replaced by consensus_params.evidence.max_age_duration and consensus_params.evidence.max_age_num_blocks.

    Make sure that your genesis JSON files contains the correct values specific to your chain. If the simd migrate errors with a message saying that the genesis file cannot be parsed, these are the fields to check first.

  8. Verify the SHA256 of the migrated genesis file with other validators to make sure there are no manual errors in the process.

    $ jq -S -c -M '' new_v040_genesis.json | shasum -a 256
[SHASUM_PLACEHOLDER]  new_v040_genesis.json

  9. Make sure to update the genesis parameters in the new genesis if any. All these details will be generally present in the governance proposal.

  1. If your chain is using IBC, make sure to add IBC initial genesis state to the genesis file. You can use the following command to add IBC initial genesis state to the genesis file.

    cat new_v040_genesis.json | jq '.app_state |= . + {"ibc":{"client_genesis":{"clients":[],"clients_consensus":[],"create_localhost":false},"connection_genesis":{"connections":[],"client_connection_paths":[]},"channel_genesis":{"channels":[],"acknowledgements":[],"commitments":[],"receipts":[],"send_sequences":[],"recv_sequences":[],"ack_sequences":[]}},"transfer":{"port_id":"transfer","denom_traces":[],"params":{"send_enabled":false,"receive_enabled":false}},"capability":{"index":"1","owners":[]}}' > tmp_genesis.json && mv tmp_genesis.json new_v040_genesis.json

    Note: This would add IBC state with IBC's send_enabled: false and receive_enabled: false. Make sure to update them to true in the above command if are planning to enable IBC transactions with chain upgrade. Otherwise you can do it via a governance proposal.

  2. Reset the old state.

    Note: Be sure you have a complete backed up state of your node before proceeding with this step. See Recovery for details on how to proceed.

    simd unsafe-reset-all

  3. Move the new genesis.json to your daemon config directory. Ex

    cp new_v040_genesis.json ~/.simd/config/genesis.json

  4. Update ~/.simd/config/app.toml to include latest app configurations. Here is the link to the default template for v0.40's app.toml. Make sure to update your custom configurations as per your validator design, e.g. gas_price.

    Compared to v0.39, some notable updates to app.toml are:

    • API server is now configured to run in-process with daemon, previously it was a separate process, invoked by running rest-server command i.e., gaiacli rest-server. Now it is in-process with daemon and can be enabled/disabled by API configuration:

      [api]
# Enable defines if the API server should be enabled.
enable = false
# Swagger defines if swagger documentation should automatically be registered.
swagger = false

      swagger setting refers to enabling/disabling swagger docs API, i.e, /swagger/ API endpoint.

    • gRPC Configuration

      [grpc]
# Enable defines if the gRPC server should be enabled.
enable = true
# Address defines the gRPC server address to bind to.
address = "0.0.0.0:9090"

    • State Sync Configuration

      # State sync snapshots allow other nodes to rapidly join the network without replaying historical
# blocks, instead downloading and applying a snapshot of the application state at a given height.
[state-sync]
# snapshot-interval specifies the block interval at which local state sync snapshots are
# taken (0 to disable). Must be a multiple of pruning-keep-every.
snapshot-interval = 0
# snapshot-keep-recent specifies the number of recent snapshots to keep and serve (0 to keep all).
snapshot-keep-recent = 2

  5. Kill if any external rest-server process is running.

  6. All set now! You can (re)start your daemon to validate on the upgraded network. Make sure to check your binary version before starting the daemon:

    simd version --long

Next {hide}

Once your chain is upgraded, make sure to update your clients' REST endpoints.