Upgrade Step-by-step

Overview

Preparation

  • Upgrade to likecoin/likecoin-chain:sheungwan-2 image to support halt-time parameter for upgrade purpose.

Pre-upgrade

  • Make sure you have all keys

    • operator key in .likecli folder, or in mnemonic format,

    • node key in .liked/config/node_key.json

    • consensus key in .liked/config/priv_validator_key.json

    backed up properly, in case anything disastrous happens.

  • Pass the proposal, determining the date, time, software version and parameters of the upgrade

  • Change the node config, so it will automatically halt at the determined upgrade time

During upgrade

  • Run a web conference with other validators

    • Need to discuss export height and genesis time in realtime

  • Export keys and files

    • Export node key and consensus key by copying the key files

    • Export address book by copying the key files

  • Create new genesis

    • Determine export height

    • Determine new chain genesis time

    • Export old chain state

    • Migrate old chain state to new chain genesis

    • Verify new chain state

  • Setup new chain node

    • Initialize new chain node

    • Import new chain state

    • Import operator key

    • Import node key and consensus key

    • Import address book

    • Migrate operator key

  • Start the node and wait for what would happen at the new chain genesis time

Setup sheungwan-2 node software

🧙♂Part I - Setup sheungwan-2 node software

Requirements

Requirements

Setup procedure

  1. Go into the running likecoin-chain node folder:

    cd likecoin-chain
  2. Fetch the latest repo:

    git fetch
  3. Switch to the sheungwan-2 software commit:

    git checkout sheungwan-2
  4. Shutdown the current node:

    docker-compose down
  5. Replace docker-compose.yml with docker-compose.yml.template:

    cp docker-compose.yml docker-compose.yml.sheungwan-1
    cp docker-compose.yml.template docker-compose.yml
    cp .env.template .env
  6. Edit .env file to fill in the details, including chain parameters and custom parameters:

    • LIKECOIN_DOCKER_IMAGE: "likecoin/likecoin-chain:sheungwan-2"

    • LIKECOIN_CHAIN_ID: "likecoin-chain-sheungwan"

    • LIKECOIN_UID: normally keep it as "1000" is fine, but if you are using root user under Linux (e.g. in some VPS) then you should change it to "0".

    • LIKECOIN_MONIKER: any name you want to call your node. Will be displayed on validator list as the name of the validator.

    • LIKECOIN_SEED_NODES: "[email protected]:26656"

  7. Start the node

    docker-compose up -d
  8. Check the logs:

    docker-compose logs --tail 100 -f

    You should see the node synchronizing the blocks from the network. You may stop the display of the logs by Ctrl+C at anytime, it won't stop the node operation.

  9. Check the software version:

    docker-compose run --rm liked-command version

    You should see sheungwan-2 as output.

Pre-upgrade: proposal & preparation

​​ 🧙♂ Part II - Pre-upgrade: proposal & preparation

Pre-upgrade

  1. Raise and pass a proposal on the upgrade.

    To raise a proposal, one of the validators run the following command:

    docker-compose run --rm likecli-command \
    tx gov submit-proposal \
    --chain-id likecoin-chain-sheungwan \
    --node tcp://liked-service:26657 \
    --from validator \
    --title "Upgrade software version to fotan-1" \
    --type text \
    --description <DESCRIPTION>

    Modify the parameters:

    • <DESCRIPTION>: the content of the proposal, which should include some introduction to the upgrade, and also the following contents:

      • the halt time (in both human-readable format with timezone, and also Unix timestamp)

      • the new chain parameters for the new ISCN module, namely:

        • ISCN registry name

        • ISCN fee per byte

      • the new software version (in Git commit hash)

      • and the new chain ID (e.g. likecoin-fotan-1)

  2. After the creation of the proposal, one may query the content of the proposal by:

    docker-compose run --rm likecli-command \
    query gov proposals \
    --chain-id likecoin-chain-sheungwan \
    --node tcp://liked-service:26657

    This will also show the proposal ID (should be 1 for the first proposal).

  3. To pass the proposal, all validators vote for the proposal by running:

    docker-compose run --rm vote 1 yes

    Which means vote "yes" in proposal ID 1.

  4. After the proposal is passed, setup chain halt time by modifying .env file and changing LIKECOIN_HALT_TIME to the Unix timestamp of the halt time in the proposal.

  5. Restart the chain node by running:

    docker-compose up -d
  6. Run the following command:

    docker-compose top liked-service

    Check the number after --halt-time below the CMD column. You should see the Unix timestamp you have just set in the .env file instead of 0.

  7. Jot down the content of the proposal, since chain explorers and APIs may not work during upgrade.

During upgrade

