IBC Relayer Integration Test Suite

.github/workflows/integration.yaml

@@ -0,0 +1,70 @@
+name: Rust
+on:
+  pull_request:
+    paths:
+      - .github/workflows/rust.yml
+      - Cargo.toml
+      - ci/**
+      - e2e/**
+      - proto/**
+      - modules/**
+      - relayer/**
+      - relayer-cli/**
+      - relayer-rest/**
+      - telemetry/**
+  push:
+    branches: master
+    paths:
+      - .github/workflows/rust.yml
+      - Cargo.toml
+      - ci/**
+      - e2e/**
+      - proto/**
+      - modules/**
+      - relayer/**
+      - relayer-cli/**
+      - relayer-rest/**
+      - telemetry/**
+
+env:
+  CARGO_INCREMENTAL: 0
+  CARGO_PROFILE_DEV_DEBUG: 1
+  CARGO_PROFILE_RELEASE_DEBUG: 1
+  RUST_BACKTRACE: short
+  CARGO_NET_RETRY: 10
+  RUSTUP_MAX_RETRIES: 10
+
+jobs:
+  integration-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        gaiad:
+          - gaia4
+    steps:
+      - uses: actions/checkout@v2
+      - uses: cachix/install-nix-action@v15
+        with:
+          install_url: https://nixos-nix-install-tests.cachix.org/serve/vij683ly7sl95nnhb67bdjjfabclr85m/install
+          install_options: '--tarball-url-prefix https://nixos-nix-install-tests.cachix.org/serve'
+          extra_nix_config: |
+            experimental-features = nix-command flakes
+      - uses: cachix/cachix-action@v10
+        with:
+          name: cosmos
+      - uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+      - uses: Swatinem/rust-cache@v1
+      - uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: -p ibc-integration-test --no-fail-fast --no-run
+      - env:
+          RUST_LOG: info
+          RUST_BACKTRACE: 1
+        run: |
+          nix shell github:informalsystems/cosmos.nix#${{ matrix.gaiad }} -c cargo \
+            test -p ibc-integration-test --no-fail-fast -- \
+            --nocapture --test-threads=1

.github/workflows/rust.yml

@@ -102,7 +102,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: test
-          args: --all-features --no-fail-fast -- --nocapture
+          args: --all-features --no-fail-fast --workspace --exclude ibc-integration-test -- --nocapture
 
   # test-coverage:
   #   runs-on: ubuntu-latest

Cargo.toml

@@ -9,6 +9,7 @@ members = [
     "relayer-rest",
     "telemetry",
     "proto",
+    "tools/integration-test",
 ]
 
 exclude = [
@@ -22,4 +23,3 @@ exclude = [
 # tendermint-proto        = { git = "https://github.com/informalsystems/tendermint-rs", branch = "master" }
 # tendermint-light-client = { git = "https://github.com/informalsystems/tendermint-rs", branch = "master" }
 # tendermint-testgen      = { git = "https://github.com/informalsystems/tendermint-rs", branch = "master" }
-

config.toml

@@ -58,7 +58,6 @@ filter = false
 # [Default: true]
 tx_confirmation = true
 
-
 # The REST section defines parameters for Hermes' built-in RESTful API.
 # https://hermes.informal.systems/rest.html
 [rest]

modules/Cargo.toml

@@ -21,7 +21,7 @@ default = ["flex-error/std", "flex-error/eyre_tracer"]
 
 # This feature grants access to development-time mocking libraries, such as `MockContext` or `MockHeader`.
 # Depends on the `testgen` suite for generating Tendermint light blocks.
-mocks = ["tendermint-testgen", "sha2"]
+mocks = ["tendermint-testgen"]
 
 [dependencies]
 # Proto definitions for all IBC-related interfaces, e.g., connections or channels.
@@ -38,7 +38,7 @@ prost-types = { version = "0.9", default-features = false }
 bytes = { version = "1.1.0", default-features = false }
 safe-regex = { version = "0.2.4", default-features = false }
 subtle-encoding = { version = "0.5", default-features = false }
-sha2 = { version = "0.9.8", default-features = false, optional = true }
+sha2 = { version = "0.9.8", default-features = false }
 flex-error = { version = "0.4.4", default-features = false }
 
 [dependencies.tendermint]
@@ -62,7 +62,6 @@ test-env-log = { version = "0.2.7", features = ["trace"] }
 modelator = "0.2.1"
 tendermint-rpc = { version = "=0.23.0", features = ["http-client", "websocket-client"] }
 tendermint-testgen = { version = "=0.23.0" } # Needed for generating (synthetic) light blocks.
-sha2 = { version = "0.9.8" }
 
 # pin clap to avoid miscompilations with modelator
 clap = "=3.0.0-beta.4"

modules/src/applications/ics20_fungible_token_transfer/denom.rs

@@ -0,0 +1,28 @@
+use sha2::{Digest, Sha256};
+use subtle_encoding::hex;
+
+use crate::core::ics24_host::identifier::{ChannelId, PortId};
+use crate::prelude::*;
+
+use super::error::Error;
+
+pub fn derive_ibc_denom(
+    port_id: &PortId,
+    channel_id: &ChannelId,
+    denom: &str,
+) -> Result<String, Error> {
+    let transfer_path = format!("{}/{}/{}", port_id, channel_id, denom);
+    derive_ibc_denom_with_path(&transfer_path)
+}
+
+/// Derive the transferred token denomination using
+/// <https://github.com/cosmos/ibc-go/blob/main/docs/architecture/adr-001-coin-source-tracing.md>
+pub fn derive_ibc_denom_with_path(transfer_path: &str) -> Result<String, Error> {
+    let mut hasher = Sha256::new();
+    hasher.update(transfer_path.as_bytes());
+
+    let denom_bytes = hasher.finalize();
+    let denom_hex = String::from_utf8(hex::encode_upper(denom_bytes)).map_err(Error::utf8)?;
+
+    Ok(format!("ibc/{}", denom_hex))
+}

modules/src/applications/ics20_fungible_token_transfer/error.rs

@@ -2,7 +2,9 @@ use crate::core::ics04_channel::error as channel_error;
 use crate::core::ics24_host::error::ValidationError;
 use crate::core::ics24_host::identifier::{ChannelId, PortId};
 use crate::prelude::*;
-use flex_error::define_error;
+
+use alloc::string::FromUtf8Error;
+use flex_error::{define_error, DisplayOnly};
 
 define_error! {
     #[derive(Debug, PartialEq, Eq)]
@@ -36,5 +38,9 @@ define_error! {
         InvalidPacketTimeoutTimestamp
             { timestamp: u64 }
             | _ | { "invalid packet timeout timestamp value" },
+
+        Utf8
+            [ DisplayOnly<FromUtf8Error> ]
+            | _ | { "utf8 decoding error" },
     }
 }

modules/src/applications/ics20_fungible_token_transfer/mod.rs

@@ -3,3 +3,7 @@ pub mod context;
 pub mod error;
 pub mod msgs;
 pub mod relay_application_logic;
+
+mod denom;
+
+pub use denom::*;

modules/src/clients/ics07_tendermint/client_state.rs

@@ -1,6 +1,6 @@
 use crate::prelude::*;
 
-use core::str::FromStr;
+use core::convert::{TryFrom, TryInto};
 use core::time::Duration;
 
 use serde::{Deserialize, Serialize};
@@ -196,8 +196,7 @@ impl TryFrom<RawClientState> for ClientState {
             .ok_or_else(Error::missing_trusting_period)?;
 
         Ok(Self {
-            chain_id: ChainId::from_str(raw.chain_id.as_str())
-                .map_err(Error::invalid_chain_identifier)?,
+            chain_id: ChainId::from_string(raw.chain_id.as_str()),
             trust_level: trust_level
                 .try_into()
                 .map_err(|e| Error::invalid_trust_threshold(format!("{}", e)))?,

modules/src/core/ics04_channel/packet.rs

@@ -115,16 +115,19 @@ pub struct Packet {
 }
 
 impl Packet {
-    /// Checks whether a packet from a [`SendPacket`] event is
-    /// timed-out relative to the current state of the destination
-    /// chain.
+    /// Checks whether a packet from a
+    /// [`SendPacket`](crate::core::ics04_channel::events::SendPacket)
+    /// event is timed-out relative to the current state of the
+    /// destination chain.
     ///
     /// Checks both for time-out relative to the destination chain's
     /// current timestamp `dst_chain_ts` as well as relative to
     /// the height `dst_chain_height`.
     ///
-    /// Note: a timed-out packet should result in a [`MsgTimeout`],
-    /// instead of the common-case where it results in [`MsgRecvPacket`].
+    /// Note: a timed-out packet should result in a
+    /// [`MsgTimeout`](crate::core::ics04_channel::msgs::timeout::MsgTimeout),
+    /// instead of the common-case where it results in
+    /// [`MsgRecvPacket`](crate::core::ics04_channel::msgs::recv_packet::MsgRecvPacket).
     pub fn timed_out(&self, dst_chain_ts: &Timestamp, dst_chain_height: Height) -> bool {
         (self.timeout_height != Height::zero() && self.timeout_height < dst_chain_height)
             || (self.timeout_timestamp != Timestamp::none()

modules/src/core/ics24_host/identifier.rs

@@ -1,5 +1,6 @@
 use crate::prelude::*;
 
+use core::convert::{From, Infallible};
 use core::fmt::{self, Display, Formatter};
 use core::str::FromStr;
 use serde::{Deserialize, Serialize};
@@ -41,6 +42,19 @@ impl ChainId {
         }
     }
 
+    pub fn from_string(id: &str) -> Self {
+        let version = if Self::is_epoch_format(id) {
+            Self::chain_version(id)
+        } else {
+            0
+        };
+
+        Self {
+            id: id.to_string(),
+            version,
+        }
+    }
+
     /// Get a reference to the underlying string.
     pub fn as_str(&self) -> &str {
         &self.id
@@ -89,19 +103,10 @@ impl ChainId {
 }
 
 impl FromStr for ChainId {
-    type Err = ValidationError;
+    type Err = Infallible;
 
     fn from_str(id: &str) -> Result<Self, Self::Err> {
-        let version = if Self::is_epoch_format(id) {
-            Self::chain_version(id)
-        } else {
-            0
-        };
-
-        Ok(Self {
-            id: id.to_string(),
-            version,
-        })
+        Ok(Self::from_string(id))
     }
 }
 
@@ -129,11 +134,9 @@ impl Default for ChainId {
     }
 }
 
-impl TryFrom<String> for ChainId {
-    type Error = ValidationError;
-
-    fn try_from(value: String) -> Result<Self, Self::Error> {
-        Self::from_str(value.as_str())
+impl From<String> for ChainId {
+    fn from(value: String) -> Self {
+        Self::from_string(&value)
     }
 }
 
@@ -290,6 +293,10 @@ impl PartialEq<str> for ConnectionId {
 pub struct PortId(String);
 
 impl PortId {
+    pub fn unsafe_new(id: &str) -> Self {
+        Self(id.to_string())
+    }
+
     /// Get this identifier as a borrowed `&str`
     pub fn as_str(&self) -> &str {
         &self.0
@@ -392,6 +399,15 @@ pub struct PortChannelId {
     pub port_id: PortId,
 }
 
+impl PortChannelId {
+    pub fn new(channel_id: ChannelId, port_id: PortId) -> Self {
+        Self {
+            channel_id,
+            port_id,
+        }
+    }
+}
+
 impl Display for PortChannelId {
     fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), fmt::Error> {
         write!(f, "{}/{}", self.port_id, self.channel_id)

relayer-cli/src/commands/start.rs

@@ -24,7 +24,7 @@ impl Runnable for StartCmd {
         let config = (*app_config()).clone();
         let config = Arc::new(RwLock::new(config));
 
-        let (supervisor, tx_cmd) = make_supervisor::<ProdChainHandle>(config.clone())
+        let (mut supervisor, tx_cmd) = make_supervisor::<ProdChainHandle>(config.clone())
             .unwrap_or_else(|e| {
                 Output::error(format!("Hermes failed to start, last error: {}", e)).exit();
                 unreachable!()

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

@@ -92,14 +92,14 @@ impl TxIcs20MsgTransferCmd {
         &self,
         config: &Config,
     ) -> Result<TransferOptions, Box<dyn std::error::Error>> {
-        let src_chain_config = config.find_chain(&self.src_chain_id).ok_or_else(|| {
+        config.find_chain(&self.src_chain_id).ok_or_else(|| {
             format!(
                 "missing configuration for source chain '{}'",
                 self.src_chain_id
             )
         })?;
 
-        let dest_chain_config = config.find_chain(&self.dst_chain_id).ok_or_else(|| {
+        config.find_chain(&self.dst_chain_id).ok_or_else(|| {
             format!(
                 "missing configuration for destination chain '{}'",
                 self.dst_chain_id
@@ -120,8 +120,6 @@ impl TxIcs20MsgTransferCmd {
         }
 
         let opts = TransferOptions {
-            packet_src_chain_config: src_chain_config.clone(),
-            packet_dst_chain_config: dest_chain_config.clone(),
             packet_src_port_id: self.src_port_id.clone(),
             packet_src_channel_id: self.src_channel_id.clone(),
             amount: self.amount,
@@ -212,7 +210,8 @@ impl Runnable for TxIcs20MsgTransferCmd {
 
         // Checks pass, build and send the tx
         let res: Result<Vec<IbcEvent>, Error> =
-            build_and_send_transfer_messages(chains.src, chains.dst, opts).map_err(Error::packet);
+            build_and_send_transfer_messages(&chains.src, &chains.dst, &opts)
+                .map_err(Error::packet);
 
         match res {
             Ok(ev) => Output::success(ev).exit(),