forked from informalsystems/hermes
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Introduce 'create connection' cmd (informalsystems#688)
* Partial implementation of 'create connection' cmd * More slick approach for exiting the program. * Picking up work on this * Split create connection into the two basic sub-cases * Refactored create_reusing_clients * Fixed handshake with delay period option. * Typos, finishd impl for create_reusing_clients * Aligned with ADR 006 * Changelog * Refactored cli_utils. Improved error output. * More decent doc for Unrecoverable * fmt fix * review based on Anca's suggestions * Removed delay option. * Update relayer-cli/src/conclude.rs Co-authored-by: Romain Ruetschi <[email protected]> * rm Unrecoverable, replaced with unreachable Co-authored-by: Romain Ruetschi <[email protected]>
- Loading branch information
Showing
15 changed files
with
315 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| //! `create` subcommand | ||
| use abscissa_core::{Command, Help, Options, Runnable}; | ||
|
|
||
| use crate::commands::create::connection::CreateConnectionCommand; | ||
|
|
||
| mod channel; | ||
| mod connection; | ||
|
|
||
| /// `create` subcommands | ||
| #[derive(Command, Debug, Options, Runnable)] | ||
| pub enum CreateCmds { | ||
| /// Generic `help` | ||
| #[options(help = "Get usage information")] | ||
| Help(Help<Self>), | ||
|
|
||
| /// Subcommand for creating a `connection` | ||
| #[options(help = "Create a new connection between two chains")] | ||
| Connection(CreateConnectionCommand), | ||
| // /// Subcommand for creating a `channel` with various | ||
| // #[options(help = "create a new channel between two chains")] | ||
| // Channel(CreateChannelCommand), | ||
| } |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,165 @@ | ||
| use abscissa_core::{Command, Options, Runnable}; | ||
|
|
||
| use ibc::ics02_client::state::ClientState; | ||
| use ibc::ics24_host::identifier::{ChainId, ClientId}; | ||
| use ibc::Height; | ||
| use ibc_relayer::config::StoreConfig; | ||
| use ibc_relayer::connection::Connection; | ||
| use ibc_relayer::foreign_client::ForeignClient; | ||
|
|
||
| use crate::commands::cli_utils::{spawn_chain_runtime, ChainHandlePair, SpawnOptions}; | ||
| use crate::conclude::{exit_with_unrecoverable_error, Output}; | ||
| use crate::prelude::*; | ||
|
|
||
| #[derive(Clone, Command, Debug, Options)] | ||
| pub struct CreateConnectionCommand { | ||
| #[options( | ||
| free, | ||
| required, | ||
| help = "identifier of the side `a` chain for the new connection" | ||
| )] | ||
| chain_a_id: ChainId, | ||
|
|
||
| #[options(free, help = "identifier of the side `b` chain for the new connection")] | ||
| chain_b_id: Option<ChainId>, | ||
|
|
||
| #[options( | ||
| help = "identifier of client hosted on chain `a`; default: None (creates a new client)", | ||
| no_short | ||
| )] | ||
| client_a: Option<ClientId>, | ||
|
|
||
| #[options( | ||
| help = "identifier of client hosted on chain `b`; default: None (creates a new client)", | ||
| no_short | ||
| )] | ||
| client_b: Option<ClientId>, | ||
| // TODO: Packet delay feature is not implemented, so we disallow specifying this option. | ||
| // https://github.com/informalsystems/ibc-rs/issues/640 | ||
| // #[options( | ||
| // help = "delay period parameter for the new connection; default: `0`.", | ||
| // no_short | ||
| // )] | ||
| // delay: Option<u64>, | ||
| } | ||
|
|
||
| // cargo run --bin hermes -- create connection ibc-0 ibc-1 | ||
| // cargo run --bin hermes -- create connection ibc-0 ibc-1 | ||
| // cargo run --bin hermes -- create connection ibc-0 --client-a-id 07-tendermint-0 --client-b-id 07-tendermint-0 | ||
| impl Runnable for CreateConnectionCommand { | ||
| fn run(&self) { | ||
| match &self.chain_b_id { | ||
| Some(side_b) => self.run_using_new_clients(side_b), | ||
| None => self.run_reusing_clients(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl CreateConnectionCommand { | ||
| /// Creates a connection that uses newly created clients on each side. | ||
| fn run_using_new_clients(&self, chain_b_id: &ChainId) { | ||
| let config = app_config(); | ||
|
|
||
| let spawn_options = SpawnOptions::override_store_config(StoreConfig::memory()); | ||
|
|
||
| let chains = | ||
| ChainHandlePair::spawn_with(spawn_options, &config, &self.chain_a_id, chain_b_id) | ||
| .unwrap_or_else(exit_with_unrecoverable_error); | ||
|
|
||
| // Validate the other options. Bail if the CLI was invoked with incompatible options. | ||
| if self.client_a.is_some() { | ||
| return Output::error( | ||
| "Option `<chain-b-id>` is incompatible with `--client-a`".to_string(), | ||
| ) | ||
| .exit(); | ||
| } | ||
| if self.client_b.is_some() { | ||
| return Output::error( | ||
| "Option `<chain-b-id>` is incompatible with `--client-b`".to_string(), | ||
| ) | ||
| .exit(); | ||
| } | ||
|
|
||
| info!( | ||
| "Creating new clients hosted on chains {} and {}", | ||
| self.chain_a_id, chain_b_id | ||
| ); | ||
|
|
||
| let client_a = ForeignClient::new(chains.src.clone(), chains.dst.clone()) | ||
| .unwrap_or_else(exit_with_unrecoverable_error); | ||
| let client_b = ForeignClient::new(chains.dst.clone(), chains.src.clone()) | ||
| .unwrap_or_else(exit_with_unrecoverable_error); | ||
|
|
||
| // Finally, execute the connection handshake. | ||
| // TODO: pass the `delay` parameter here. | ||
| let c = Connection::new(client_a, client_b, 0); | ||
| } | ||
|
|
||
| /// Create a connection reusing pre-existing clients on both chains. | ||
| fn run_reusing_clients(&self) { | ||
| let config = app_config(); | ||
|
|
||
| let spawn_options = SpawnOptions::override_store_config(StoreConfig::memory()); | ||
| // Validate & spawn runtime for chain_a. | ||
| let chain_a = match spawn_chain_runtime(spawn_options.clone(), &config, &self.chain_a_id) { | ||
| Ok(handle) => handle, | ||
| Err(e) => return Output::error(format!("{}", e)).exit(), | ||
| }; | ||
|
|
||
| // Unwrap the identifier of the client on chain_a. | ||
| let client_a_id = match &self.client_a { | ||
| Some(c) => c, | ||
| None => { | ||
| return Output::error( | ||
| "Option `--client-a` is necessary when <chain-b-id> is missing".to_string(), | ||
| ) | ||
| .exit() | ||
| } | ||
| }; | ||
|
|
||
| // Query client state. Extract the target chain (chain_id which this client is verifying). | ||
| let height = Height::new(chain_a.id().version(), 0); | ||
| let chain_b_id = match chain_a.query_client_state(&client_a_id, height) { | ||
| Ok(cs) => cs.chain_id(), | ||
| Err(e) => { | ||
| return Output::error(format!( | ||
| "Failed while querying client '{}' on chain '{}' with error: {}", | ||
| client_a_id, self.chain_a_id, e | ||
| )) | ||
| .exit() | ||
| } | ||
| }; | ||
|
|
||
| // Validate & spawn runtime for chain_b. | ||
| let chain_b = match spawn_chain_runtime(spawn_options, &config, &chain_b_id) { | ||
| Ok(handle) => handle, | ||
| Err(e) => return Output::error(format!("{}", e)).exit(), | ||
| }; | ||
|
|
||
| // Unwrap the identifier of the client on chain_b. | ||
| let client_b_id = match &self.client_b { | ||
| Some(c) => c, | ||
| None => { | ||
| return Output::error( | ||
| "Option `--client-b` is necessary when <chain-b-id> is missing".to_string(), | ||
| ) | ||
| .exit() | ||
| } | ||
| }; | ||
|
|
||
| info!( | ||
| "Creating a new connection with pre-existing clients {} and {}", | ||
| client_a_id, client_b_id | ||
| ); | ||
|
|
||
| // Get the two ForeignClient objects. | ||
| let client_a = ForeignClient::find(chain_b.clone(), chain_a.clone(), &client_a_id) | ||
| .unwrap_or_else(exit_with_unrecoverable_error); | ||
| let client_b = ForeignClient::find(chain_a.clone(), chain_b.clone(), &client_b_id) | ||
| .unwrap_or_else(exit_with_unrecoverable_error); | ||
|
|
||
| // All verification passed. Create the Connection object & do the handshake. | ||
| // TODO: pass the `delay` parameter here. | ||
| let c = Connection::new(client_a, client_b, 0); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.