From f97580c773647b8210d5f85a89932c294c65a096 Mon Sep 17 00:00:00 2001 From: Kevin Davis Date: Thu, 4 Jun 2020 23:20:10 -0400 Subject: [PATCH] add migration proceedure (#549) --- contrib/kava-3/migration.md | 64 +++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 contrib/kava-3/migration.md diff --git a/contrib/kava-3/migration.md b/contrib/kava-3/migration.md new file mode 100644 index 00000000..f4c62b4b --- /dev/null +++ b/contrib/kava-3/migration.md @@ -0,0 +1,64 @@ +# Kava-3 Upgrade Instructions + +### Background + +The version of Kava for kava-3 is __v0.8__. + +Many changes have occurred in both the Kava software and the cosmos-sdk software since the launch of kava-2. The primary changes in Kava are the addition of modules that comprise the [CDP system](https://docs.kava.io/). To review cosmos-sdk changes, see the [changelog](https://github.com/cosmos/cosmos-sdk/blob/v0.38.4/CHANGELOG.md) and note that kava-3 is launching with __v0.38.4__ of the cosmos-sdk. + +### Risks + +As a validator, performing the upgrade procedure on your consensus nodes carries a heightened risk of double-signing and being slashed. The most important piece of this procedure is verifying your software version and genesis file hash before starting your validator and signing. + +The riskiest thing a validator can do is 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 a Kava developer before resetting your validator. + +### Recovery +Prior to exporting kava-2 state, validators are encouraged to take a full data snapshot at the export height before proceeding. Snapshotting depends heavily on infrastructure, but generally this can be done by backing up the .kvd and .kvcli directories. + +It is critically important to back-up the .kvcli/data/priv_validator_state.json file after stopping your kvd 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 v0.3.5 of the Kava software and restore to their latest snapshot before restarting their nodes. + +## Upgrade Procedure + +Set your node to produce the final block of kava-2 at __13:00__ UTC June 10th, 2020. Kava developers will update this PR with the final block number when it is reached. __Make sure the kvd process is stopped before proceeding and that you have backed up your validator__. Failure to backup your validator could make it impossible to restart your node if the upgrade fails. + +1. Export state + + ```sh + kvd export --for-zero-height > export-genesis.json + ``` + +2. Update to kava-3 + +```sh + # in the `kava` folder + git pull + git checkout v0.8.0 + make install + + # verify versions + kvd version --long + # [PLACEHOLDER] + kvcli version -long + # [PLACEHOLDER] + + # Migrate keys + kvcli keys migrate + + # Migrate genesis state + kvd migrate export-genesis.json > migrated-genesis.json + + # Migrate parameters + kvd write-params migrated-genesis.json --chain-id kava-3 --genesis-time 2020-06-10T14:00:00Z > genesis.json + + # Verify output of genesis migration + kvd validate-genesis genesis.json # should say it's valid + shasum -a 256 genesis.json + # [PLACEHOLDER] + + # Restart node with migrated genesis state + cp genesis.json ~/.kvd/config/genesis.json + kvd unsafe-reset-all + kvd start +``` \ No newline at end of file