diff --git a/crates/electrum/Cargo.toml b/crates/electrum/Cargo.toml index b85ef9fb22..aab609f78c 100644 --- a/crates/electrum/Cargo.toml +++ b/crates/electrum/Cargo.toml @@ -19,4 +19,4 @@ electrum-client = { version = "0.19" } [dev-dependencies] bdk_testenv = { path = "../testenv", default-features = false } electrsd = { version= "0.27.1", features = ["bitcoind_25_0", "esplora_a33e97e1", "legacy"] } -anyhow = "1" \ No newline at end of file +anyhow = "1" diff --git a/crates/electrum/src/electrum_ext.rs b/crates/electrum/src/electrum_ext.rs index 7ad2ae270f..7fd81edcc7 100644 --- a/crates/electrum/src/electrum_ext.rs +++ b/crates/electrum/src/electrum_ext.rs @@ -1,26 +1,86 @@ use bdk_chain::{ - bitcoin::{OutPoint, ScriptBuf, Txid}, - collections::{HashMap, HashSet}, + bitcoin::{OutPoint, ScriptBuf, Transaction, Txid}, + collections::{BTreeMap, HashMap, HashSet}, local_chain::CheckPoint, tx_graph::TxGraph, - Anchor, BlockId, ConfirmationHeightAnchor, ConfirmationTimeHeightAnchor, + BlockId, ConfirmationHeightAnchor, ConfirmationTimeHeightAnchor, }; +use core::{fmt::Debug, str::FromStr}; use electrum_client::{ElectrumApi, Error, HeaderNotification}; -use std::{collections::BTreeMap, fmt::Debug, str::FromStr}; +use std::sync::Arc; /// We include a chain suffix of a certain length for the purpose of robustness. const CHAIN_SUFFIX_LENGTH: u32 = 8; +/// Type that maintains a cache of [`Arc`]-wrapped transactions. +pub type TxCache = HashMap>; + /// 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 /// the same chain tip that we check before and after we gather the txids. #[derive(Debug)] -pub struct ElectrumUpdate { +pub struct ElectrumUpdate { /// Chain update pub chain_update: CheckPoint, /// Tracks electrum updates in TxGraph - pub graph_update: TxGraph, + pub graph_update: TxGraph, +} + +impl ElectrumUpdate { + /// Transform the [`ElectrumUpdate`] to have [`bdk_chain::Anchor`]s of another type. + /// + /// Refer to [`TxGraph::map_anchors`]. + pub fn map_anchors(self, f: F) -> ElectrumUpdate + where + F: FnMut(A) -> A2, + { + ElectrumUpdate { + chain_update: self.chain_update, + graph_update: self.graph_update.map_anchors(f), + } + } +} + +impl ElectrumUpdate { + /// Transforms the [`TxGraph`]'s [`bdk_chain::Anchor`] type to [`ConfirmationTimeHeightAnchor`]. + pub fn into_confirmation_time_update( + self, + client: &impl ElectrumApi, + ) -> Result, Error> { + let relevant_heights = self + .graph_update + .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 chain_update = self.chain_update; + let graph_update = + self.graph_update + .clone() + .map_anchors(|a| ConfirmationTimeHeightAnchor { + anchor_block: a.anchor_block, + confirmation_height: a.confirmation_height, + confirmation_time: height_to_time[&a.confirmation_height], + }); + + Ok(ElectrumUpdate { + chain_update, + graph_update, + }) + } } /// Trait to extend [`electrum_client::Client`] functionality. @@ -35,11 +95,11 @@ pub trait ElectrumExt { /// 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, + tx_cache: &mut TxCache, prev_tip: CheckPoint, keychain_spks: BTreeMap>, - full_txs: Option<&TxGraph>, stop_gap: usize, batch_size: usize, ) -> Result<(ElectrumUpdate, BTreeMap), Error>; @@ -61,11 +121,11 @@ 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, + tx_cache: &mut TxCache, prev_tip: CheckPoint, misc_spks: impl IntoIterator, - full_txs: Option<&TxGraph>, txids: impl IntoIterator, outpoints: impl IntoIterator, batch_size: usize, @@ -73,11 +133,11 @@ pub trait ElectrumExt { } impl ElectrumExt for E { - fn full_scan( + fn full_scan( &self, + tx_cache: &mut TxCache, prev_tip: CheckPoint, keychain_spks: BTreeMap>, - full_txs: Option<&TxGraph>, stop_gap: usize, batch_size: usize, ) -> Result<(ElectrumUpdate, BTreeMap), Error> { @@ -85,18 +145,18 @@ impl ElectrumExt for E { .into_iter() .map(|(k, s)| (k, s.into_iter())) .collect::>(); + + // We keep track of already-scanned spks just in case a reorg happens and we need to do a + // rescan. We need to keep track of this as iterators in `keychain_spks` are "unbounded" so + // cannot be collected. In addition, we keep track of whether an spk has an active tx + // history for determining the `last_active_index`. + // * key: (keychain, spk_index) that identifies the spk. + // * val: (script_pubkey, has_tx_history). let mut scanned_spks = BTreeMap::<(K, u32), (ScriptBuf, bool)>::new(); let (electrum_update, keychain_update) = loop { let (tip, _) = construct_update_tip(self, prev_tip.clone())?; - 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 mut graph_update = TxGraph::::default(); let cps = tip .iter() .take(10) @@ -108,7 +168,8 @@ impl ElectrumExt for E { scanned_spks.append(&mut populate_with_spks( self, &cps, - &mut tx_graph, + tx_cache, + &mut graph_update, &mut scanned_spks .iter() .map(|(i, (spk, _))| (i.clone(), spk.clone())), @@ -121,7 +182,8 @@ impl ElectrumExt for E { populate_with_spks( self, &cps, - &mut tx_graph, + tx_cache, + &mut graph_update, keychain_spks, stop_gap, batch_size, @@ -140,8 +202,6 @@ impl ElectrumExt for E { 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| { @@ -165,11 +225,11 @@ impl ElectrumExt for E { Ok((electrum_update, keychain_update)) } - fn sync( + fn sync( &self, + tx_cache: &mut TxCache, prev_tip: CheckPoint, misc_spks: impl IntoIterator, - full_txs: Option<&TxGraph>, txids: impl IntoIterator, outpoints: impl IntoIterator, batch_size: usize, @@ -179,10 +239,10 @@ impl ElectrumExt for E { .enumerate() .map(|(i, spk)| (i as u32, spk)); - let (mut electrum_update, _) = self.full_scan( + let (electrum_update, _) = self.full_scan( + tx_cache, prev_tip.clone(), [((), spk_iter)].into(), - full_txs, usize::MAX, batch_size, )?; @@ -195,11 +255,8 @@ impl ElectrumExt for E { .collect::>(); let mut tx_graph = TxGraph::::default(); - populate_with_txids(self, &cps, &mut tx_graph, txids)?; + populate_with_txids(self, &cps, tx_cache, &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) } @@ -383,11 +440,12 @@ fn populate_with_outpoints( fn populate_with_txids( client: &impl ElectrumApi, cps: &BTreeMap, - tx_graph: &mut TxGraph, + tx_cache: &mut TxCache, + graph_update: &mut TxGraph, txids: impl IntoIterator, ) -> Result<(), Error> { for txid in txids { - let tx = match client.transaction_get(&txid) { + let tx = match fetch_tx(client, tx_cache, txid) { Ok(tx) => tx, Err(electrum_client::Error::Protocol(_)) => continue, Err(other_err) => return Err(other_err), @@ -408,20 +466,36 @@ fn populate_with_txids( None => continue, }; - if tx_graph.get_tx(txid).is_none() { - let _ = tx_graph.insert_tx(tx); + if graph_update.get_tx(txid).is_none() { + // TODO: We need to be able to insert an `Arc` of a transaction. + let _ = graph_update.insert_tx(tx); } if let Some(anchor) = anchor { - let _ = tx_graph.insert_anchor(txid, anchor); + let _ = graph_update.insert_anchor(txid, anchor); } } Ok(()) } +fn fetch_tx( + client: &C, + tx_cache: &mut TxCache, + txid: Txid, +) -> Result, Error> { + use bdk_chain::collections::hash_map::Entry; + Ok(match tx_cache.entry(txid) { + Entry::Occupied(entry) => entry.get().clone(), + Entry::Vacant(entry) => entry + .insert(Arc::new(client.transaction_get(&txid)?)) + .clone(), + }) +} + fn populate_with_spks( client: &impl ElectrumApi, cps: &BTreeMap, - tx_graph: &mut TxGraph, + tx_cache: &mut TxCache, + graph_update: &mut TxGraph, spks: &mut impl Iterator, stop_gap: usize, batch_size: usize, @@ -453,51 +527,12 @@ fn populate_with_spks( unused_spk_count = 0; } - for tx in spk_history { - 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]); + for tx_res in spk_history { + let _ = graph_update.insert_tx(fetch_tx(client, tx_cache, tx_res.tx_hash)?); + if let Some(anchor) = determine_tx_anchor(cps, tx_res.height, tx_res.tx_hash) { + let _ = graph_update.insert_anchor(tx_res.tx_hash, anchor); } - - if let Some(anchor) = determine_tx_anchor(cps, tx.height, tx.tx_hash) { - 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/tests/test_electrum.rs b/crates/electrum/tests/test_electrum.rs index 1653f0bcdf..ecd5de3580 100644 --- a/crates/electrum/tests/test_electrum.rs +++ b/crates/electrum/tests/test_electrum.rs @@ -62,22 +62,21 @@ fn scan_detects_confirmed_tx() -> Result<()> { // Sync up to tip. env.wait_until_electrum_sees_block()?; - let ElectrumUpdate { - chain_update, - graph_update, - } = client.sync::( - recv_chain.tip(), - [spk_to_track], - Some(recv_graph.graph()), - None, - None, - 5, - )?; + let update = client + .sync( + &mut Default::default(), + recv_chain.tip(), + [spk_to_track], + None, + None, + 5, + )? + .into_confirmation_time_update(&client)?; let _ = recv_chain - .apply_update(chain_update) + .apply_update(update.chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; - let _ = recv_graph.apply_update(graph_update); + let _ = recv_graph.apply_update(update.graph_update); // Check to see if tx is confirmed. assert_eq!( @@ -133,25 +132,24 @@ fn tx_can_become_unconfirmed_after_reorg() -> Result<()> { // Sync up to tip. env.wait_until_electrum_sees_block()?; - let ElectrumUpdate { - chain_update, - graph_update, - } = client.sync::( - recv_chain.tip(), - [spk_to_track.clone()], - Some(recv_graph.graph()), - None, - None, - 5, - )?; + let update = client + .sync( + &mut Default::default(), + recv_chain.tip(), + [spk_to_track.clone()], + None, + None, + 5, + )? + .into_confirmation_time_update(&client)?; let _ = recv_chain - .apply_update(chain_update) + .apply_update(update.chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; - let _ = recv_graph.apply_update(graph_update.clone()); + let _ = recv_graph.apply_update(update.graph_update.clone()); // Retain a snapshot of all anchors before reorg process. - let initial_anchors = graph_update.all_anchors(); + let initial_anchors = update.graph_update.all_anchors(); // Check if initial balance is correct. assert_eq!( @@ -171,14 +169,16 @@ fn tx_can_become_unconfirmed_after_reorg() -> Result<()> { let ElectrumUpdate { chain_update, graph_update, - } = client.sync::( - recv_chain.tip(), - [spk_to_track.clone()], - Some(recv_graph.graph()), - None, - None, - 5, - )?; + } = client + .sync( + &mut Default::default(), + recv_chain.tip(), + [spk_to_track.clone()], + None, + None, + 5, + )? + .into_confirmation_time_update(&client)?; let _ = recv_chain .apply_update(chain_update) diff --git a/example-crates/example_electrum/src/main.rs b/example-crates/example_electrum/src/main.rs index 2439709c0f..4a47daea2e 100644 --- a/example-crates/example_electrum/src/main.rs +++ b/example-crates/example_electrum/src/main.rs @@ -13,7 +13,7 @@ use bdk_chain::{ }; use bdk_electrum::{ electrum_client::{self, Client, ElectrumApi}, - ElectrumExt, ElectrumUpdate, + ElectrumExt, ElectrumUpdate, TxCache, }; use example_cli::{ anyhow::{self, Context}, @@ -146,6 +146,7 @@ fn main() -> anyhow::Result<()> { }; let client = electrum_cmd.electrum_args().client(args.network)?; + let mut tx_cache = TxCache::new(); let response = match electrum_cmd.clone() { ElectrumCommands::Scan { @@ -181,10 +182,10 @@ fn main() -> anyhow::Result<()> { }; client - .full_scan::<_, ConfirmationHeightAnchor>( + .full_scan::<_>( + &mut tx_cache, tip, keychain_spks, - Some(graph.lock().unwrap().graph()), stop_gap, scan_options.batch_size, ) @@ -281,10 +282,10 @@ fn main() -> anyhow::Result<()> { } let electrum_update = client - .sync::( + .sync( + &mut tx_cache, chain.tip(), spks, - Some(graph.graph()), txids, outpoints, scan_options.batch_size, diff --git a/example-crates/wallet_electrum/src/main.rs b/example-crates/wallet_electrum/src/main.rs index 76034ef54a..848dbe578e 100644 --- a/example-crates/wallet_electrum/src/main.rs +++ b/example-crates/wallet_electrum/src/main.rs @@ -7,13 +7,13 @@ 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}; +use bdk_electrum::TxCache; use bdk_electrum::{ electrum_client::{self, ElectrumApi}, - ElectrumExt, ElectrumUpdate, + ElectrumExt, }; use bdk_file_store::Store; @@ -38,6 +38,7 @@ fn main() -> Result<(), anyhow::Error> { print!("Syncing..."); let client = electrum_client::Client::new("ssl://electrum.blockstream.info:60002")?; + let mut tx_cache = TxCache::new(); let prev_tip = wallet.latest_checkpoint(); let keychain_spks = wallet @@ -56,29 +57,19 @@ fn main() -> Result<(), anyhow::Error> { }) .collect(); - let ( - ElectrumUpdate { - chain_update, - mut graph_update, - }, - keychain_update, - ) = client.full_scan::<_, ConfirmationTimeHeightAnchor>( - prev_tip, - keychain_spks, - Some(wallet.as_ref()), - STOP_GAP, - BATCH_SIZE, - )?; + let (update, keychain_update) = + client.full_scan(&mut tx_cache, prev_tip, keychain_spks, STOP_GAP, BATCH_SIZE)?; + let mut update = update.into_confirmation_time_update(&client)?; println!(); let now = std::time::UNIX_EPOCH.elapsed().unwrap().as_secs(); - let _ = graph_update.update_last_seen_unconfirmed(now); + let _ = update.graph_update.update_last_seen_unconfirmed(now); let wallet_update = Update { last_active_indices: keychain_update, - graph: graph_update, - chain: Some(chain_update), + graph: update.graph_update, + chain: Some(update.chain_update), }; wallet.apply_update(wallet_update)?; wallet.commit()?;