Spike for parallel relaying between multiple channels (informalsystem…

…s#692)

* Spike for parallel relaying between multiple channels

* Adjust event heights

* Re-use existing Link infra for relaying packets

* Formatting

* Use only source chain, channel and port to identify packets

* Force use of in-memory store

* Fix computation of UnidrectionalChannelPath for WriteAck

* Run two supervisors in parallel

* Relay in both directions with a single supervisor

* Revert "Force use of in-memory store"

This reverts commit b197537.

* Move supervisor into ibc-relayer crate

* Formatting

* Remove println statements

* Formatting

relayer-cli/Cargo.toml

@@ -45,6 +45,7 @@ hex = "0.4"
 crossbeam-channel = "0.5.0"
 subtle-encoding = "0.5"
 dirs-next = "2.0.0"
+itertools = "0.10.0"
 
 [dependencies.tendermint-proto]
 version = "=0.18.1"

relayer-cli/src/commands.rs

@@ -14,7 +14,7 @@ use crate::config::Config;
 
 use self::{
     create::CreateCmds, keys::KeysCmd, light::LightCmd, listen::ListenCmd, query::QueryCmd,
-    start::StartCmd, tx::TxCmd, version::VersionCmd,
+    start::StartCmd, start_multi::StartMultiCmd, tx::TxCmd, version::VersionCmd,
 };
 
 mod channel;
@@ -26,6 +26,7 @@ mod light;
 mod listen;
 mod query;
 mod start;
+mod start_multi;
 mod tx;
 mod version;
 
@@ -62,6 +63,10 @@ pub enum CliCmd {
     #[options(help = "Start the relayer")]
     Start(StartCmd),
 
+    /// The `start-multi` subcommand
+    #[options(help = "Start the relayer in multi-channel mode")]
+    StartMulti(StartMultiCmd),
+
     /// The `channel` subcommand
     #[options(help = "Channel functionality for managing channels")]
     Channel(ChannelCmds),

relayer-cli/src/commands/cli_utils.rs

@@ -1,13 +1,15 @@
 use abscissa_core::config;
-
 use ibc::ics24_host::identifier::ChainId;
 use ibc_relayer::chain::CosmosSdkChain;
 use ibc_relayer::{chain::handle::ChainHandle, config::StoreConfig};
 use ibc_relayer::{chain::runtime::ChainRuntime, config::ChainConfig};
 
-use crate::application::CliApp;
-use crate::error::{Error, Kind};
+use crate::{
+    application::CliApp,
+    error::{Error, Kind},
+};
 
+#[derive(Clone, Debug)]
 /// Pair of chain handles that are used by most CLIs.
 pub struct ChainHandlePair {
     /// Source chain handle

relayer-cli/src/commands/start.rs

@@ -38,7 +38,7 @@ impl Runnable for StartCmd {
                 match channel_relay(
                     chains.src,
                     chains.dst,
-                    &LinkParameters {
+                    LinkParameters {
                         src_port_id: src_port_id.clone(),
                         src_channel_id: src_channel_id.clone(),
                     },

relayer-cli/src/commands/start_multi.rs

@@ -0,0 +1,40 @@
+use abscissa_core::{config, Command, Options, Runnable};
+
+use ibc::ics24_host::identifier::ChainId;
+use ibc_relayer::supervisor::Supervisor;
+
+use crate::conclude::Output;
+use crate::prelude::*;
+use crate::{application::CliApp, commands::cli_utils::ChainHandlePair};
+
+#[derive(Clone, Command, Debug, Options)]
+pub struct StartMultiCmd {
+    #[options(free, required, help = "identifier of the source chain")]
+    src_chain_id: ChainId,
+
+    #[options(free, required, help = "identifier of the destination chain")]
+    dst_chain_id: ChainId,
+}
+
+impl Runnable for StartMultiCmd {
+    fn run(&self) {
+        let config = app_config();
+
+        match start_multi(&config, &self.src_chain_id, &self.dst_chain_id) {
+            Ok(output) => output.exit(),
+            Err(e) => Output::error(format!("{}", e)).exit(),
+        }
+    }
+}
+
+fn start_multi(
+    config: &config::Reader<CliApp>,
+    chain_a: &ChainId,
+    chain_b: &ChainId,
+) -> Result<Output, BoxError> {
+    let chains = ChainHandlePair::spawn(config, chain_a, chain_b)?;
+    let supervisor = Supervisor::spawn(chains.src, chains.dst)?;
+    supervisor.run()?;
+
+    Ok(Output::success("ok"))
+}

relayer-cli/src/commands/tx/packet.rs

@@ -44,7 +44,7 @@ impl Runnable for TxRawPacketRecvCmd {
             src_port_id: self.src_port_id.clone(),
             src_channel_id: self.src_channel_id.clone(),
         };
-        let mut link = match Link::new_from_opts(chains.src, chains.dst, &opts) {
+        let mut link = match Link::new_from_opts(chains.src, chains.dst, opts) {
             Ok(link) => link,
             Err(e) => return Output::error(format!("{}", e)).exit(),
         };
@@ -94,7 +94,7 @@ impl Runnable for TxRawPacketAckCmd {
             src_port_id: self.src_port_id.clone(),
             src_channel_id: self.src_channel_id.clone(),
         };
-        let mut link = match Link::new_from_opts(chains.src, chains.dst, &opts) {
+        let mut link = match Link::new_from_opts(chains.src, chains.dst, opts) {
             Ok(link) => link,
             Err(e) => return Output::error(format!("{}", e)).exit(),
         };

relayer/src/lib.rs

@@ -25,5 +25,6 @@ pub mod light_client;
 pub mod link;
 pub mod macros;
 pub mod relay;
+pub mod supervisor;
 pub mod transfer;
 pub mod util;