fix(bip158)!: get_tip now errors due to wrong network

Author: ValuedMammal

crates/bitcoind_rpc/src/bip158.rs

@@ -204,8 +204,7 @@ impl<C: RpcApi> FilterIter<'_, C> {
             let height = cp.height();
             let fetched_hash = match self.blocks.get(&height) {
                 Some(hash) => *hash,
-                None if height == 0 => cp.hash(),
-                _ => self.client.get_block_hash(height as _)?,
+                None => self.client.get_block_hash(height as u64)?,
             };
             if cp.hash() == fetched_hash {
                 // ensure this block also exists in self
@@ -214,7 +213,7 @@ impl<C: RpcApi> FilterIter<'_, C> {
             }
             // remember conflicts
             self.blocks.insert(height, fetched_hash);
-            cp = cp.prev().expect("must break before genesis");
+            cp = cp.prev().ok_or(Error::ReorgDepthExceeded)?;
         }
     }
 
@@ -245,6 +244,8 @@ pub enum Error {
     NoScripts,
     /// `bitcoincore_rpc` error
     Rpc(bitcoincore_rpc::Error),
+    /// `MAX_REORG_DEPTH` exceeded
+    ReorgDepthExceeded,
 }
 
 impl From<bitcoincore_rpc::Error> for Error {
@@ -259,6 +260,7 @@ impl fmt::Display for Error {
             Self::Bip158(e) => e.fmt(f),
             Self::NoScripts => write!(f, "no script pubkeys were provided to match with"),
             Self::Rpc(e) => e.fmt(f),
+            Self::ReorgDepthExceeded => write!(f, "maximum reorg depth exceeded"),
         }
     }
 }

crates/bitcoind_rpc/tests/test_filter_iter.rs

@@ -1,8 +1,7 @@
-use bitcoin::{constants, Address, Amount, Network, ScriptBuf};
-
-use bdk_bitcoind_rpc::bip158::FilterIter;
+use bdk_bitcoind_rpc::bip158::{Error, Event, EventInner, FilterIter};
 use bdk_core::{BlockId, CheckPoint};
 use bdk_testenv::{anyhow, bitcoind, block_id, TestEnv};
+use bitcoin::{constants, Address, Amount, Network, ScriptBuf};
 use bitcoincore_rpc::RpcApi;
 
 fn testenv() -> anyhow::Result<TestEnv> {
@@ -111,7 +110,6 @@ fn get_tip_and_chain_update() -> anyhow::Result<()> {
 
 #[test]
 fn filter_iter_returns_matched_blocks() -> anyhow::Result<()> {
-    use bdk_bitcoind_rpc::bip158::{Event, EventInner};
     let env = testenv()?;
     let rpc = env.rpc_client();
     while rpc.get_block_count()? < 101 {
@@ -148,7 +146,6 @@ fn filter_iter_returns_matched_blocks() -> anyhow::Result<()> {
 
 #[test]
 fn filter_iter_error_no_scripts() -> anyhow::Result<()> {
-    use bdk_bitcoind_rpc::bip158::Error;
     let env = testenv()?;
     let _ = env.mine_blocks(2, None)?;
 
@@ -163,3 +160,24 @@ fn filter_iter_error_no_scripts() -> anyhow::Result<()> {
 
     Ok(())
 }
+
+#[test]
+fn filter_iter_error_wrong_network() -> anyhow::Result<()> {
+    let env = testenv()?;
+    let rpc = env.rpc_client();
+    let _ = env.mine_blocks(10, None)?;
+
+    // Try to initialize FilterIter with a CP on the wrong network
+    let block_id = BlockId {
+        height: 0,
+        hash: bitcoin::hashes::Hash::hash(b"wrong-hash"),
+    };
+    let cp = CheckPoint::new(block_id);
+    let mut iter = FilterIter::new_with_checkpoint(rpc, cp);
+    let err = iter
+        .get_tip()
+        .expect_err("`get_tip` should fail to find PoA");
+    assert!(matches!(err, Error::ReorgDepthExceeded));
+
+    Ok(())
+}