wip2

Author: oleonardolima

crates/bitcoind_rpc/examples/filter_iter.rs

@@ -69,7 +69,8 @@ fn main() -> anyhow::Result<()> {
     println!("\ntook: {}s", start.elapsed().as_secs());
     println!("Local tip: {}", chain.tip().height());
 
-    let canonical_view = graph.canonical_view(&chain, chain.tip().block_id(), Default::default());
+    let task = graph.canonicalization_task(Default::default());
+    let canonical_view = chain.canonicalize(task, Some(chain.tip().block_id()));
 
     let unspent: Vec<_> = canonical_view
         .filter_unspent_outpoints(graph.index.outpoints().clone())

crates/bitcoind_rpc/tests/test_emitter.rs

@@ -310,8 +310,11 @@ fn get_balance(
 ) -> anyhow::Result<Balance> {
     let chain_tip = recv_chain.tip().block_id();
     let outpoints = recv_graph.index.outpoints().clone();
-    let balance = recv_graph
-        .canonical_view(recv_chain, chain_tip, CanonicalizationParams::default())
+    let task = recv_graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let balance = recv_chain
+        .canonicalize(task, Some(chain_tip))
         .balance(outpoints, |_, _| true, 0);
     Ok(balance)
 }
@@ -616,8 +619,9 @@ fn test_expect_tx_evicted() -> anyhow::Result<()> {
     let _txid_2 = core.send_raw_transaction(&tx1b)?;
 
     // Retrieve the expected unconfirmed txids and spks from the graph.
-    let exp_spk_txids = graph
-        .canonical_view(&chain, chain_tip, Default::default())
+    let task = graph.canonicalization_task(Default::default());
+    let exp_spk_txids = chain
+        .canonicalize(task, Some(chain_tip))
         .list_expected_spk_txids(&graph.index, ..)
         .collect::<Vec<_>>();
     assert_eq!(exp_spk_txids, vec![(spk, txid_1)]);
@@ -632,8 +636,11 @@ fn test_expect_tx_evicted() -> anyhow::Result<()> {
     // Update graph with evicted tx.
     let _ = graph.batch_insert_relevant_evicted_at(mempool_event.evicted);
 
-    let canonical_txids = graph
-        .canonical_view(&chain, chain_tip, CanonicalizationParams::default())
+    let task = graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let canonical_txids = chain
+        .canonicalize(task, Some(chain_tip))
         .txs()
         .map(|tx| tx.txid)
         .collect::<Vec<_>>();

crates/chain/benches/canonicalization.rs

@@ -95,31 +95,28 @@ fn setup<F: Fn(&mut KeychainTxGraph, &LocalChain)>(f: F) -> (KeychainTxGraph, Lo
 }
 
 fn run_list_canonical_txs(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp_txs: usize) {
-    let view = tx_graph.canonical_view(
-        chain,
-        chain.tip().block_id(),
-        CanonicalizationParams::default(),
-    );
+    let task = tx_graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     let txs = view.txs();
     assert_eq!(txs.count(), exp_txs);
 }
 
 fn run_filter_chain_txouts(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp_txos: usize) {
-    let view = tx_graph.canonical_view(
-        chain,
-        chain.tip().block_id(),
-        CanonicalizationParams::default(),
-    );
+    let task = tx_graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     let utxos = view.filter_outpoints(tx_graph.index.outpoints().clone());
     assert_eq!(utxos.count(), exp_txos);
 }
 
 fn run_filter_chain_unspents(tx_graph: &KeychainTxGraph, chain: &LocalChain, exp_utxos: usize) {
-    let view = tx_graph.canonical_view(
-        chain,
-        chain.tip().block_id(),
-        CanonicalizationParams::default(),
-    );
+    let task = tx_graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     let utxos = view.filter_unspent_outpoints(tx_graph.index.outpoints().clone());
     assert_eq!(utxos.count(), exp_utxos);
 }

crates/chain/benches/indexer.rs

@@ -84,8 +84,11 @@ fn do_bench(indexed_tx_graph: &KeychainTxGraph, chain: &LocalChain) {
     // Check balance
     let chain_tip = chain.tip().block_id();
     let op = graph.index.outpoints().clone();
-    let bal = graph
-        .canonical_view(chain, chain_tip, CanonicalizationParams::default())
+    let task = graph
+        .graph()
+        .canonicalization_task(CanonicalizationParams::default());
+    let bal = chain
+        .canonicalize(task, Some(chain_tip))
         .balance(op, |_, _| false, 1);
     assert_eq!(bal.total(), AMOUNT * TX_CT as u64);
 }

crates/chain/src/canonical_task.rs

@@ -49,10 +49,7 @@ pub struct CanonicalizationTask<'g, A> {
 
 impl<'g, A: Anchor> CanonicalizationTask<'g, A> {
     /// Creates a new canonicalization task.
-    pub fn new(
-        tx_graph: &'g TxGraph<A>,
-        params: CanonicalizationParams,
-    ) -> Self {
+    pub fn new(tx_graph: &'g TxGraph<A>, params: CanonicalizationParams) -> Self {
         let anchors = tx_graph.all_anchors();
         let unprocessed_assumed_txs = Box::new(
             params
@@ -100,7 +97,7 @@ impl<'g, A: Anchor> CanonicalizationTask<'g, A> {
         // Check if we have pending anchor checks
         if let Some((_, _, anchors)) = self.pending_anchor_checks.front() {
             return Some(CanonicalizationRequest {
-                anchors: anchors.clone()
+                anchors: anchors.clone(),
             });
         }
 
@@ -418,7 +415,7 @@ mod tests {
         // Create canonicalization task and canonicalize using the chain
         let params = CanonicalizationParams::default();
         let task = CanonicalizationTask::new(&tx_graph, params);
-        let canonical_view = chain.canonicalize(task).unwrap();
+        let canonical_view = chain.canonicalize(task, Some(chain_tip));
 
         // Should have one canonical transaction
         assert_eq!(canonical_view.txs().len(), 1);

crates/chain/src/canonical_view.rs

@@ -6,14 +6,14 @@
 //! ## Example
 //!
 //! ```
-//! # use bdk_chain::{CanonicalView, TxGraph, CanonicalizationParams, local_chain::LocalChain};
+//! # use bdk_chain::{TxGraph, CanonicalizationParams, CanonicalizationTask, local_chain::LocalChain};
 //! # use bdk_core::BlockId;
 //! # use bitcoin::hashes::Hash;
 //! # let tx_graph = TxGraph::<BlockId>::default();
 //! # let chain = LocalChain::from_blocks([(0, bitcoin::BlockHash::all_zeros())].into_iter().collect()).unwrap();
-//! # let chain_tip = chain.tip().block_id();
 //! let params = CanonicalizationParams::default();
-//! let view = CanonicalView::new(&tx_graph, &chain, chain_tip, params).unwrap();
+//! let task = CanonicalizationTask::new(&tx_graph, params);
+//! let view = chain.canonicalize(task, Some(chain.tip().block_id()));
 //!
 //! // Iterate over canonical transactions
 //! for tx in view.txs() {
@@ -23,20 +23,14 @@
 
 use crate::collections::HashMap;
 use alloc::sync::Arc;
-use core::{convert::Infallible, fmt, ops::RangeBounds};
+use core::{fmt, ops::RangeBounds};
 
 use alloc::vec::Vec;
 
 use bdk_core::BlockId;
 use bitcoin::{Amount, OutPoint, ScriptBuf, Transaction, Txid};
 
-use crate::{
-    canonical_iter::{CanonicalIter, CanonicalReason, ObservedIn},
-    spk_txout::SpkTxOutIndex,
-    tx_graph::TxNode,
-    Anchor, Balance, CanonicalizationParams, ChainOracle, ChainPosition,
-    FullTxOut, TxGraph,
-};
+use crate::{spk_txout::SpkTxOutIndex, Anchor, Balance, ChainPosition, FullTxOut};
 
 /// A single canonical transaction with its chain position.
 ///
@@ -141,12 +135,13 @@ impl<A: Anchor> CanonicalView<A> {
     /// # Example
     ///
     /// ```
-    /// # use bdk_chain::{CanonicalView, TxGraph, local_chain::LocalChain};
+    /// # use bdk_chain::{TxGraph, CanonicalizationTask, local_chain::LocalChain};
     /// # use bdk_core::BlockId;
     /// # use bitcoin::hashes::Hash;
     /// # let tx_graph = TxGraph::<BlockId>::default();
     /// # let chain = LocalChain::from_blocks([(0, bitcoin::BlockHash::all_zeros())].into_iter().collect()).unwrap();
-    /// # let view = CanonicalView::new(&tx_graph, &chain, chain.tip().block_id(), Default::default()).unwrap();
+    /// # let task = CanonicalizationTask::new(&tx_graph, Default::default());
+    /// # let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     /// // Iterate over all canonical transactions
     /// for tx in view.txs() {
     ///     println!("TX {}: {:?}", tx.txid, tx.pos);
@@ -174,12 +169,13 @@ impl<A: Anchor> CanonicalView<A> {
     /// # Example
     ///
     /// ```
-    /// # use bdk_chain::{CanonicalView, TxGraph, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
+    /// # use bdk_chain::{TxGraph, CanonicalizationTask, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
     /// # use bdk_core::BlockId;
     /// # use bitcoin::hashes::Hash;
     /// # let tx_graph = TxGraph::<BlockId>::default();
     /// # let chain = LocalChain::from_blocks([(0, bitcoin::BlockHash::all_zeros())].into_iter().collect()).unwrap();
-    /// # let view = CanonicalView::new(&tx_graph, &chain, chain.tip().block_id(), Default::default()).unwrap();
+    /// # let task = CanonicalizationTask::new(&tx_graph, Default::default());
+    /// # let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     /// # let indexer = KeychainTxOutIndex::<&str>::default();
     /// // Get all outputs from an indexer
     /// for (keychain, txout) in view.filter_outpoints(indexer.outpoints().clone()) {
@@ -203,12 +199,13 @@ impl<A: Anchor> CanonicalView<A> {
     /// # Example
     ///
     /// ```
-    /// # use bdk_chain::{CanonicalView, TxGraph, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
+    /// # use bdk_chain::{TxGraph, CanonicalizationTask, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
     /// # use bdk_core::BlockId;
     /// # use bitcoin::hashes::Hash;
     /// # let tx_graph = TxGraph::<BlockId>::default();
     /// # let chain = LocalChain::from_blocks([(0, bitcoin::BlockHash::all_zeros())].into_iter().collect()).unwrap();
-    /// # let view = CanonicalView::new(&tx_graph, &chain, chain.tip().block_id(), Default::default()).unwrap();
+    /// # let task = CanonicalizationTask::new(&tx_graph, Default::default());
+    /// # let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     /// # let indexer = KeychainTxOutIndex::<&str>::default();
     /// // Get unspent outputs (UTXOs) from an indexer
     /// for (keychain, utxo) in view.filter_unspent_outpoints(indexer.outpoints().clone()) {
@@ -247,12 +244,13 @@ impl<A: Anchor> CanonicalView<A> {
     /// # Example
     ///
     /// ```
-    /// # use bdk_chain::{CanonicalView, TxGraph, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
+    /// # use bdk_chain::{CanonicalizationTask, TxGraph, local_chain::LocalChain, keychain_txout::KeychainTxOutIndex};
     /// # use bdk_core::BlockId;
     /// # use bitcoin::hashes::Hash;
     /// # let tx_graph = TxGraph::<BlockId>::default();
     /// # let chain = LocalChain::from_blocks([(0, bitcoin::BlockHash::all_zeros())].into_iter().collect()).unwrap();
-    /// # let view = CanonicalView::new(&tx_graph, &chain, chain.tip().block_id(), Default::default()).unwrap();
+    /// # let task = CanonicalizationTask::new(&tx_graph, Default::default());
+    /// # let view = chain.canonicalize(task, Some(chain.tip().block_id()));
     /// # let indexer = KeychainTxOutIndex::<&str>::default();
     /// // Calculate balance with 6 confirmations, trusting all outputs
     /// let balance = view.balance(

crates/chain/src/indexed_tx_graph.rs

@@ -1,14 +1,13 @@
 //! Contains the [`IndexedTxGraph`] and associated types. Refer to the
 //! [`IndexedTxGraph`] documentation for more.
-use core::{convert::Infallible, fmt::Debug};
+use core::fmt::Debug;
 
 use alloc::{sync::Arc, vec::Vec};
 use bitcoin::{Block, OutPoint, Transaction, TxOut, Txid};
 
 use crate::{
     tx_graph::{self, TxGraph},
-    Anchor, BlockId, CanonicalView, CanonicalizationParams, ChainOracle, Indexer, Merge,
-    TxPosInBlock,
+    Anchor, BlockId, CanonicalizationParams, CanonicalizationTask, Indexer, Merge, TxPosInBlock,
 };
 
 /// A [`TxGraph<A>`] paired with an indexer `I`, enforcing that every insertion into the graph is
@@ -429,6 +428,19 @@ impl<A, I> AsRef<TxGraph<A>> for IndexedTxGraph<A, I> {
     }
 }
 
+impl<A, X> IndexedTxGraph<A, X>
+where
+    A: Anchor,
+{
+    /// TODO: (@oleonardolima).
+    pub fn canonicalization_task(
+        &'_ self,
+        params: CanonicalizationParams,
+    ) -> CanonicalizationTask<'_, A> {
+        self.graph.canonicalization_task(params)
+    }
+}
+
 /// Represents changes to an [`IndexedTxGraph`].
 #[derive(Clone, Debug, PartialEq)]
 #[cfg_attr(