Testing Client Upgrade

Prerequisites

Gaiad (v7.0.*), for example:

gaiad version --log_level error --long | head -n4

Testing procedure

Setup using Gaia manager

Note: The gm.toml file that we're using here looks like this:

[global]
  add_to_hermes = true
  auto_maintain_config = true
  extra_wallets = 2
  gaiad_binary = "$GOPATH/bin/gaiad"
  hdpath = ""
  home_dir = "$HOME/.gm"
  ports_start_at = 27040
  validator_mnemonic = ""
  wallet_mnemonic = ""

  [global.hermes]
    binary = "<path/to/hermes>"
    config = "$HOME/.hermes/config.toml"
    log_level = "info"
    telemetry_enabled = true
    telemetry_host = "127.0.0.1"
    telemetry_port = 3001

[ibc-0]
  ports_start_at = 27000

[ibc-1]
  ports_start_at = 27010

Run the command gm start
Go to the file $HOME/.gm/ibc-0/config/genesis.json and change max_deposit_period and voting_period to a lower value, such as 120s
Run the commands: gm reset, gm hermes config and gm hermes keys

Test upgrading chain and client

Create one client on ibc-1 for ibc-0:

hermes create client --host-chain ibc-1 --reference-chain ibc-0

Success: CreateClient(
   CreateClient(
       Attributes {
           height: Height { revision: 1, height: 9 },
           client_id: ClientId(
               "07-tendermint-0",
           ),
           client_type: Tendermint,
           consensus_height: Height { revision: 0, height: 18 },
       },
   ),
)

Create and submit an upgrade plan for chain ibc-0:

Use test command to make an upgrade proposal. In the example below a software upgrade proposal is made for ibc-0, for the height 300 blocks from the latest height. 10000000stake is deposited. The proposal includes the upgraded client state constructed from the state of 07-tendermint-0 client on ibc-1 that was created in the previous step.

If the chain is using ibc-go version v8.0.0 or higher, the authority account for the governance module needs to be used. To query the account use:
```
gaiad --node tcp://localhost:27000 --home $HOME/.gm/ibc-0/ query auth module-account gov
```
```
hermes tx upgrade-chain --gov-account <QUERIED_ACCOUNT> --reference-chain ibc-0 --host-chain ibc-1 --host-client 07-tendermint-0 --amount 10000000 --height-offset 60
```
If the ibc-go version used is lower than v8.0.0 you can ignore the --gov-account flag as it will not be used.
```
hermes tx upgrade-chain --reference-chain ibc-0 --host-chain ibc-1 --host-client 07-tendermint-0 --amount 10000000 --height-offset 60
```
For this test, the --gov-account can be ignored.
```
Success: transaction::Hash(CE98D8D98091BA8016BD852D18056E54C4CB3C4525E7F40DD3C40B4FD0F2482B)
```

Verify that the proposal was accepted by querying the upgrade plan to check that it was submitted correctly.

Note: You can find the RPC port used to query the local node by running gm ports in order to see a list of the ports being used.

gaiad --node tcp://localhost:27000 query gov proposal 1 --home $HOME/.gm/ibc-0/

If successful, you should see output like this. Note that the status of the proposal near the bottom of the output should be PROPOSAL_STATUS_VOTING_PERIOD indicating that the voting period is still ongoing.

content:
  '@type': /ibc.core.client.v1.UpgradeProposal
  description: upgrade the chain software and unbonding period
  plan:
    height: "65"
    info: ""
    name: plan
    time: "0001-01-01T00:00:00Z"
    upgraded_client_state: null
  title: proposal 0
  upgraded_client_state:
    '@type': /ibc.lightclients.tendermint.v1.ClientState
    allow_update_after_expiry: false
    allow_update_after_misbehaviour: false
    chain_id: ibc-0
    frozen_height:
      revision_height: "0"
      revision_number: "0"
    latest_height:
      revision_height: "66"
      revision_number: "0"
    max_clock_drift: 0s
    proof_specs:
    - inner_spec:
        child_order:
        - 0
        - 1
        child_size: 33
        empty_child: null
        hash: SHA256
        max_prefix_length: 12
        min_prefix_length: 4
      leaf_spec:
        hash: SHA256
        length: VAR_PROTO
        prefix: AA==
        prehash_key: NO_HASH
        prehash_value: SHA256
      max_depth: 0
      min_depth: 0
    - inner_spec:
        child_order:
        - 0
        - 1
        child_size: 32
        empty_child: null
        hash: SHA256
        max_prefix_length: 1
        min_prefix_length: 1
      leaf_spec:
        hash: SHA256
        length: VAR_PROTO
        prefix: AA==
        prehash_key: NO_HASH
        prehash_value: SHA256
      max_depth: 0
      min_depth: 0
    trust_level:
      denominator: "0"
      numerator: "0"
    trusting_period: 0s
    unbonding_period: 1814400s
    upgrade_path:
    - upgrade
    - upgradedIBCState
deposit_end_time: "2022-07-06T15:14:38.993051Z"
final_tally_result:
  abstain: "0"
  "no": "0"
  no_with_veto: "0"
  "yes": "0"
proposal_id: "1"
status: PROPOSAL_STATUS_VOTING_PERIOD
submit_time: "2022-07-06T15:12:38.993051Z"
total_deposit:
- amount: "10000000"
  denom: stake
voting_end_time: "2022-07-06T15:14:38.993051Z"
voting_start_time: "2022-07-06T15:12:38.993051Z"

Vote on the proposal

The parameter 1 should match the proposal_id: from the upgrade proposal submitted at step 3. This command must be issued while the proposal status is PROPOSAL_STATUS_VOTING_PERIOD. Confirm transaction when prompted.

gaiad --node tcp://localhost:27000 tx gov vote 1 yes --home $HOME/.gm/ibc-0/data/ --keyring-backend test --keyring-dir $HOME/.gm/ibc-0/ --chain-id ibc-0 --from validator

confirm transaction before signing and broadcasting [y/N]: y

txhash: 50CC1C39FBB14F99580A916ADE7F02883FFCC35D7862153F16BE86138151E17C

Test the upgrade client CLI

The following command waits for the reference chain ibc-0 to halt and then performs the upgrade for client 07-tendermint-0 on ibc-1. It outputs two events, one for the updated client state, and another for the upgraded state. The --upgrade-height 65 value is taken from the height in the upgrade plan output.

hermes upgrade client --host-chain ibc-1 --client 07-tendermint-0 --upgrade-height 65

Success: [
    UpdateClient(
        h: 1-68, cs_h: 07-tendermint-0(0-65),
    ),
    UpgradeClient(
        UpgradeClient(
            Attributes {
                height: Height {
                    revision: 1,
                    height: 68,
                },
                client_id: ClientId(
                    "07-tendermint-0",
                ),
                client_type: Tendermint,
                consensus_height: Height {
                    revision: 0,
                    height: 66,
                },
            },
        ),
    ),
]

Hermes (IBC Relayer CLI) Documentation

Testing Client Upgrade

Prerequisites

Testing procedure

Setup using Gaia manager

Test upgrading chain and client