From d008d31b24b34fe91b85a03600d1209372499055 Mon Sep 17 00:00:00 2001 From: Wei Chen Date: Thu, 11 Apr 2024 17:57:14 -0400 Subject: [PATCH] refactor(electrum): remove `RelevantTxids` and track txs in `TxGraph` This PR removes `RelevantTxids` from the electrum crate and tracks transactions in a `TxGraph`. This removes the need to separately construct a `TxGraph` after a `full_scan` or `sync`. --- crates/electrum/src/electrum_ext.rs | 241 ++++++++------------ crates/electrum/src/lib.rs | 11 +- crates/electrum/tests/test_electrum.rs | 39 +++- example-crates/example_electrum/src/main.rs | 37 +-- example-crates/wallet_electrum/src/main.rs | 13 +- 5 files changed, 157 insertions(+), 184 deletions(-) diff --git a/crates/electrum/src/electrum_ext.rs b/crates/electrum/src/electrum_ext.rs index 5a6c5d1163..32159b50e6 100644 --- a/crates/electrum/src/electrum_ext.rs +++ b/crates/electrum/src/electrum_ext.rs @@ -1,122 +1,15 @@ use bdk_chain::{ bitcoin::{OutPoint, ScriptBuf, Transaction, Txid}, - local_chain::CheckPoint, + local_chain::{self, CheckPoint}, tx_graph::{self, TxGraph}, Anchor, BlockId, ConfirmationHeightAnchor, ConfirmationTimeHeightAnchor, }; -use electrum_client::{Client, ElectrumApi, Error, HeaderNotification}; -use std::{ - collections::{BTreeMap, BTreeSet, HashMap, HashSet}, - fmt::Debug, - str::FromStr, -}; +use electrum_client::{ElectrumApi, Error, HeaderNotification}; +use std::{collections::BTreeMap, fmt::Debug, str::FromStr}; /// We include a chain suffix of a certain length for the purpose of robustness. const CHAIN_SUFFIX_LENGTH: u32 = 8; -/// Represents updates fetched from an Electrum server, but excludes full transactions. -/// -/// To provide a complete update to [`TxGraph`], you'll need to call [`Self::missing_full_txs`] to -/// determine the full transactions missing from [`TxGraph`]. Then call [`Self::into_tx_graph`] to -/// fetch the full transactions from Electrum and finalize the update. -#[derive(Debug, Default, Clone)] -pub struct RelevantTxids(HashMap>); - -impl RelevantTxids { - /// Determine the full transactions that are missing from `graph`. - /// - /// Refer to [`RelevantTxids`] for more details. - pub fn missing_full_txs(&self, graph: &TxGraph) -> Vec { - self.0 - .keys() - .filter(move |&&txid| graph.as_ref().get_tx(txid).is_none()) - .cloned() - .collect() - } - - /// Finalizes the [`TxGraph`] update by fetching `missing` txids from the `client`. - /// - /// Refer to [`RelevantTxids`] for more details. - pub fn into_tx_graph( - self, - client: &Client, - missing: Vec, - ) -> Result, Error> { - let new_txs = client.batch_transaction_get(&missing)?; - let mut graph = TxGraph::::new(new_txs); - for (txid, anchors) in self.0 { - for anchor in anchors { - let _ = graph.insert_anchor(txid, anchor); - } - } - Ok(graph) - } - - /// Finalizes the update by fetching `missing` txids from the `client`, where the - /// resulting [`TxGraph`] has anchors of type [`ConfirmationTimeHeightAnchor`]. - /// - /// Refer to [`RelevantTxids`] for more details. - /// - /// **Note:** The confirmation time might not be precisely correct if there has been a reorg. - // Electrum's API intends that we use the merkle proof API, we should change `bdk_electrum` to - // use it. - pub fn into_confirmation_time_tx_graph( - self, - client: &Client, - missing: Vec, - ) -> Result, Error> { - let graph = self.into_tx_graph(client, missing)?; - - let relevant_heights = { - let mut visited_heights = HashSet::new(); - graph - .all_anchors() - .iter() - .map(|(a, _)| a.confirmation_height_upper_bound()) - .filter(move |&h| visited_heights.insert(h)) - .collect::>() - }; - - let height_to_time = relevant_heights - .clone() - .into_iter() - .zip( - client - .batch_block_header(relevant_heights)? - .into_iter() - .map(|bh| bh.time as u64), - ) - .collect::>(); - - let graph_changeset = { - let old_changeset = TxGraph::default().apply_update(graph); - tx_graph::ChangeSet { - txs: old_changeset.txs, - txouts: old_changeset.txouts, - last_seen: old_changeset.last_seen, - anchors: old_changeset - .anchors - .into_iter() - .map(|(height_anchor, txid)| { - let confirmation_height = height_anchor.confirmation_height; - let confirmation_time = height_to_time[&confirmation_height]; - let time_anchor = ConfirmationTimeHeightAnchor { - anchor_block: height_anchor.anchor_block, - confirmation_height, - confirmation_time, - }; - (time_anchor, txid) - }) - .collect(), - } - }; - - let mut new_graph = TxGraph::default(); - new_graph.apply_changeset(graph_changeset); - Ok(new_graph) - } -} - /// Combination of chain and transactions updates from electrum /// /// We have to update the chain and the txids at the same time since we anchor the txids to @@ -125,25 +18,27 @@ impl RelevantTxids { pub struct ElectrumUpdate { /// Chain update pub chain_update: CheckPoint, - /// Transaction updates from electrum - pub relevant_txids: RelevantTxids, + /// Tracks electrum updates in TxGraph + pub graph_update: TxGraph, } -/// Trait to extend [`Client`] functionality. +/// Trait to extend [`electrum_client::Client`] functionality. pub trait ElectrumExt { /// Full scan the keychain scripts specified with the blockchain (via an Electrum client) and /// returns updates for [`bdk_chain`] data structures. /// /// - `prev_tip`: the most recent blockchain tip present locally /// - `keychain_spks`: keychains that we want to scan transactions for + /// - `full_txs`: [`TxGraph`] that contains all previously known transactions /// /// The full scan for each keychain stops after a gap of `stop_gap` script pubkeys with no associated /// transactions. `batch_size` specifies the max number of script pubkeys to request for in a /// single batch request. - fn full_scan( + fn full_scan( &self, prev_tip: CheckPoint, keychain_spks: BTreeMap>, + full_txs: Option<&TxGraph>, stop_gap: usize, batch_size: usize, ) -> Result<(ElectrumUpdate, BTreeMap), Error>; @@ -153,7 +48,8 @@ pub trait ElectrumExt { /// /// - `prev_tip`: the most recent blockchain tip present locally /// - `misc_spks`: an iterator of scripts we want to sync transactions for - /// - `txids`: transactions for which we want updated [`Anchor`]s + /// - `full_txs`: [`TxGraph`] that contains all previously known transactions + /// - `txids`: transactions for which we want updated [`bdk_chain::Anchor`]s /// - `outpoints`: transactions associated with these outpoints (residing, spending) that we /// want to include in the update /// @@ -164,21 +60,23 @@ pub trait ElectrumExt { /// may include scripts that have been used, use [`full_scan`] with the keychain. /// /// [`full_scan`]: ElectrumExt::full_scan - fn sync( + fn sync( &self, prev_tip: CheckPoint, misc_spks: impl IntoIterator, + full_txs: Option<&TxGraph>, txids: impl IntoIterator, outpoints: impl IntoIterator, batch_size: usize, ) -> Result; } -impl ElectrumExt for A { - fn full_scan( +impl ElectrumExt for E { + fn full_scan( &self, prev_tip: CheckPoint, keychain_spks: BTreeMap>, + full_txs: Option<&TxGraph>, stop_gap: usize, batch_size: usize, ) -> Result<(ElectrumUpdate, BTreeMap), Error> { @@ -190,7 +88,14 @@ impl ElectrumExt for A { let (electrum_update, keychain_update) = loop { let (tip, _) = construct_update_tip(self, prev_tip.clone())?; - let mut relevant_txids = RelevantTxids::default(); + let mut tx_graph = TxGraph::::default(); + if let Some(txs) = full_txs { + let _ = + tx_graph.apply_update(txs.clone().map_anchors(|a| ConfirmationHeightAnchor { + anchor_block: a.anchor_block(), + confirmation_height: a.confirmation_height_upper_bound(), + })); + } let cps = tip .iter() .take(10) @@ -202,7 +107,7 @@ impl ElectrumExt for A { scanned_spks.append(&mut populate_with_spks( self, &cps, - &mut relevant_txids, + &mut tx_graph, &mut scanned_spks .iter() .map(|(i, (spk, _))| (i.clone(), spk.clone())), @@ -215,7 +120,7 @@ impl ElectrumExt for A { populate_with_spks( self, &cps, - &mut relevant_txids, + &mut tx_graph, keychain_spks, stop_gap, batch_size, @@ -234,6 +139,8 @@ impl ElectrumExt for A { let chain_update = tip; + let graph_update = into_confirmation_time_tx_graph(self, &tx_graph)?; + let keychain_update = request_spks .into_keys() .filter_map(|k| { @@ -248,7 +155,7 @@ impl ElectrumExt for A { break ( ElectrumUpdate { chain_update, - relevant_txids, + graph_update, }, keychain_update, ); @@ -257,10 +164,11 @@ impl ElectrumExt for A { Ok((electrum_update, keychain_update)) } - fn sync( + fn sync( &self, prev_tip: CheckPoint, misc_spks: impl IntoIterator, + full_txs: Option<&TxGraph>, txids: impl IntoIterator, outpoints: impl IntoIterator, batch_size: usize, @@ -273,6 +181,7 @@ impl ElectrumExt for A { let (mut electrum_update, _) = self.full_scan( prev_tip.clone(), [((), spk_iter)].into(), + full_txs, usize::MAX, batch_size, )?; @@ -284,10 +193,12 @@ impl ElectrumExt for A { .map(|cp| (cp.height(), cp)) .collect::>(); - populate_with_txids(self, &cps, &mut electrum_update.relevant_txids, txids)?; - - let _txs = - populate_with_outpoints(self, &cps, &mut electrum_update.relevant_txids, outpoints)?; + let mut tx_graph = TxGraph::::default(); + populate_with_txids(self, &cps, &mut tx_graph, txids)?; + populate_with_outpoints(self, &cps, &mut tx_graph, outpoints)?; + let _ = electrum_update + .graph_update + .apply_update(into_confirmation_time_tx_graph(self, &tx_graph)?); Ok(electrum_update) } @@ -411,10 +322,9 @@ fn determine_tx_anchor( fn populate_with_outpoints( client: &impl ElectrumApi, cps: &BTreeMap, - relevant_txids: &mut RelevantTxids, + tx_graph: &mut TxGraph, outpoints: impl IntoIterator, -) -> Result, Error> { - let mut full_txs = HashMap::new(); +) -> Result<(), Error> { for outpoint in outpoints { let txid = outpoint.txid; let tx = client.transaction_get(&txid)?; @@ -437,17 +347,19 @@ fn populate_with_outpoints( continue; } has_residing = true; - full_txs.insert(res.tx_hash, tx.clone()); + if tx_graph.get_tx(res.tx_hash).is_none() { + let _ = tx_graph.insert_tx(tx.clone()); + } } else { if has_spending { continue; } - let res_tx = match full_txs.get(&res.tx_hash) { + let res_tx = match tx_graph.get_tx(res.tx_hash) { Some(tx) => tx, None => { let res_tx = client.transaction_get(&res.tx_hash)?; - full_txs.insert(res.tx_hash, res_tx); - full_txs.get(&res.tx_hash).expect("just inserted") + let _ = tx_graph.insert_tx(res_tx); + tx_graph.get_tx(res.tx_hash).expect("just inserted") } }; has_spending = res_tx @@ -459,20 +371,18 @@ fn populate_with_outpoints( } }; - let anchor = determine_tx_anchor(cps, res.height, res.tx_hash); - let tx_entry = relevant_txids.0.entry(res.tx_hash).or_default(); - if let Some(anchor) = anchor { - tx_entry.insert(anchor); + if let Some(anchor) = determine_tx_anchor(cps, res.height, res.tx_hash) { + let _ = tx_graph.insert_anchor(res.tx_hash, anchor); } } } - Ok(full_txs) + Ok(()) } fn populate_with_txids( client: &impl ElectrumApi, cps: &BTreeMap, - relevant_txids: &mut RelevantTxids, + tx_graph: &mut TxGraph, txids: impl IntoIterator, ) -> Result<(), Error> { for txid in txids { @@ -497,9 +407,11 @@ fn populate_with_txids( None => continue, }; - let tx_entry = relevant_txids.0.entry(txid).or_default(); + if tx_graph.get_tx(txid).is_none() { + let _ = tx_graph.insert_tx(tx); + } if let Some(anchor) = anchor { - tx_entry.insert(anchor); + let _ = tx_graph.insert_anchor(txid, anchor); } } Ok(()) @@ -508,7 +420,7 @@ fn populate_with_txids( fn populate_with_spks( client: &impl ElectrumApi, cps: &BTreeMap, - relevant_txids: &mut RelevantTxids, + tx_graph: &mut TxGraph, spks: &mut impl Iterator, stop_gap: usize, batch_size: usize, @@ -541,11 +453,50 @@ fn populate_with_spks( } for tx in spk_history { - let tx_entry = relevant_txids.0.entry(tx.tx_hash).or_default(); + let mut update = TxGraph::::default(); + + if tx_graph.get_tx(tx.tx_hash).is_none() { + let full_tx = client.transaction_get(&tx.tx_hash)?; + update = TxGraph::::new([full_tx]); + } + if let Some(anchor) = determine_tx_anchor(cps, tx.height, tx.tx_hash) { - tx_entry.insert(anchor); + let _ = update.insert_anchor(tx.tx_hash, anchor); } + + let _ = tx_graph.apply_update(update); } } } } + +fn into_confirmation_time_tx_graph( + client: &impl ElectrumApi, + tx_graph: &TxGraph, +) -> Result, Error> { + let relevant_heights = tx_graph + .all_anchors() + .iter() + .map(|(a, _)| a.confirmation_height) + .collect::>(); + + let height_to_time = relevant_heights + .clone() + .into_iter() + .zip( + client + .batch_block_header(relevant_heights)? + .into_iter() + .map(|bh| bh.time as u64), + ) + .collect::>(); + + let new_graph = tx_graph + .clone() + .map_anchors(|a| ConfirmationTimeHeightAnchor { + anchor_block: a.anchor_block, + confirmation_height: a.confirmation_height, + confirmation_time: height_to_time[&a.confirmation_height], + }); + Ok(new_graph) +} diff --git a/crates/electrum/src/lib.rs b/crates/electrum/src/lib.rs index 87c0e46188..f645653e4b 100644 --- a/crates/electrum/src/lib.rs +++ b/crates/electrum/src/lib.rs @@ -7,19 +7,10 @@ //! keychain where the range of possibly used scripts is not known. In this case it is necessary to //! scan all keychain scripts until a number (the "stop gap") of unused scripts is discovered. For a //! sync or full scan the user receives relevant blockchain data and output updates for -//! [`bdk_chain`] including [`RelevantTxids`]. -//! -//! The [`RelevantTxids`] only includes `txid`s and not full transactions. The caller is responsible -//! for obtaining full transactions before applying new data to their [`bdk_chain`]. This can be -//! done with these steps: -//! -//! 1. Determine which full transactions are missing. Use [`RelevantTxids::missing_full_txs`]. -//! -//! 2. Obtaining the full transactions. To do this via electrum use [`ElectrumApi::batch_transaction_get`]. +//! [`bdk_chain`] including [`bdk_chain::TxGraph`], which includes `txid`s and full transactions. //! //! Refer to [`example_electrum`] for a complete example. //! -//! [`ElectrumApi::batch_transaction_get`]: electrum_client::ElectrumApi::batch_transaction_get //! [`example_electrum`]: https://github.com/bitcoindevkit/bdk/tree/master/example-crates/example_electrum #![warn(missing_docs)] diff --git a/crates/electrum/tests/test_electrum.rs b/crates/electrum/tests/test_electrum.rs index 8f77209fcb..1653f0bcdf 100644 --- a/crates/electrum/tests/test_electrum.rs +++ b/crates/electrum/tests/test_electrum.rs @@ -64,11 +64,16 @@ fn scan_detects_confirmed_tx() -> Result<()> { env.wait_until_electrum_sees_block()?; let ElectrumUpdate { chain_update, - relevant_txids, - } = client.sync(recv_chain.tip(), [spk_to_track], None, None, 5)?; + graph_update, + } = client.sync::( + recv_chain.tip(), + [spk_to_track], + Some(recv_graph.graph()), + None, + None, + 5, + )?; - let missing = relevant_txids.missing_full_txs(recv_graph.graph()); - let graph_update = relevant_txids.into_confirmation_time_tx_graph(&client, missing)?; let _ = recv_chain .apply_update(chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; @@ -130,11 +135,16 @@ fn tx_can_become_unconfirmed_after_reorg() -> Result<()> { env.wait_until_electrum_sees_block()?; let ElectrumUpdate { chain_update, - relevant_txids, - } = client.sync(recv_chain.tip(), [spk_to_track.clone()], None, None, 5)?; + graph_update, + } = client.sync::( + recv_chain.tip(), + [spk_to_track.clone()], + Some(recv_graph.graph()), + None, + None, + 5, + )?; - let missing = relevant_txids.missing_full_txs(recv_graph.graph()); - let graph_update = relevant_txids.into_confirmation_time_tx_graph(&client, missing)?; let _ = recv_chain .apply_update(chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; @@ -160,11 +170,16 @@ fn tx_can_become_unconfirmed_after_reorg() -> Result<()> { env.wait_until_electrum_sees_block()?; let ElectrumUpdate { chain_update, - relevant_txids, - } = client.sync(recv_chain.tip(), [spk_to_track.clone()], None, None, 5)?; + graph_update, + } = client.sync::( + recv_chain.tip(), + [spk_to_track.clone()], + Some(recv_graph.graph()), + None, + None, + 5, + )?; - let missing = relevant_txids.missing_full_txs(recv_graph.graph()); - let graph_update = relevant_txids.into_confirmation_time_tx_graph(&client, missing)?; let _ = recv_chain .apply_update(chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; diff --git a/example-crates/example_electrum/src/main.rs b/example-crates/example_electrum/src/main.rs index e3b758e745..2439709c0f 100644 --- a/example-crates/example_electrum/src/main.rs +++ b/example-crates/example_electrum/src/main.rs @@ -181,7 +181,13 @@ fn main() -> anyhow::Result<()> { }; client - .full_scan(tip, keychain_spks, stop_gap, scan_options.batch_size) + .full_scan::<_, ConfirmationHeightAnchor>( + tip, + keychain_spks, + Some(graph.lock().unwrap().graph()), + stop_gap, + scan_options.batch_size, + ) .context("scanning the blockchain")? } ElectrumCommands::Sync { @@ -274,14 +280,20 @@ fn main() -> anyhow::Result<()> { })); } - let tip = chain.tip(); + let electrum_update = client + .sync::( + chain.tip(), + spks, + Some(graph.graph()), + txids, + outpoints, + scan_options.batch_size, + ) + .context("scanning the blockchain")?; // drop lock on graph and chain drop((graph, chain)); - let electrum_update = client - .sync(tip, spks, txids, outpoints, scan_options.batch_size) - .context("scanning the blockchain")?; (electrum_update, BTreeMap::new()) } }; @@ -289,17 +301,11 @@ fn main() -> anyhow::Result<()> { let ( ElectrumUpdate { chain_update, - relevant_txids, + mut graph_update, }, keychain_update, ) = response; - let missing_txids = { - let graph = &*graph.lock().unwrap(); - relevant_txids.missing_full_txs(graph.graph()) - }; - - let mut graph_update = relevant_txids.into_tx_graph(&client, missing_txids)?; let now = std::time::UNIX_EPOCH .elapsed() .expect("must get time") @@ -320,7 +326,12 @@ fn main() -> anyhow::Result<()> { indexer, ..Default::default() }); - changeset.append(graph.apply_update(graph_update)); + changeset.append(graph.apply_update(graph_update.map_anchors(|a| { + ConfirmationHeightAnchor { + anchor_block: a.anchor_block, + confirmation_height: a.confirmation_height, + } + }))); changeset }; diff --git a/example-crates/wallet_electrum/src/main.rs b/example-crates/wallet_electrum/src/main.rs index 4af9e71dec..76034ef54a 100644 --- a/example-crates/wallet_electrum/src/main.rs +++ b/example-crates/wallet_electrum/src/main.rs @@ -7,6 +7,7 @@ use std::io::Write; use std::str::FromStr; use bdk::bitcoin::Address; +use bdk::chain::ConfirmationTimeHeightAnchor; use bdk::wallet::Update; use bdk::{bitcoin::Network, Wallet}; use bdk::{KeychainKind, SignOptions}; @@ -58,15 +59,19 @@ fn main() -> Result<(), anyhow::Error> { let ( ElectrumUpdate { chain_update, - relevant_txids, + mut graph_update, }, keychain_update, - ) = client.full_scan(prev_tip, keychain_spks, STOP_GAP, BATCH_SIZE)?; + ) = client.full_scan::<_, ConfirmationTimeHeightAnchor>( + prev_tip, + keychain_spks, + Some(wallet.as_ref()), + STOP_GAP, + BATCH_SIZE, + )?; println!(); - let missing = relevant_txids.missing_full_txs(wallet.as_ref()); - let mut graph_update = relevant_txids.into_confirmation_time_tx_graph(&client, missing)?; let now = std::time::UNIX_EPOCH.elapsed().unwrap().as_secs(); let _ = graph_update.update_last_seen_unconfirmed(now);