Skip to content

Latest commit

 

History

History
157 lines (107 loc) · 5.48 KB

README.md

File metadata and controls

157 lines (107 loc) · 5.48 KB
Raw

Upgrade from Neutron v4.2.1 to v4.2.3

This is an important security update. IT IS CONSENSUS BREAKING UPGRADE! Please apply the fix only at height 14638000.

Release Details

To upgrade neutron chain

Backups

Prior to the upgrade, validators are encouraged to take a full data snapshot. Snapshotting depends heavily on infrastructure, but generally this can be done by backing up the .neutrond directory. If you use Cosmovisor to upgrade, by default, Cosmovisor will backup your data upon upgrade.

It is critically important for validator operators to back-up the .neutrond/data/priv_validator_state.json file after stopping the neutrond process. This file is updated every block as your validator participates in 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.

Step 1: Alter systemd service configuration

We need to disable automatic restart of the node service. To do so please alter your neutrond.service file configuration and set appropriate lines to following values.

Restart=no 

Environment="DAEMON_ALLOW_DOWNLOAD_BINARIES=false"
Environment="DAEMON_RESTART_AFTER_UPGRADE=false"

After that you will need to run sudo systemctl daemon-reload to apply changes in the service configuration.

There is no need to restart the node yet; these changes will get applied during the node restart in the next step.

Step 2: Restart neutrond with a configured halt-height.

This upgrade requires neutrond to have knowledge of the planned halt height. Please be aware that there is an extra step at the end to revert to neutrond's original configurations.

There are two mutually exclusive options for this stage:

Option 1: Set the halt height by modifying app.toml

  • Stop the neutrond process.

  • Edit the application configuration file at ~/.neutrond/config/app.toml so that halt-height reflects the upgrade plan:

# Note: Commitment of state will be attempted on the corresponding block.
halt-height = 14638000

  • Start neutrond process

  • Wait for the upgrade height and confirm that the node has halted

Option 2: Restart the neutrond binary with command line flags

  • Stop the neutrond process.

  • Do not modify app.toml. Restart the neutrond process with the flag --halt-height:

neutrond --halt-height 14638000
  • Wait for the upgrade height and confirm that the node has halted

After performing these steps, the upgrade will proceed as usual using Cosmovisor.

Setup Cosmovisor

Create the updated Neutron binary of v4.2.3

Go to neutron directory if present else clone the repository

   git clone https://github.com/neutron-org/neutron.git

Follow these steps if neutron repo already present

   cd $HOME/neutron
   git pull
   git fetch --tags
   git checkout v4.2.3
   make install

Check the new neutron version, verify the latest commit hash

   $ neutrond version --long
   name: neutron
   server_name: neutrond
   version: 4.2.3
   commit: 1431916023f4d7213d3c808edb77468e329e7308
   ...

Or check checksum of the binary if you decided to download it

$ shasum -a 256 neutrond-linux-amd64
4765bbb29d669ab711162d6885357f429f2ecc156dc703089f27d9e4bc5f7d80  neutrond-linux-amd64

Make sure you are using the proper version of libwasm

You can check the version you are currently using by running the following command:

$ neutrond q wasm libwasmvm-version

2.0.3

The proper version is 2.0.3.

If the version on your machine is different you MUST change it immediately!

Ways to change libwasmvm

  • Use a statically built Neutrond binary from an official Neutron release: https://github.com/neutron-org/neutron/releases/tag/v4.2.3
  • If you built Neutron binary by yourself, libwasmvm should be loaded dynamically in your binary and somehow, the wrong libwasmvm library was present on your machine. You can change it by downloading the proper one and linking it to the Neutron binary manually:
  1. download a proper version of libwasmvm:
$ wget https://github.com/CosmWasm/wasmvm/releases/download/v2.0.3/libwasmvm.x86_64.so
  1. tell the linker where to find it:
$ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/lib/
  1. check that libwasmvm version is correct:
$ neutrond q wasm libwasmvm-version
2.0.3

Copy the new neutron (v4.2.3) binary to cosmovisor current directory

   cp $GOPATH/bin/neutrond ~/.neutrond/cosmovisor/current/bin

Keep in mind if the upgrade-info.json file is present in neutron home directory, cosmovisor may set back binary from the upgrade file as a current bin. In case this happens, delete the upgrade file.

Restore service file settings

If you are using a service file, restore the previous Restart settings in your service file:

Restart=On-failure

Reload the service control sudo systemctl daemon-reload.

Revert neutrond configurations

Depending on which path you chose for Step 1, either:

  • Reset halt-height = 0 option in the app.toml or
  • Remove it from start parameters of the neutrond binary and start node again