ICS29 Fee Middleware Support

.github/workflows/integration.yaml

@@ -171,6 +171,38 @@ jobs:
             test -p ibc-integration-test --features ica --no-fail-fast -- \
             --nocapture --test-threads=1 test_ica_filter
 
+  ics29-fee-test:
+    runs-on: ubuntu-latest
+    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 --features ics29-fee --no-fail-fast --no-run
+      - env:
+          RUST_LOG: info
+          RUST_BACKTRACE: 1
+          NO_COLOR_LOG: 1
+          CHAIN_COMMAND_PATH: simd
+        run: |
+          nix shell .#ibc-go-v4-simapp -c cargo \
+            test -p ibc-integration-test --features ics29-fee --no-fail-fast -- \
+            --nocapture --test-threads=1 fee::
+
   model-based-test:
     runs-on: ubuntu-latest
     timeout-minutes: 60

config.toml

@@ -64,6 +64,15 @@ clear_on_start = true
 # [Default: false]
 tx_confirmation = false
 
+# Auto register the counterparty payee on a destination chain to
+# the relayer's address on the source chain. This can be used
+# for simple configuration of the relayer to receive fees for
+# relaying RecvPacket on fee-enabled channels.
+# For more complex configuration, turn this off and use the CLI
+# to manually register the payee addresses.
+# [Default: false]
+auto_register_counterparty_payee = false
+
 # The REST section defines parameters for Hermes' built-in RESTful API.
 # https://hermes.informal.systems/rest.html
 [rest]

crates/modules/Cargo.toml

@@ -44,6 +44,7 @@ flex-error = { version = "0.4.4", default-features = false }
 num-traits = { version = "0.2.15", default-features = false }
 derive_more = { version = "0.99.17", default-features = false, features = ["from", "into", "display"] }
 uint = { version = "0.9", default-features = false }
+itertools = { version = "0.10.3", default-features = false, features = ["use_alloc"] }
 primitive-types = { version = "0.12.0", default-features = false, features = ["serde_no_std"] }
 dyn-clone = "1.0.8"
 

crates/modules/src/applications/ics29_fee/error.rs

@@ -0,0 +1,43 @@
+use flex_error::{define_error, TraceError};
+use prost::EncodeError;
+
+use crate::applications::transfer::error::Error as TransferError;
+use crate::core::ics04_channel::error::Error as ChannelError;
+use crate::core::ics24_host::error::ValidationError;
+use crate::prelude::*;
+use crate::signer::SignerError;
+
+define_error! {
+    #[derive(Debug, PartialEq, Eq)]
+    Error {
+        Transfer
+            [ TransferError ]
+            | _ | { "transfer error" },
+
+        Channel
+            [ ChannelError ]
+            | _ | { "channel error" },
+
+        Signer
+            [ SignerError ]
+            | _ | { "failed to parse signer" },
+
+        Ics24
+            [ ValidationError ]
+            | _ | { "ics24 error" },
+
+        EmptyFee
+            | _ | { "expect fee field to be non-empty" },
+
+        EmptyPacketId
+            | _ | { "expect packet_id field to be non-empty" },
+
+        Encode
+            [ TraceError<EncodeError> ]
+            | _ | { "protobuf encode error" },
+
+        EventAttributeNotFound
+            { key: String }
+            | e | { format_args!("IBC event attribute not found for key: {}", e.key) },
+    }
+}

crates/modules/src/applications/ics29_fee/events.rs

@@ -0,0 +1,95 @@
+use core::str::FromStr;
+use itertools::Itertools;
+use serde_derive::{Deserialize, Serialize};
+use tendermint::abci::tag::Tag;
+use tendermint::abci::Event as AbciEvent;
+
+use super::error::Error;
+use crate::applications::transfer::coin::RawCoin;
+use crate::core::ics04_channel::packet::Sequence;
+use crate::core::ics24_host::identifier::{ChannelId, PortId};
+use crate::events::IbcEventType;
+use crate::prelude::*;
+
+#[derive(Debug, Clone, Serialize, Deserialize, Eq, PartialEq)]
+pub struct IncentivizedPacket {
+    pub port_id: PortId,
+    pub channel_id: ChannelId,
+    pub sequence: Sequence,
+    pub total_recv_fee: Vec<RawCoin>,
+    pub total_ack_fee: Vec<RawCoin>,
+    pub total_timeout_fee: Vec<RawCoin>,
+}
+
+fn find_value(key: &str, entries: &[Tag]) -> Result<String, Error> {
+    entries
+        .iter()
+        .find_map(|entry| {
+            if entry.key.as_ref() == key {
+                Some(entry.value.to_string())
+            } else {
+                None
+            }
+        })
+        .ok_or_else(|| Error::event_attribute_not_found(key.to_string()))
+}
+
+fn new_tag(key: &str, value: &str) -> Tag {
+    Tag {
+        key: key.parse().unwrap(),
+        value: value.parse().unwrap(),
+    }
+}
+
+impl From<IncentivizedPacket> for AbciEvent {
+    fn from(event: IncentivizedPacket) -> AbciEvent {
+        let attributes: Vec<Tag> = vec![
+            new_tag("port_id", event.port_id.as_str()),
+            new_tag("channel_id", event.channel_id.as_ref()),
+            new_tag("packet_sequence", &event.sequence.to_string()),
+            new_tag("recv_fee", &event.total_recv_fee.iter().join(",")),
+            new_tag("ack_fee", &event.total_ack_fee.iter().join(",")),
+            new_tag("timeout_fee", &event.total_timeout_fee.iter().join(",")),
+        ];
+
+        AbciEvent {
+            type_str: IbcEventType::IncentivizedPacket.as_str().to_string(),
+            attributes,
+        }
+    }
+}
+
+impl<'a> TryFrom<&'a Vec<Tag>> for IncentivizedPacket {
+    type Error = Error;
+
+    fn try_from(entries: &'a Vec<Tag>) -> Result<Self, Error> {
+        let port_id_str = find_value("port_id", entries)?;
+        let channel_id_str = find_value("channel_id", entries)?;
+        let sequence_str = find_value("packet_sequence", entries)?;
+        let recv_fee_str = find_value("recv_fee", entries)?;
+        let ack_fee_str = find_value("ack_fee", entries)?;
+        let timeout_fee_str = find_value("timeout_fee", entries)?;
+
+        let port_id = PortId::from_str(&port_id_str).map_err(Error::ics24)?;
+
+        let channel_id = ChannelId::from_str(&channel_id_str).map_err(Error::ics24)?;
+
+        let sequence = Sequence::from_str(&sequence_str).map_err(Error::channel)?;
+
+        let total_recv_fee = RawCoin::from_string_list(&recv_fee_str).map_err(Error::transfer)?;
+
+        let total_ack_fee = RawCoin::from_string_list(&ack_fee_str).map_err(Error::transfer)?;
+
+        let total_timeout_fee =
+            RawCoin::from_string_list(&timeout_fee_str).map_err(Error::transfer)?;
+
+        Ok(IncentivizedPacket {
+            port_id,
+            channel_id,
+            sequence,
+            total_recv_fee,
+            total_ack_fee,
+            total_timeout_fee,
+        })
+    }
+}

crates/modules/src/applications/ics29_fee/mod.rs

@@ -0,0 +1,4 @@
+pub mod error;
+pub mod events;
+pub mod msgs;
+pub mod packet_fee;