Generic client update CLI implementation (#505)

* Generic client update CLI implementation

* Wire client update CLI for HermesApp

crates/cli/cli-components/src/impls/commands/client/mod.rs

@@ -1 +1,2 @@
 pub mod create;
+pub mod update;

crates/cli/cli-components/src/impls/commands/client/update.rs

@@ -0,0 +1,168 @@
+use core::marker::PhantomData;
+
+use cgp::prelude::*;
+use hermes_logging_components::traits::has_logger::HasLogger;
+use hermes_logging_components::traits::logger::CanLog;
+use hermes_logging_components::types::level::LevelInfo;
+use hermes_relayer_components::build::traits::builders::chain_builder::CanBuildChain;
+use hermes_relayer_components::build::traits::builders::relay_builder::CanBuildRelay;
+use hermes_relayer_components::chain::traits::queries::chain_status::CanQueryChainHeight;
+use hermes_relayer_components::chain::traits::queries::client_state::CanQueryClientStateWithLatestHeight;
+use hermes_relayer_components::chain::traits::types::chain_id::HasChainIdType;
+use hermes_relayer_components::chain::traits::types::client_state::{
+    HasClientStateFields, HasClientStateType,
+};
+use hermes_relayer_components::chain::traits::types::height::HasHeightType;
+use hermes_relayer_components::chain::traits::types::ibc::HasClientIdType;
+use hermes_relayer_components::multi::types::index::Index;
+use hermes_relayer_components::relay::traits::chains::{HasRelayChains, HasRelayClientIds};
+use hermes_relayer_components::relay::traits::target::{HasSourceTargetChainTypes, SourceTarget};
+use hermes_relayer_components::relay::traits::update_client_message_builder::CanSendTargetUpdateClientMessage;
+
+use crate::traits::build::CanLoadBuilder;
+use crate::traits::command::CommandRunner;
+use crate::traits::output::CanProduceOutput;
+use crate::traits::parse::CanParseArg;
+
+#[derive(Debug, clap::Parser, HasField)]
+pub struct UpdateClientArgs {
+    #[clap(
+        long = "host-chain",
+        required = true,
+        value_name = "HOST_CHAIN_ID",
+        help_heading = "REQUIRED",
+        help = "Identifier of the chain that hosts the client"
+    )]
+    host_chain_id: String,
+
+    #[clap(
+        long = "client",
+        required = true,
+        value_name = "CLIENT_ID",
+        help_heading = "REQUIRED",
+        help = "Identifier of the client to update"
+    )]
+    client_id: String,
+
+    #[clap(
+        long = "height",
+        value_name = "HEIGHT",
+        help = "The target height of the client update. Leave unspecified for latest height."
+    )]
+    target_height: Option<String>,
+
+    // TODO: Remove once it is not necessary to specify the counterparty client ID
+    // when building the relayer
+    #[clap(
+        long = "counterparty-client",
+        required = true,
+        value_name = "COUNTERPARTY_CLIENT_ID",
+        help_heading = "REQUIRED",
+        help = "Identifier of the counterparty client to update"
+    )]
+    counterparty_client_id: String,
+}
+pub struct RunUpdateClientCommand;
+
+impl<App, Args, Builder, Chain, Counterparty, Relay> CommandRunner<App, Args>
+    for RunUpdateClientCommand
+where
+    App: CanLoadBuilder<Builder = Builder>
+        + CanProduceOutput<&'static str>
+        + HasLogger
+        + CanParseArg<Args, symbol!("host_chain_id"), Parsed = Chain::ChainId>
+        + CanParseArg<Args, symbol!("client_id"), Parsed = Chain::ClientId>
+        + CanParseArg<Args, symbol!("counterparty_client_id"), Parsed = Counterparty::ClientId>
+        + CanParseArg<Args, symbol!("target_height"), Parsed = Option<Counterparty::Height>>
+        + CanRaiseError<Builder::Error>
+        + CanRaiseError<Chain::Error>
+        + CanRaiseError<Counterparty::Error>
+        + CanRaiseError<Relay::Error>,
+    Builder: CanBuildChain<Index<0>, Chain = Chain>
+        + CanBuildChain<Index<1>, Chain = Counterparty>
+        + CanBuildRelay<Index<0>, Index<1>, Relay = Relay>,
+    Chain: HasChainIdType + CanQueryClientStateWithLatestHeight<Counterparty> + HasErrorType,
+    Counterparty: HasChainIdType
+        + HasClientStateType<Chain>
+        + HasClientIdType<Chain>
+        + HasHeightType
+        + HasClientStateFields<Chain>
+        + CanQueryChainHeight
+        + HasErrorType,
+    Relay: HasRelayChains<SrcChain = Chain, DstChain = Counterparty>
+        + HasSourceTargetChainTypes
+        + HasRelayClientIds
+        + CanSendTargetUpdateClientMessage<SourceTarget>,
+    Args: Async,
+    App::Logger: CanLog<LevelInfo>,
+{
+    async fn run_command(app: &App, args: &Args) -> Result<App::Output, App::Error> {
+        let logger = app.logger();
+        let host_chain_id = app.parse_arg(args, PhantomData::<symbol!("host_chain_id")>)?;
+        let client_id = app.parse_arg(args, PhantomData::<symbol!("client_id")>)?;
+        let counterparty_client_id =
+            app.parse_arg(args, PhantomData::<symbol!("counterparty_client_id")>)?;
+        let target_height = app.parse_arg(args, PhantomData::<symbol!("target_height")>)?;
+        let builder = app.load_builder().await?;
+
+        let host_chain = builder
+            .build_chain(PhantomData::<Index<0>>, &host_chain_id)
+            .await
+            .map_err(App::raise_error)?;
+
+        let client_state = host_chain
+            .query_client_state_with_latest_height(PhantomData, &client_id)
+            .await
+            .map_err(App::raise_error)?;
+
+        let reference_chain_id = Counterparty::client_state_chain_id(&client_state);
+        let reference_chain = builder
+            .build_chain(PhantomData::<Index<1>>, &reference_chain_id)
+            .await
+            .map_err(App::raise_error)?;
+
+        let relayer = builder
+            .build_relay(
+                PhantomData::<(Index<0>, Index<1>)>,
+                &host_chain_id,
+                &reference_chain_id,
+                &client_id,
+                &counterparty_client_id,
+            )
+            .await
+            .map_err(App::raise_error)?;
+
+        let target_height = match target_height {
+            Some(height) => {
+                logger
+                    .log(
+                        &format!("Updating client using specified target height: {height}"),
+                        &LevelInfo,
+                    )
+                    .await;
+                height
+            }
+            None => {
+                let height = reference_chain
+                    .query_chain_height()
+                    .await
+                    .map_err(App::raise_error)?;
+
+                logger
+                    .log(
+                        &format!("Updating client using specified target height: {height}"),
+                        &LevelInfo,
+                    )
+                    .await;
+                height
+            }
+        };
+
+        relayer
+            .send_target_update_client_messages(SourceTarget, &target_height)
+            .await
+            .map_err(App::raise_error)?;
+
+        Ok(app.produce_output("Client successfully updated!"))
+    }
+}

