Hermes CLI for upgrading client

CHANGELOG.md

@@ -20,6 +20,7 @@
 - [ibc-relayer-cli]
   - Added `create connection` CLI ([#630])
   - Proposed ADR 006 to describe Hermes v0.2.0 use-cases ([#637])
+  - Added `client-upgrade` CLI ([#357])
 
 ### IMPROVEMENTS
 
@@ -56,6 +57,7 @@
   - [nothing yet]
 
 [#352]: https://github.com/informalsystems/ibc-rs/issues/352
+[#357]: https://github.com/informalsystems/ibc-rs/issues/357
 [#561]: https://github.com/informalsystems/ibc-rs/issues/561
 [#599]: https://github.com/informalsystems/ibc-rs/issues/599
 [#630]: https://github.com/informalsystems/ibc-rs/issues/630

guide/src/upgrade_test.md

@@ -0,0 +1,166 @@
+## Prerequisites
+
+- gaiad
+```
+$ gaiad version --long | head -n4
+name: gaia
+server_name: gaiad
+version: 4.0.0
+commit: a279d091c6f66f8a91c87943139ebaecdd84f689
+```
+
+- Go relayer
+
+## Testing procedure
+
+1. Patch the `one-chain` script of the Go relayer.
+
+```shell
+cd ~/go/src/github.com/cosmos/relayer/
+```
+
+This pathing step is necessary to short-circuit the upgrading of a chain.
+With the changes below, a chain will be able to undergo an upgrade within
+~200 seconds of the upgrade proposal (instead of the default of 2 days).
+With this patch, we can test the upgrade functionality in a matter of minutes.
+
+```diff
+diff --git a/scripts/one-chain b/scripts/one-chain
+index d0995fe..3702a88 100755
+--- a/scripts/one-chain
++++ b/scripts/one-chain
+@@ -99,6 +99,7 @@ if [ $platform = 'linux' ]; then
+   sed -i 's/index_all_keys = false/index_all_keys = true/g' $CHAINDIR/$CHAINID/config/config.toml
+   # sed -i '' 's#index-events = \[\]#index-events = \["message.action","send_packet.packet_src_channel","send_packet.packet_sequence"\]#g' $CHAINDIR/$CHAINID/config/app.toml
+ else
++  sed -i '' 's#"172800s"#"200s"#g' $CHAINDIR/$CHAINID/config/genesis.json
+   sed -i '' 's#"tcp://127.0.0.1:26657"#"tcp://0.0.0.0:'"$RPCPORT"'"#g' $CHAINDIR/$CHAINID/config/config.toml
+   sed -i '' 's#"tcp://0.0.0.0:26656"#"tcp://0.0.0.0:'"$P2PPORT"'"#g' $CHAINDIR/$CHAINID/config/config.toml
+   sed -i '' 's#"localhost:6060"#"localhost:'"$P2PPORT"'"#g' $CHAINDIR/$CHAINID/config/config.toml
+```
+
+2. Start two gaia instances using the patched developer environment:
+
+```shell
+./scripts/two-chainz
+```
+
+3. Setup the Go relayer for these chains:
+```shell
+$ rly tx link demo -d -o 3s
+```
+
+Check that everything went fine so far:
+
+```shell
+$ rly paths list
+ 0: demo                 -> chns(✔) clnts(✔) conn(✔) chan(✔) (ibc-0:transfer<>ibc-1:transfer)
+```
+
+4. Create the upgrade plan for chain ibc-0:
+
+It's important that we parametrize the upgrade plan with a height parameter that
+is at least 300 heights ahead of the current height of chain ibc-0.
+
+First, obtain the current height:
+```shell
+gaiad query block | jq | grep height
+      "height": "470",
+```
+
+Now create the upgrade plan for height 800:
+```shell
+echo '{
+  "Name": "test",
+  "Height": 800,
+  "Info": ""
+}' > ./upgrade-plan.json
+```
+
+
+5. Submit the upgrade plan 
+
+```shell
+rly tx upgrade-chain demo ibc-0 400h 10000000stake ./upgrade-plan.json
+```
+
+Query for the upgrade plan, check that it was submitted correctly:
+
+```shell
+$ gaiad query gov proposal 1 --home data/ibc-0/
+
+content:
+  '@type': /cosmos.upgrade.v1beta1.SoftwareUpgradeProposal
+  description: upgrade the chain's software and unbonding period
+  plan:
+    height: "800"
+    info: ""
+    name: test
+....
+proposal_id: "1"
+status: PROPOSAL_STATUS_VOTING_PERIOD
+submit_time: "2021-03-08T13:07:01.417163Z"
+total_deposit:
+- amount: "10000000"
+  denom: stake
+voting_end_time: "2021-03-08T13:10:21.417163Z"
+voting_start_time: "2021-03-08T13:07:01.417163Z"
+```
+
+6. Vote on the proposal
+
+The parameter "1" should match the "proposal_id:" from the upgrade proposal
+we submitted at step 5.
+
+```shell
+gaiad tx gov vote 1 yes --home data/ibc-0/data/ --keyring-backend test --keyring-dir data/ibc-0/ --chain-id ibc-0 --from validator
+```
+
+Once ibc-0 reaches height 800, it should stop executing.
+
+
+7. Initialize and test Hermes
+
+```shell
+cd ~/rust/ibc-rs
+```
+
+
+Patch the developer env of Hermes, to redirect to the correct Gaia directory:
+```diff
+diff --git a/scripts/init-clients b/scripts/init-clients
+index 6cf1a674..bfff9721 100755
+--- a/scripts/init-clients
++++ b/scripts/init-clients
+@@ -49,7 +49,7 @@ if ! grep -q -s "$CHAIN_1_ID" "$CONFIG_FILE"; then
+   usage
+ fi
+
+-GAIA_DATA="$(pwd)/data"
++GAIA_DATA="~/go/src/github.com/cosmos/relayer/data"
+
+ CHAIN_0_RPC_PORT=26657
+ CHAIN_0_RPC_ADDR="localhost:$CHAIN_0_RPC_PORT"
+```
+
+No setup the clients for Hermes to use:
+
+```shell
+$ ./scripts/init-clients ~/.hermes/config.toml ibc-0 ibc-1
+    Building the Rust relayer...
+    Removing light client peers from configuration...
+    Adding primary peers to light client configuration...
+    Adding secondary peers to light client configuration...
+    Importing keys...
+    Done!
+```
+
+8. Test the `upgrade-client` CLI
+
+The following command will perform the upgrade for client `07-tendermint-0`. It
+will output two events, one for the updated client state, and another for the
+upgraded state.
+
+```shell
+hermes tx raw upgrade-client ibc-1 ibc-0 07-tendermint-0
+```

modules/src/events.rs

@@ -34,6 +34,7 @@ pub enum IbcEvent {
 
     CreateClient(ClientEvents::CreateClient),
     UpdateClient(ClientEvents::UpdateClient),
+    UpgradeClient(ClientEvents::UpgradeClient),
     ClientMisbehavior(ClientEvents::ClientMisbehavior),
 
     OpenInitConnection(ConnectionEvents::OpenInit),
@@ -111,6 +112,7 @@ impl IbcEvent {
             IbcEvent::NewBlock(ev) => ev.set_height(height),
             IbcEvent::CreateClient(ev) => ev.set_height(height),
             IbcEvent::UpdateClient(ev) => ev.set_height(height),
+            IbcEvent::UpgradeClient(ev) => ev.set_height(height),
             IbcEvent::ClientMisbehavior(ev) => ev.set_height(height),
             IbcEvent::OpenInitConnection(ev) => ev.set_height(height),
             IbcEvent::OpenTryConnection(ev) => ev.set_height(height),

modules/src/ics02_client/client_def.rs

@@ -618,6 +618,8 @@ impl ClientDef for AnyClient {
             }
         }
     }
+
+    // TODO: Add upgrade method here
 }
 
 #[cfg(test)]

modules/src/ics02_client/context.rs

@@ -5,7 +5,7 @@
 use crate::ics02_client::client_def::{AnyClientState, AnyConsensusState};
 use crate::ics02_client::client_type::ClientType;
 use crate::ics02_client::error::Error;
-use crate::ics02_client::handler::ClientResult::{self, Create, Update};
+use crate::ics02_client::handler::ClientResult::{self, Create, Update, Upgrade};
 use crate::ics24_host::identifier::ClientId;
 use crate::Height;
 
@@ -46,6 +46,9 @@ pub trait ClientKeeper {
                 )?;
                 Ok(())
             }
+            Upgrade(_) => {
+                unimplemented!()
+            }
         }
     }
 

modules/src/ics02_client/error.rs

@@ -21,6 +21,9 @@ pub enum Kind {
     #[error("client not found: {0}")]
     ClientNotFound(ClientId),
 
+    #[error("client is frozen: {0}")]
+    ClientFrozen(ClientId),
+
     #[error("consensus state not found at: {0} at height {1}")]
     ConsensusStateNotFound(ClientId, Height),
 

modules/src/ics02_client/events.rs

@@ -12,6 +12,7 @@ use std::convert::{TryFrom, TryInto};
 /// The content of the `type` field for the event that a chain produces upon executing the create client transaction.
 const CREATE_EVENT_TYPE: &str = "create_client";
 const UPDATE_EVENT_TYPE: &str = "update_client";
+const UPGRADE_EVENT_TYPE: &str = "upgrade_client";
 
 /// The content of the `key` field for the attribute containing the client identifier.
 const CLIENT_ID_ATTRIBUTE_KEY: &str = "client_id";
@@ -30,6 +31,9 @@ pub fn try_from_tx(event: &tendermint::abci::Event) -> Option<IbcEvent> {
         UPDATE_EVENT_TYPE => Some(IbcEvent::UpdateClient(UpdateClient(
             extract_attributes_from_tx(event),
         ))),
+        UPGRADE_EVENT_TYPE => Some(IbcEvent::UpgradeClient(UpgradeClient(
+            extract_attributes_from_tx(event),
+        ))),
         _ => None,
     }
 }
@@ -214,3 +218,19 @@ impl From<ClientMisbehavior> for IbcEvent {
         IbcEvent::ClientMisbehavior(v)
     }
 }
+
+/// Signals a recent upgrade of an on-chain client (IBC Client).
+#[derive(Debug, Deserialize, Serialize, Clone)]
+pub struct UpgradeClient(Attributes);
+
+impl UpgradeClient {
+    pub fn set_height(&mut self, height: Height) {
+        self.0.height = height;
+    }
+}
+
+impl From<Attributes> for UpgradeClient {
+    fn from(attrs: Attributes) -> Self {
+        UpgradeClient(attrs)
+    }
+}

modules/src/ics02_client/handler.rs

@@ -7,11 +7,13 @@ use crate::ics02_client::msgs::ClientMsg;
 
 pub mod create_client;
 pub mod update_client;
+pub mod upgrade_client;
 
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub enum ClientResult {
     Create(create_client::Result),
     Update(update_client::Result),
+    Upgrade(upgrade_client::Result),
 }
 
 /// General entry point for processing any message related to ICS2 (client functions) protocols.
@@ -22,5 +24,6 @@ where
     match msg {
         ClientMsg::CreateClient(msg) => create_client::process(ctx, msg),
         ClientMsg::UpdateClient(msg) => update_client::process(ctx, msg),
+        ClientMsg::UpgradeClient(msg) => upgrade_client::process(ctx, msg),
     }
 }

modules/src/ics02_client/handler/update_client.rs

@@ -78,7 +78,7 @@ mod tests {
     use crate::ics02_client::client_def::AnyClientState;
     use crate::ics02_client::error::Kind;
     use crate::ics02_client::handler::dispatch;
-    use crate::ics02_client::handler::ClientResult::{Create, Update};
+    use crate::ics02_client::handler::ClientResult::Update;
     use crate::ics02_client::header::Header;
     use crate::ics02_client::msgs::update_client::MsgUpdateAnyClient;
     use crate::ics02_client::msgs::ClientMsg;
@@ -126,7 +126,7 @@ mod tests {
                             )))
                         )
                     }
-                    Create(_) => panic!("update handler result has type CreateResult"),
+                    _ => panic!("update handler result has incorrect type"),
                 }
             }
             Err(err) => {

modules/src/ics02_client/handler/upgrade_client.rs

@@ -0,0 +1,52 @@
+//! Protocol logic specific to processing ICS2 messages of type `MsgUpgradeAnyClient`.
+//!
+use crate::handler::HandlerResult;
+use crate::ics02_client::client_def::{AnyClientState, AnyConsensusState};
+use crate::ics02_client::context::ClientReader;
+use crate::ics02_client::error::{Error, Kind};
+use crate::ics02_client::handler::ClientResult;
+use crate::ics02_client::msgs::upgrade_client::MsgUpgradeAnyClient;
+use crate::ics02_client::state::ClientState;
+use crate::ics24_host::identifier::ClientId;
+
+/// The result following the successful processing of a `MsgUpgradeAnyClient` message.
+/// This data type should be used with a qualified name `upgrade_client::Result` to avoid ambiguity.
+#[derive(Clone, Debug, PartialEq, Eq)]
+pub struct Result {
+    pub client_id: ClientId,
+    pub client_state: AnyClientState,
+    pub consensus_state: AnyConsensusState,
+}
+
+pub fn process(
+    ctx: &dyn ClientReader,
+    msg: MsgUpgradeAnyClient,
+) -> HandlerResult<ClientResult, Error> {
+    let MsgUpgradeAnyClient { client_id, .. } = msg;
+
+    // Read client state from the host chain store.
+    let client_state = ctx
+        .client_state(&client_id)
+        .ok_or_else(|| Kind::ClientNotFound(client_id.clone()))?;
+
+    if client_state.is_frozen() {
+        return Err(Kind::ClientFrozen(client_id).into());
+    }
+
+    // Not implemented yet: https://github.com/informalsystems/ibc-rs/issues/722
+    todo!()
+
+    // let result = ClientResult::Upgrade(Result {
+    //     client_id: client_id.clone(),
+    //     client_state: new_client_state,
+    //     consensus_state: new_consensus_state,
+    // });
+    //
+    // let event_attributes = Attributes {
+    //     client_id,
+    //     ..Default::default()
+    // };
+    // output.emit(IbcEvent::UpgradeClient(event_attributes.into()));
+    //
+    // Ok(output.with_result(result))
+}

modules/src/ics02_client/msgs.rs

@@ -6,13 +6,16 @@
 
 use crate::ics02_client::msgs::create_client::MsgCreateAnyClient;
 use crate::ics02_client::msgs::update_client::MsgUpdateAnyClient;
+use crate::ics02_client::msgs::upgrade_client::MsgUpgradeAnyClient;
 
 pub mod create_client;
 pub mod update_client;
+pub mod upgrade_client;
 
 #[allow(clippy::large_enum_variant)]
 #[derive(Clone, Debug)]
 pub enum ClientMsg {
     CreateClient(MsgCreateAnyClient),
     UpdateClient(MsgUpdateAnyClient),
+    UpgradeClient(MsgUpgradeAnyClient),
 }