Fix sequences filtering when clearing packets with CLI (#4159)

* Filter packets using excluded_sequences when calling clear packet CLI * Add changelog entry * Apply excluded sequences to acks when clearing packets with CLI
informalsystems · Aug 26, 2024 · 217f0b7 · 217f0b7
1 parent 0d3b57c
commit 217f0b7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 6 deletions.
diff --git a/...g/unreleased/bug-fixes/ibc-relayer-cli/3951-exclude-sequences-with-clear-cli.md b/...g/unreleased/bug-fixes/ibc-relayer-cli/3951-exclude-sequences-with-clear-cli.md
@@ -0,0 +1,3 @@
+- Correctly filter out sequences from the `excluded_sequences` configuration
+  when clearing packets with the `clear packet` CLI.
+  ([\#4158](https://github.com/informalsystems/hermes/issues/4158))
diff --git a/crates/relayer/src/link/cli.rs b/crates/relayer/src/link/cli.rs
@@ -110,10 +110,16 @@ impl<ChainA: ChainHandle, ChainB: ChainHandle> Link<ChainA, ChainB> {
             sequences.retain(|seq| sequence_filter.iter().any(|range| range.contains(seq)));
         }
 
+        // Retain only sequences which should not be filtered out
+        let raw_sequences: Vec<Sequence> = sequences
+            .into_iter()
+            .filter(|sequence| !self.a_to_b.exclude_src_sequences.contains(sequence))
+            .collect();
+
         info!(
             "{} unreceived packets found: {} ",
-            sequences.len(),
-            PrettySlice(&sequences)
+            raw_sequences.len(),
+            PrettySlice(&raw_sequences)
         );
 
         let query_height = match packet_data_query_height {
@@ -128,7 +134,7 @@ impl<ChainA: ChainHandle, ChainB: ChainHandle> Link<ChainA, ChainB> {
             .map_or(50, |cfg| cfg.query_packets_chunk_size());
 
         self.relay_packet_messages(
-            sequences,
+            raw_sequences,
             query_height,
             chunk_size,
             query_send_packet_events,
@@ -179,10 +185,16 @@ impl<ChainA: ChainHandle, ChainB: ChainHandle> Link<ChainA, ChainB> {
             sequences.retain(|seq| sequence_filter.iter().any(|range| range.contains(seq)));
         }
 
+        // Retain only sequences which should not be filtered out
+        let raw_sequences: Vec<Sequence> = sequences
+            .into_iter()
+            .filter(|sequence| !self.a_to_b.exclude_src_sequences.contains(sequence))
+            .collect();
+
         info!(
             "{} unreceived acknowledgements found: {} ",
-            sequences.len(),
-            sequences.iter().copied().collated().format(", "),
+            raw_sequences.len(),
+            raw_sequences.iter().copied().collated().format(", "),
         );
 
         let query_height = match packet_data_query_height {
@@ -197,7 +209,7 @@ impl<ChainA: ChainHandle, ChainB: ChainHandle> Link<ChainA, ChainB> {
             .map_or(50, |cfg| cfg.query_packets_chunk_size());
 
         self.relay_packet_messages(
-            sequences,
+            raw_sequences,
             query_height,
             chunk_size,
             query_write_ack_events,