🧙♂ Part III - During the upgrade

  1. Right before the upgrade, validators should jot down the content of the proposal, since chain explorers and APIs may not work during the upgrade.

  2. Validators should hold a meeting right before the upgrade time for discussing issues during the upgrade.

  3. When the upgrade time comes, the chain node should be halt automatically.

  4. Go into the node folder:

    cd likecoin-chain
  5. Turn down the node:

    docker-compose stop
  6. Check the consensus public key:

    docker-compose run --rm liked-command tendermint show-validator

    Record the output as consensus public key for later verification.

  7. Check the node ID:

    docker-compose run --rm liked-command tendermint show-node-id

    Record the output as node ID for later verification

  8. Check the halting height of the node by:

    docker-compose run --rm liked-command show-height
  9. Confirm with other validators for the minimum height of exporting the state. The principle is to have consent and prevent state lost. For example, if the heights are 1234, 1234, 1234, 1233, 1233 for different validators, then validators may use 1233 as the height for exporting state.

  10. Export chain state:

    docker-compose run --rm liked-command \
    export --for-zero-height \
    --height <HEIGHT> \
    > exported.json

    Where the <HEIGHT> is the height confirmed with other validators in the previous step.

  11. Copy node_key.json (node key), priv_validator_key.json (consensus key) and addrbook.json (address book) from .liked/config into the fotan node folder:

    mkdir keys
    cp .liked/config/node_key.json \
    .liked/config/priv_validator_key.json \
    .liked/config/addrbook.json \
    keys

    This is to preserve the same keys and address book for the new fotan node.

  12. Discuss with others the new genesis time, should have consensus according to the progress of the majority.

  13. Fetch the newest software branch for the upgrade:

    git fetch
  14. Checkout to the new software:

    git checkout fotan-1
  15. Use new template of docker-compose.yml from the new software:

    cp docker-compose.yml docker-compose.yml.old
    cp docker-compose.yml.template docker-compose.yml
  16. Modify .env for the new chain:

    • LIKECOIN_DOCKER_IMAGE: likecoin/likecoin-chain:fotan-1

    • LIKECOIN_CHAIN_ID: the new chain ID specified in the proposal.

    • LIKECOIN_HALT_TIME: "0" so that the new chain node can start up.

    • LIKECOIN_GENESIS_URL: "genesis.json". The init script will detect that it is a local file and copy it from the migrated genesis file generated in the next step.

  17. Migrate genesis state:

    docker-compose run --rm liked-command \
    migrate /host/exported.json \
    --log_level "error" \
    --chain-id <NEW_CHAIN_ID> \
    --iscn-registry-name <ISCN_REGISTRY_NAME> \
    --iscn-fee-per-byte <ISCN_FEE_PER_BYTE> \
    --genesis-time <GENESIS_TIME> \
    --output /host/genesis.json

    Where <NEW_CHAIN_ID>, <ISCN_REGISTRY_NAME> and <ISCN_FEE_PER_BYTE> should be modified to the values specified in the upgrade proposal, and <GENESIS_TIME> is determined in the previous step (format: YYYY-MM-DDThh:mm:ssZ, in UTC).

  18. Archive the old .liked folder:

    mv .liked .liked-old
  19. Compute the checksum of genesis state with others:

    sha256sum genesis.json

    For Mac, use the following command instead:

    shasum -a 256 genesis.json

    Verify the output checksum with other validators.

  20. Re-initialize the node:

    docker-compose run --rm init

    Note that this will create and write a new consensus public key at the end of .env file, which won't be used since we will use the original key instead. If you are already a validator, you will probably never use the field again so this is fine, but you are free to delete this line.

  21. (optional) Configure the new node (config.toml & app.toml, both are in .liked/config)

    • in app.toml:

      • setup minimum-gas-prices if needed, see the setting in your sheungwan node config

      • under [api] section, if you need a local RESTful API server, then set enable to true, and also setup the corresponding port mapping in docker-compose.yml

    • in config.toml:

      • under [p2p] section, if you don't want to use the --get-ip option in the command parameter when starting the node for retrieving your externally accessible IP from third parties, then you need to enter your external address and port in external_address (e.g. 123.123.123.123:26656)

  22. Migrate the operator key:

    docker-compose run liked-command keys migrate /host/.likecli

    Follow the instructions to migrate the keys in the old keystore.

    For passphrases, the first one is for decrypting the old keystore, and the following 2 are for creating the new keystore.

    Note that when it asks Skip key migration? [y/N]:, N actually means not skipping, which is what we need.

  23. Verify the operator key is properly imported:

    docker-compose run --rm liked-command keys list

    Check if the key with operator's address is listed and is the same address as before.

  24. Re-import node key, consensus key and address book:

    cp keys/node_key.json \
    keys/priv_validator_key.json \
    keys/addrbook.json \
    .liked/config
  25. Verify the consensus key has been properly imported:

    docker-compose run --rm liked-command \
    tendermint show-validator

    Verify that the output is the same as the previous recorded consensus public key.

  26. Verify the node key has been properly imported:

    docker-compose run --rm liked-command \
    tendermint show-node-id

    Verify that the output is the same as the previous recorded node ID.

  27. Restart the node:

    docker-compose up -d
  28. Monitor the logs:

    docker-compose logs -f
  29. Wait for the new genesis time to see if anything goes wrong.

  30. Properly process the .liked-old, .likecli and keys folders, so the credentials are not leaked.

When Upgrade failed

🧙♂ Part IV - When Upgrade failed

If fatal issues happened during the upgrade (e.g. serious software bugs), then with the consent from the majority of the validators, validators may give up the upgrade and restart the SheungWan chain.

The procedure is simple:

  1. Revert changes to docker-compose.yml and .env.

  2. Set halt-time to "0" in .env.

  3. Revert .liked folder from .liked-bak.

  4. Start the node by docker-compose up -d.

  5. Wait for enough validators to get online.