feat(bitcoind_rpc)!: rm cp field from EmittedMempool

Author: evanlinjin

crates/bitcoind_rpc/src/lib.rs

@@ -29,11 +29,9 @@
 //! for r in Emitter::new(&client, 709_632, None) {
 //!     let update = r.expect("todo: deal with the error properly");
 //!
-//!     if update.is_block() {
-//!         let cp = update.checkpoint();
-//!         println!("block {}:{}", cp.height(), cp.hash());
-//!     } else {
-//!         println!("mempool!");
+//!     match update.checkpoint() {
+//!         Some(cp) => println!("block {}:{}", cp.height(), cp.hash()),
+//!         None => println!("mempool!"),
 //!     }
 //! }
 //! ```
@@ -46,7 +44,7 @@
 use bdk_chain::{
     bitcoin::{Block, Transaction},
     indexed_tx_graph::Indexer,
-    local_chain::CheckPoint,
+    local_chain::{self, CheckPoint},
     Append, BlockId, ConfirmationHeightAnchor, ConfirmationTimeAnchor, TxGraph,
 };
 pub use bitcoincore_rpc;
@@ -77,13 +75,23 @@ impl EmittedUpdate {
     }
 
     /// Get the emission's checkpoint.
-    pub fn checkpoint(&self) -> CheckPoint {
+    ///
+    /// The emission will only have a checkpoint if it is the [`EmittedUpdate::Block`] variant.
+    pub fn checkpoint(&self) -> Option<CheckPoint> {
         match self {
-            EmittedUpdate::Block(e) => e.checkpoint(),
-            EmittedUpdate::Mempool(e) => e.checkpoint(),
+            EmittedUpdate::Block(e) => Some(e.checkpoint()),
+            EmittedUpdate::Mempool(_) => None,
         }
     }
 
+    /// Convenience method to get [`local_chain::Update`].
+    pub fn chain_update(&self) -> Option<local_chain::Update> {
+        Some(local_chain::Update {
+            tip: self.checkpoint()?,
+            introduce_older_blocks: false,
+        })
+    }
+
     /// Transforms the emitted update into a [`TxGraph`] update.
     ///
     /// The `tx_filter` parameter takes in a closure that filters out irrelevant transactions so
@@ -155,18 +163,11 @@ impl EmittedBlock {
 /// An emitted subset of mempool transactions.
 #[derive(Debug, Clone)]
 pub struct EmittedMempool {
-    /// The checkpoint of the last-seen tip.
-    pub cp: CheckPoint,
     /// Subset of mempool transactions.
     pub txs: Vec<(Transaction, u64)>,
 }
 
 impl EmittedMempool {
-    /// Get the emission's checkpoint.
-    pub fn checkpoint(&self) -> CheckPoint {
-        self.cp.clone()
-    }
-
     /// Transforms the emitted mempool into a [`TxGraph`] update.
     ///
     /// The `tx_filter` parameter takes in a closure that filters out irrelevant transactions so
@@ -295,15 +296,7 @@ impl<'c, C: RpcApi> Emitter<'c, C> {
                 },
             )
             .collect::<Result<Vec<_>, _>>()?;
-        let cp = match &self.last_cp {
-            Some(cp) => cp.clone(),
-            None => {
-                let hash = self.client.get_best_block_hash()?;
-                let height = self.client.get_block_info(&hash)?.height as u32;
-                CheckPoint::new(BlockId { height, hash })
-            }
-        };
-        Ok(EmittedMempool { cp, txs })
+        Ok(EmittedMempool { txs })
     }
 
     /// Emits the next block (if any).

crates/bitcoind_rpc/tests/test_emitter.rs

@@ -211,10 +211,9 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
     for r in Emitter::new(&env.client, 0, chain.tip()) {
         let update = r?;
 
-        let _ = chain.apply_update(bdk_chain::local_chain::Update {
-            tip: update.checkpoint(),
-            introduce_older_blocks: false,
-        })?;
+        if let Some(chain_update) = update.chain_update() {
+            let _ = chain.apply_update(chain_update)?;
+        }
 
         let tx_graph_update = update.into_tx_graph_update(
             bdk_bitcoind_rpc::indexer_filter(&mut indexed_tx_graph.index, &mut BTreeSet::new()),
@@ -299,10 +298,9 @@ fn test_into_tx_graph() -> anyhow::Result<()> {
         let update = Emitter::new(&env.client, 0, chain.tip()).emit_update()?;
         assert!(update.is_block());
 
-        let _ = chain.apply_update(bdk_chain::local_chain::Update {
-            tip: update.checkpoint(),
-            introduce_older_blocks: false,
-        })?;
+        if let Some(chain_update) = update.chain_update() {
+            let _ = chain.apply_update(chain_update)?;
+        }
 
         let tx_graph_update = update.into_tx_graph_update(
             bdk_bitcoind_rpc::indexer_filter(&mut indexed_tx_graph.index, &mut BTreeSet::new()),

example-crates/example_rpc/src/main.rs

@@ -192,9 +192,8 @@ fn main() -> anyhow::Result<()> {
             let mut start = Instant::now();
 
             for (item, tip_height) in recv {
-                let is_mempool = item.is_mempool();
+                let chain_update = item.chain_update();
                 let tip = item.checkpoint();
-                let current_height = tip.height();
 
                 let db_changeset = {
                     let mut indexed_changeset = indexed_tx_graph::ChangeSet::default();
@@ -211,10 +210,10 @@ fn main() -> anyhow::Result<()> {
                     };
                     indexed_changeset.append(graph.apply_update(graph_update));
 
-                    let chain_changeset = chain.apply_update(local_chain::Update {
-                        tip,
-                        introduce_older_blocks: false,
-                    })?;
+                    let chain_changeset = match chain_update {
+                        Some(update) => chain.apply_update(update)?,
+                        None => local_chain::ChangeSet::default(),
+                    };
 
                     (chain_changeset, indexed_changeset)
                 };
@@ -237,10 +236,9 @@ fn main() -> anyhow::Result<()> {
                     };
                     println!(
                         "* scanned_to: {} / {} tip | total: {} sats",
-                        if is_mempool {
-                            "mempool".to_string()
-                        } else {
-                            current_height.to_string()
+                        match tip {
+                            Some(cp) => cp.height().to_string(),
+                            None => "mempool".to_string(),
                         },
                         tip_height,
                         balance.confirmed