crates/cli/cli/src/contexts/app.rs

@@ -11,6 +11,9 @@ use hermes_cli_components::impls::commands::bootstrap::chain::RunBootstrapChainC
 use hermes_cli_components::impls::commands::client::create::{
     CreateClientOptionsParser, RunCreateClientCommand,
 };
+use hermes_cli_components::impls::commands::client::update::{
+    RunUpdateClientCommand, UpdateClientArgs,
+};
 use hermes_cli_components::impls::commands::queries::client::{
     QueryClientSubCommand, RunQueryClientSubCommand,
 };
@@ -156,6 +159,11 @@ delegate_components! {
 
         (CreateClientArgs, symbol!("target_chain_id")): ParseFromString<ChainId>,
         (CreateClientArgs, symbol!("counterparty_chain_id")): ParseFromString<ChainId>,
+
+        (UpdateClientArgs, symbol!("host_chain_id")): ParseFromString<ChainId>,
+        (UpdateClientArgs, symbol!("client_id")): ParseFromString<ClientId>,
+        (UpdateClientArgs, symbol!("counterparty_client_id")): ParseFromString<ClientId>,
+        (UpdateClientArgs, symbol!("target_height")): ParseFromOptionalString<Height>,
     }
 }
 
@@ -169,6 +177,7 @@ delegate_components! {
         QueryConsensusStateArgs: RunQueryConsensusStateCommand,
 
         CreateClientArgs: RunCreateClientCommand,
+        UpdateClientArgs: RunUpdateClientCommand,
 
         BootstrapSubCommand: RunBootstrapSubCommand,
         BootstrapChainArgs: RunBootstrapChainCommand<UseContext>,
@@ -236,6 +245,7 @@ pub trait CanUseHermesApp:
     + CanRunCommand<QueryConsensusStateArgs>
     + CanRunCommand<QueryClientStatusArgs>
     + CanRunCommand<CreateClientArgs>
+    + CanRunCommand<UpdateClientArgs>
     + CanRunCommand<BootstrapChainArgs>
     + CanProduceOutput<&'static str>
     + CanProduceOutput<ClientId>