feat: Enable batching multiple TXs with a single client update (#635)

* Enable batching multiple TXs with a single client update

* Use HashMap for CLI transfer arguments

* Move BatchConfig to be per-chain configuration

* Improve BatchConfig handling

* Increase COSMOS_TRUSTING_PERIOD from 30 to 70 in tests to avoid client expiring due to batching

* Remove unnecessary CLI transfer component and fix recover client test

* Add early return when trying to relay empty vector of packets in batch implementations

* Fix and improve event batching and configuration

* Fix cargo doc and run taplo

* Group packet information together in batching methods

* Use slice instead of Vec for batching methods

* Warn when packet timeout has neither height nor timestamp

* Query ack commitments and proofs using the same height and improve batch transactions test

* Remove redundant height queries when batching acks

Author: ljoss17

.github/workflows/integration-tests.yaml

@@ -76,7 +76,7 @@ jobs:
         env:
           RUST_BACKTRACE: 1
           TEST_PRESET: ${{ matrix.chain.preset }}
-          COSMOS_TRUSTING_PERIOD: 30
+          COSMOS_TRUSTING_PERIOD: 70
           COSMOS_REFRESH_RATE: 20
         run: |
             nix develop -c \

Cargo.lock

@@ -50,4 +50,10 @@ where
             AnyClientState::Tendermint(cs) => cs.chain_id.clone(),
         }
     }
+
+    fn client_state_trusting_period(client_state: &AnyClientState) -> Option<Duration> {
+        match client_state {
+            AnyClientState::Tendermint(cs) => Some(cs.trusting_period),
+        }
+    }
 }

crates/any/any-counterparty/src/impls/types/client_state.rs

@@ -36,9 +36,8 @@ use hermes_cosmos_test_components::bootstrap::impls::{
     NoModifyCometConfig, NoModifyCosmosSdkConfig, NoModifyGenesisConfig, StartCosmosChain,
 };
 use hermes_cosmos_test_components::bootstrap::traits::{
-    AccountPrefixGetter, AccountPrefixGetterComponent, ChainCommandPathGetter,
-    ChainCommandPathGetterComponent, ChainDriverBuilderComponent, ChainFullNodeStarterComponent,
-    ChainStoreDirGetterComponent, CometConfigModifierComponent,
+    AccountPrefixGetter, AccountPrefixGetterComponent, ChainDriverBuilderComponent,
+    ChainFullNodeStarterComponent, ChainStoreDirGetterComponent, CometConfigModifierComponent,
     CosmosGenesisConfigModifierComponent, CosmosSdkConfigModifierComponent, DenomForStaking,
     DenomForTransfer, DenomPrefixGetter, DenomPrefixGetterComponent, DynamicGasGetterComponent,
     RandomIdFlagGetterComponent, UseRandomIdFlag, WalletConfigGeneratorComponent,
@@ -51,7 +50,9 @@ use hermes_prelude::*;
 use hermes_runtime::types::runtime::HermesRuntime;
 use hermes_runtime_components::traits::{RuntimeGetterComponent, RuntimeTypeProviderComponent};
 use hermes_test_components::bootstrap::traits::ChainBootstrapperComponent;
-use hermes_test_components::chain_driver::traits::ChainTypeProviderComponent;
+use hermes_test_components::chain_driver::traits::{
+    ChainCommandPathGetter, ChainCommandPathGetterComponent, ChainTypeProviderComponent,
+};
 use hermes_test_components::driver::traits::ChainDriverTypeProviderComponent;
 use hermes_tracing_logging_components::contexts::TracingLogger;
 use tokio::process::Child;

crates/celestia/celestia-integration-tests/src/contexts/bootstrap.rs

@@ -35,6 +35,8 @@ pub trait HasClientStateFields<Counterparty>:
     fn client_state_has_expired(client_state: &Self::ClientState, elapsed: Duration) -> bool;
 
     fn client_state_chain_id(client_state: &Self::ClientState) -> Self::ChainId;
+
+    fn client_state_trusting_period(client_state: &Self::ClientState) -> Option<Duration>;
 }
 
 #[cgp_provider(ClientStateFieldsComponent)]
@@ -60,4 +62,8 @@ where
     fn client_state_chain_id(client_state: &Chain::ClientState) -> Chain::ChainId {
         Delegate::client_state_chain_id(client_state)
     }
+
+    fn client_state_trusting_period(client_state: &Chain::ClientState) -> Option<Duration> {
+        Delegate::client_state_trusting_period(client_state)
+    }
 }

crates/chain/chain-components/src/traits/types/client_state.rs

@@ -7,7 +7,7 @@ pub trait HasAckPacketPayloadType<Counterparty>: Async {
 
 #[cgp_type]
 pub trait HasAcknowledgementType<Counterparty>: Async {
-    type Acknowledgement: Async;
+    type Acknowledgement: Async + Clone;
 }
 
 #[cgp_type]

crates/chain/chain-components/src/traits/types/packets/ack.rs

@@ -12,3 +12,5 @@ description  = "Implementation of an IBC Relayer in Rust, as a library"
 [dependencies]
 cgp            = { workspace = true }
 hermes-prelude = { workspace = true }
+
+serde = { workspace = true, features = [ "derive" ] }

crates/chain/chain-type-components/Cargo.toml

@@ -1,6 +1,8 @@
 use core::time::Duration;
 
-#[derive(Debug, Clone)]
+use serde::{Deserialize, Serialize};
+
+#[derive(Debug, Clone, Serialize, Deserialize)]
 pub struct BatchConfig {
     pub max_message_count: usize,
     pub max_tx_size: usize,
@@ -12,11 +14,11 @@ pub struct BatchConfig {
 impl Default for BatchConfig {
     fn default() -> Self {
         Self {
-            max_message_count: 10,
-            max_tx_size: 1000,
-            buffer_size: 1000,
-            max_delay: Duration::from_secs(1),
-            sleep_time: Duration::from_millis(50),
+            max_message_count: 300,
+            max_tx_size: 1000000,
+            buffer_size: 1000000,
+            max_delay: Duration::from_secs(30),
+            sleep_time: Duration::from_millis(100),
         }
     }
 }

crates/relayer/relayer-components-extra/src/batch/types/config.rs renamed to crates/chain/chain-type-components/src/impls/types/batch_config.rs

@@ -1,2 +1,5 @@
+mod batch_config;
+pub use batch_config::*;
+
 mod message_response;
 pub use message_response::*;

crates/chain/chain-type-components/src/impls/types/mod.rs

@@ -46,5 +46,5 @@ pub trait HasEventType: Sized + Async {
        [`WriteAckEvent`](crate::traits::HasWriteAckEvent::WriteAckEvent),
        and _extraction_ methods to parse the variant information from the event.
     */
-    type Event: Async + Debug;
+    type Event: Async + Clone + Debug;
 }