From e9079839072ddc3a80628de2f1ab9e90b7d8e0a7 Mon Sep 17 00:00:00 2001
From: Richard Watts <richard@zilliqa.com>
Date: Tue, 19 Nov 2024 16:05:37 +0000
Subject: [PATCH] (fix) Ignore failed transactions. (feat) An `end_block`
 option to limit history replay for special situations

---
 bridge-validators/config.toml        |  8 ++++++++
 bridge-validators/src/block.rs       | 28 ++++++++++++++++++++++++++--
 bridge-validators/src/bridge_node.rs | 11 ++++++++---
 bridge-validators/src/client.rs      |  2 ++
 bridge-validators/src/main.rs        |  1 +
 5 files changed, 45 insertions(+), 5 deletions(-)

diff --git a/bridge-validators/config.toml b/bridge-validators/config.toml
index 81994ca..8b33448 100644
--- a/bridge-validators/config.toml
+++ b/bridge-validators/config.toml
@@ -7,6 +7,13 @@
 [[chain_configs]]
 ## The block at which history replay should start.
 chain_gateway_block_deployed = 36696045
+
+## When replaying history, we replay dispatches first, then relays. In order to do this
+## on old blocks in a reasonable time, we should not only start just before the message to be
+## replayed, but stop just after. This allows us to stop at a particular block when catching
+## up
+## to_block_number = 4000000
+
 ## RPC URL to talk to for this chain.
 rpc_url = "https://bsc-prebsc-dataseed.bnbchain.org"
 ## The (EVM) address of the chain gateway contract
@@ -36,6 +43,7 @@ legacy_gas_estimation_percent = 130
 ## use_get_transactions = true
 
 
+
 # BSC Mainnet
 # [[chain_configs]]
 # chain_gateway_block_deployed = 0
diff --git a/bridge-validators/src/block.rs b/bridge-validators/src/block.rs
index daf95a3..c98f710 100644
--- a/bridge-validators/src/block.rs
+++ b/bridge-validators/src/block.rs
@@ -11,7 +11,7 @@ use ethers::{
 use ethers_contract::{parse_log, EthEvent};
 use futures::{Stream, StreamExt, TryStreamExt};
 use tokio::time::interval;
-use tracing::{debug, info, warn};
+use tracing::{info, warn};
 
 use crate::client::{ChainClient, LogStrategy};
 
@@ -50,7 +50,7 @@ impl ChainClient {
                 // go through all the transactions
                 for txn_hash in block.transactions {
                     // We have a transaction. Did it have any logs?
-                    debug!("block {} txn {:#x}", block_number, txn_hash);
+                    info!("block {} txn {:#x}", block_number, txn_hash);
                     // Get the receipt
                     let maybe_receipt = self
                         .client
@@ -59,6 +59,16 @@ impl ChainClient {
                         .await?;
                     if let Some(receipt) = maybe_receipt {
                         // Yay!
+                        if let Some(v) = &receipt.status {
+                            info!("[1] txn {:#x} has status {v}", txn_hash);
+                            if *v != U64::from(1) {
+                                info!("[1] txn failed - skipping");
+                                continue;
+                            }
+                        } else {
+                            info!("[1] txn {:#x} has no status - ignoring", txn_hash);
+                            continue;
+                        }
                         info!("Got receipt for txn {:#x}", txn_hash);
                         for log in receipt.logs {
                             // Because FML, the filter doesn't actually include the address.
@@ -101,6 +111,7 @@ impl ChainClient {
                                 // If there's no filter element for this topic, we're fine.
                             }
                             if matches {
+                                info!("Event matches; pushing for transit");
                                 result.push(log);
                             }
                         }
@@ -153,6 +164,19 @@ impl BlockPolling for ChainClient {
                     .request("eth_getLogs", [event])
                     .await?;
                 logs.into_iter()
+                    // Zilliqa 1 will generate logs for failed txns.
+                    .filter(|log| {
+                        log.get("status")
+                            .and_then(|v| v.as_i64())
+                            .map_or(false, |s| {
+                                if s != 1 {
+                                    info!("txn failed: status = {s:#x}");
+                                    false
+                                } else {
+                                    true
+                                }
+                            })
+                    })
                     .filter(|log| {
                         log.get("address")
                             .and_then(|val| val.as_str())
diff --git a/bridge-validators/src/bridge_node.rs b/bridge-validators/src/bridge_node.rs
index 24233d7..287067a 100644
--- a/bridge-validators/src/bridge_node.rs
+++ b/bridge-validators/src/bridge_node.rs
@@ -86,11 +86,16 @@ impl BridgeNode {
     }
 
     pub async fn sync_historic_events(&mut self) -> Result<()> {
-        let to_block = if self.chain_client.block_instant_finality {
-            BlockNumber::Latest
+        let to_block = if let Some(v) = self.chain_client.to_block_number {
+            BlockNumber::Number(v.into())
         } else {
-            BlockNumber::Finalized
+            if self.chain_client.block_instant_finality {
+                BlockNumber::Latest
+            } else {
+                BlockNumber::Finalized
+            }
         };
+
         info!(
             "Getting Historic Events for chainId#{}: {}",
             self.chain_client.chain_id, to_block
diff --git a/bridge-validators/src/client.rs b/bridge-validators/src/client.rs
index 65009b5..8af79d2 100644
--- a/bridge-validators/src/client.rs
+++ b/bridge-validators/src/client.rs
@@ -35,6 +35,7 @@ pub struct ChainClient {
     pub legacy_gas_estimation_percent: Option<u64>,
     pub scan_behind_blocks: u64,
     pub log_strategy: LogStrategy,
+    pub to_block_number: Option<u64>,
 }
 
 impl fmt::Display for ChainClient {
@@ -80,6 +81,7 @@ impl ChainClient {
             legacy_gas_estimation_percent: config.legacy_gas_estimation_percent,
             scan_behind_blocks: config.scan_behind_blocks.unwrap_or_default(),
             log_strategy: strategy,
+            to_block_number: config.to_block_number,
         })
     }
 }
diff --git a/bridge-validators/src/main.rs b/bridge-validators/src/main.rs
index de381c8..00dfc7b 100644
--- a/bridge-validators/src/main.rs
+++ b/bridge-validators/src/main.rs
@@ -34,6 +34,7 @@ pub struct ChainConfig {
     pub legacy_gas_estimation_percent: Option<u64>,
     pub scan_behind_blocks: Option<u64>,
     pub use_get_transactions: Option<bool>,
+    pub to_block_number: Option<u64>,
 }
 
 #[derive(Debug, Clone, Deserialize)]