From a6fdfb2ae4caa1cdd23aa5e5ffaf02716473a98e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BF=97=E5=AE=87?= Date: Tue, 30 Apr 2024 14:50:21 +0800 Subject: [PATCH] feat(electrum)!: use new sync/full-scan structs for `ElectrumExt` `ElectrumResultExt` trait is also introduced that adds methods which can convert the `Anchor` type for the update `TxGraph`. We also make use of the new `TxCache` fields in `SyncRequest`/`FullScanRequest`. This way, we can avoid re-fetching full transactions from Electrum if not needed. Examples and tests are updated to use the new `ElectrumExt` API. --- crates/electrum/Cargo.toml | 2 +- crates/electrum/src/electrum_ext.rs | 290 +++++++++++--------- crates/electrum/tests/test_electrum.rs | 71 ++--- example-crates/example_electrum/src/main.rs | 187 ++++++------- example-crates/wallet_electrum/src/main.rs | 59 ++-- 5 files changed, 284 insertions(+), 325 deletions(-) diff --git a/crates/electrum/Cargo.toml b/crates/electrum/Cargo.toml index 2f7896f7..c3447078 100644 --- a/crates/electrum/Cargo.toml +++ b/crates/electrum/Cargo.toml @@ -12,7 +12,7 @@ readme = "README.md" # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html [dependencies] -bdk_chain = { path = "../chain", version = "0.13.0", default-features = false } +bdk_chain = { path = "../chain", version = "0.13.0" } electrum-client = { version = "0.19" } #rustls = { version = "=0.21.1", optional = true, features = ["dangerous_configuration"] } diff --git a/crates/electrum/src/electrum_ext.rs b/crates/electrum/src/electrum_ext.rs index 7ad2ae27..af596305 100644 --- a/crates/electrum/src/electrum_ext.rs +++ b/crates/electrum/src/electrum_ext.rs @@ -1,28 +1,18 @@ use bdk_chain::{ - bitcoin::{OutPoint, ScriptBuf, Txid}, - collections::{HashMap, HashSet}, + bitcoin::{OutPoint, ScriptBuf, Transaction, Txid}, + collections::{BTreeMap, HashMap, HashSet}, local_chain::CheckPoint, + spk_client::{FullScanRequest, FullScanResult, SyncRequest, SyncResult, TxCache}, tx_graph::TxGraph, - Anchor, BlockId, ConfirmationHeightAnchor, ConfirmationTimeHeightAnchor, + BlockId, ConfirmationHeightAnchor, ConfirmationTimeHeightAnchor, }; +use core::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; -/// 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 { - /// Chain update - pub chain_update: CheckPoint, - /// Tracks electrum updates in TxGraph - pub graph_update: TxGraph, -} - /// Trait to extend [`electrum_client::Client`] functionality. pub trait ElectrumExt { /// Full scan the keychain scripts specified with the blockchain (via an Electrum client) and @@ -35,14 +25,12 @@ 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, - prev_tip: CheckPoint, - keychain_spks: BTreeMap>, - full_txs: Option<&TxGraph>, + request: FullScanRequest, stop_gap: usize, batch_size: usize, - ) -> Result<(ElectrumUpdate, BTreeMap), Error>; + ) -> Result, Error>; /// Sync a set of scripts with the blockchain (via an Electrum client) for the data specified /// and returns updates for [`bdk_chain`] data structures. @@ -61,42 +49,33 @@ 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, + request: SyncRequest, batch_size: usize, - ) -> Result; + ) -> Result, Error>; } impl ElectrumExt for E { - fn full_scan( + fn full_scan( &self, - prev_tip: CheckPoint, - keychain_spks: BTreeMap>, - full_txs: Option<&TxGraph>, + mut request: FullScanRequest, stop_gap: usize, batch_size: usize, - ) -> Result<(ElectrumUpdate, BTreeMap), Error> { - let mut request_spks = keychain_spks - .into_iter() - .map(|(k, s)| (k, s.into_iter())) - .collect::>(); + ) -> Result, Error> { + let mut request_spks = request.spks_by_keychain; + + // 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 update = loop { + let (tip, _) = construct_update_tip(self, request.chain_tip.clone())?; + let mut graph_update = TxGraph::::default(); let cps = tip .iter() .take(10) @@ -108,7 +87,8 @@ impl ElectrumExt for E { scanned_spks.append(&mut populate_with_spks( self, &cps, - &mut tx_graph, + &mut request.tx_cache, + &mut graph_update, &mut scanned_spks .iter() .map(|(i, (spk, _))| (i.clone(), spk.clone())), @@ -121,7 +101,8 @@ impl ElectrumExt for E { populate_with_spks( self, &cps, - &mut tx_graph, + &mut request.tx_cache, + &mut graph_update, keychain_spks, stop_gap, batch_size, @@ -140,8 +121,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| { @@ -153,41 +132,29 @@ impl ElectrumExt for E { }) .collect::>(); - break ( - ElectrumUpdate { - chain_update, - graph_update, - }, - keychain_update, - ); + break FullScanResult { + graph_update, + chain_update, + last_active_indices: keychain_update, + }; }; - Ok((electrum_update, keychain_update)) + Ok(update) } - fn sync( + fn sync( &self, - prev_tip: CheckPoint, - misc_spks: impl IntoIterator, - full_txs: Option<&TxGraph>, - txids: impl IntoIterator, - outpoints: impl IntoIterator, + request: SyncRequest, batch_size: usize, - ) -> Result { - let spk_iter = misc_spks - .into_iter() - .enumerate() - .map(|(i, spk)| (i as u32, spk)); + ) -> Result, Error> { + let mut tx_cache = request.tx_cache.clone(); - let (mut electrum_update, _) = self.full_scan( - prev_tip.clone(), - [((), spk_iter)].into(), - full_txs, - usize::MAX, - batch_size, - )?; + let full_scan_req = FullScanRequest::from_chain_tip(request.chain_tip.clone()) + .cache_txs(request.tx_cache) + .set_spks_for_keychain((), request.spks.enumerate().map(|(i, spk)| (i as u32, spk))); + let full_scan_res = self.full_scan(full_scan_req, usize::MAX, batch_size)?; - let (tip, _) = construct_update_tip(self, prev_tip)?; + let (tip, _) = construct_update_tip(self, request.chain_tip)?; let cps = tip .iter() .take(10) @@ -195,16 +162,88 @@ impl ElectrumExt for E { .collect::>(); 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)?); + populate_with_txids(self, &cps, &mut tx_cache, &mut tx_graph, request.txids)?; + populate_with_outpoints(self, &cps, &mut tx_cache, &mut tx_graph, request.outpoints)?; - Ok(electrum_update) + Ok(SyncResult { + chain_update: full_scan_res.chain_update, + graph_update: full_scan_res.graph_update, + }) } } +/// Trait that extends [`SyncResult`] and [`FullScanResult`] functionality. +/// +/// Currently, only a single method exists that converts the update [`TxGraph`] to have an anchor +/// type of [`ConfirmationTimeHeightAnchor`]. +pub trait ElectrumResultExt { + /// New result type with a [`TxGraph`] that contains the [`ConfirmationTimeHeightAnchor`]. + type NewResult; + + /// Convert result type to have an update [`TxGraph`] that contains the [`ConfirmationTimeHeightAnchor`] . + fn try_into_confirmation_time_result( + self, + client: &impl ElectrumApi, + ) -> Result; +} + +impl ElectrumResultExt for FullScanResult { + type NewResult = FullScanResult; + + fn try_into_confirmation_time_result( + self, + client: &impl ElectrumApi, + ) -> Result { + Ok(FullScanResult:: { + graph_update: try_into_confirmation_time_result(self.graph_update, client)?, + chain_update: self.chain_update, + last_active_indices: self.last_active_indices, + }) + } +} + +impl ElectrumResultExt for SyncResult { + type NewResult = SyncResult; + + fn try_into_confirmation_time_result( + self, + client: &impl ElectrumApi, + ) -> Result { + Ok(SyncResult { + graph_update: try_into_confirmation_time_result(self.graph_update, client)?, + chain_update: self.chain_update, + }) + } +} + +fn try_into_confirmation_time_result( + graph_update: TxGraph, + client: &impl ElectrumApi, +) -> Result, Error> { + let relevant_heights = 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::>(); + + Ok(graph_update.map_anchors(|a| ConfirmationTimeHeightAnchor { + anchor_block: a.anchor_block, + confirmation_height: a.confirmation_height, + confirmation_time: height_to_time[&a.confirmation_height], + })) +} + /// Return a [`CheckPoint`] of the latest tip, that connects with `prev_tip`. fn construct_update_tip( client: &impl ElectrumApi, @@ -323,6 +362,7 @@ fn determine_tx_anchor( fn populate_with_outpoints( client: &impl ElectrumApi, cps: &BTreeMap, + tx_cache: &mut TxCache, tx_graph: &mut TxGraph, outpoints: impl IntoIterator, ) -> Result<(), Error> { @@ -358,9 +398,9 @@ fn populate_with_outpoints( let res_tx = match tx_graph.get_tx(res.tx_hash) { Some(tx) => tx, None => { - let res_tx = client.transaction_get(&res.tx_hash)?; - let _ = tx_graph.insert_tx(res_tx); - tx_graph.get_tx(res.tx_hash).expect("just inserted") + let res_tx = fetch_tx(client, tx_cache, res.tx_hash)?; + let _ = tx_graph.insert_tx(Arc::clone(&res_tx)); + res_tx } }; has_spending = res_tx @@ -383,11 +423,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 +449,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 +510,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 b48ee34c..aa4b8793 100644 --- a/crates/electrum/tests/test_electrum.rs +++ b/crates/electrum/tests/test_electrum.rs @@ -2,9 +2,10 @@ use bdk_chain::{ bitcoin::{hashes::Hash, Address, Amount, ScriptBuf, WScriptHash}, keychain::Balance, local_chain::LocalChain, + spk_client::SyncRequest, ConfirmationTimeHeightAnchor, IndexedTxGraph, SpkTxOutIndex, }; -use bdk_electrum::{ElectrumExt, ElectrumUpdate}; +use bdk_electrum::{ElectrumExt, ElectrumResultExt}; use bdk_testenv::{anyhow, anyhow::Result, bitcoincore_rpc::RpcApi, TestEnv}; fn get_balance( @@ -60,22 +61,18 @@ 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( + SyncRequest::from_chain_tip(recv_chain.tip()) + .chain_spks(core::iter::once(spk_to_track)), + 5, + )? + .try_into_confirmation_time_result(&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!( @@ -131,25 +128,20 @@ 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( + SyncRequest::from_chain_tip(recv_chain.tip()).chain_spks([spk_to_track.clone()]), + 5, + )? + .try_into_confirmation_time_result(&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!( @@ -166,27 +158,22 @@ fn tx_can_become_unconfirmed_after_reorg() -> Result<()> { env.reorg_empty_blocks(depth)?; 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( + SyncRequest::from_chain_tip(recv_chain.tip()).chain_spks([spk_to_track.clone()]), + 5, + )? + .try_into_confirmation_time_result(&client)?; let _ = recv_chain - .apply_update(chain_update) + .apply_update(update.chain_update) .map_err(|err| anyhow::anyhow!("LocalChain update error: {:?}", err))?; // Check to see if a new anchor is added during current reorg. - if !initial_anchors.is_superset(graph_update.all_anchors()) { + if !initial_anchors.is_superset(update.graph_update.all_anchors()) { println!("New anchor added at reorg depth {}", depth); } - let _ = recv_graph.apply_update(graph_update); + let _ = recv_graph.apply_update(update.graph_update); assert_eq!( get_balance(&recv_chain, &recv_graph)?, diff --git a/example-crates/example_electrum/src/main.rs b/example-crates/example_electrum/src/main.rs index a482e1b3..d321ded7 100644 --- a/example-crates/example_electrum/src/main.rs +++ b/example-crates/example_electrum/src/main.rs @@ -1,19 +1,20 @@ use std::{ - collections::BTreeMap, io::{self, Write}, sync::Mutex, }; use bdk_chain::{ - bitcoin::{constants::genesis_block, Address, Network, OutPoint, Txid}, + bitcoin::{constants::genesis_block, Address, Network, Txid}, + collections::BTreeSet, indexed_tx_graph::{self, IndexedTxGraph}, keychain, local_chain::{self, LocalChain}, + spk_client::{FullScanRequest, SyncRequest}, Append, ConfirmationHeightAnchor, }; use bdk_electrum::{ electrum_client::{self, Client, ElectrumApi}, - ElectrumExt, ElectrumUpdate, + ElectrumExt, }; use example_cli::{ anyhow::{self, Context}, @@ -147,48 +148,55 @@ fn main() -> anyhow::Result<()> { let client = electrum_cmd.electrum_args().client(args.network)?; - let response = match electrum_cmd.clone() { + let (chain_update, mut graph_update, keychain_update) = match electrum_cmd.clone() { ElectrumCommands::Scan { stop_gap, scan_options, .. } => { - let (keychain_spks, tip) = { + let request = { let graph = &*graph.lock().unwrap(); let chain = &*chain.lock().unwrap(); - let keychain_spks = graph - .index - .all_unbounded_spk_iters() - .into_iter() - .map(|(keychain, iter)| { - let mut first = true; - let spk_iter = iter.inspect(move |(i, _)| { - if first { - eprint!("\nscanning {}: ", keychain); - first = false; + FullScanRequest::from_chain_tip(chain.tip()) + .cache_graph_txs(graph.graph()) + .set_spks_for_keychain( + Keychain::External, + graph + .index + .unbounded_spk_iter(&Keychain::External) + .into_iter() + .flatten(), + ) + .set_spks_for_keychain( + Keychain::Internal, + graph + .index + .unbounded_spk_iter(&Keychain::Internal) + .into_iter() + .flatten(), + ) + .inspect_spks_for_all_keychains({ + let mut once = BTreeSet::new(); + move |k, spk_i, _| { + if once.insert(k) { + eprint!("\nScanning {}: ", k); + } else { + eprint!("{} ", spk_i); } - - eprint!("{} ", i); let _ = io::stdout().flush(); - }); - (keychain, spk_iter) + } }) - .collect::>(); - - let tip = chain.tip(); - (keychain_spks, tip) }; - client - .full_scan::<_, ConfirmationHeightAnchor>( - tip, - keychain_spks, - Some(graph.lock().unwrap().graph()), - stop_gap, - scan_options.batch_size, - ) - .context("scanning the blockchain")? + let res = client + .full_scan::<_>(request, stop_gap, scan_options.batch_size) + .context("scanning the blockchain")?; + ( + res.chain_update, + res.graph_update, + Some(res.last_active_indices), + ) } ElectrumCommands::Sync { mut unused_spks, @@ -201,7 +209,6 @@ fn main() -> anyhow::Result<()> { // Get a short lock on the tracker to get the spks we're interested in let graph = graph.lock().unwrap(); let chain = chain.lock().unwrap(); - let chain_tip = chain.tip().block_id(); if !(all_spks || unused_spks || utxos || unconfirmed) { unused_spks = true; @@ -211,18 +218,20 @@ fn main() -> anyhow::Result<()> { unused_spks = false; } - let mut spks: Box> = - Box::new(core::iter::empty()); + let chain_tip = chain.tip(); + let mut request = + SyncRequest::from_chain_tip(chain_tip.clone()).cache_graph_txs(graph.graph()); + if all_spks { let all_spks = graph .index .revealed_spks(..) .map(|(k, i, spk)| (k.to_owned(), i, spk.to_owned())) .collect::>(); - spks = Box::new(spks.chain(all_spks.into_iter().map(|(k, i, spk)| { - eprintln!("scanning {}:{}", k, i); + request = request.chain_spks(all_spks.into_iter().map(|(k, spk_i, spk)| { + eprintln!("scanning {}: {}", k, spk_i); spk - }))); + })); } if unused_spks { let unused_spks = graph @@ -230,82 +239,61 @@ fn main() -> anyhow::Result<()> { .unused_spks() .map(|(k, i, spk)| (k, i, spk.to_owned())) .collect::>(); - spks = Box::new(spks.chain(unused_spks.into_iter().map(|(k, i, spk)| { - eprintln!( - "Checking if address {} {}:{} has been used", - Address::from_script(&spk, args.network).unwrap(), - k, - i, - ); - spk - }))); + request = + request.chain_spks(unused_spks.into_iter().map(move |(k, spk_i, spk)| { + eprintln!( + "Checking if address {} {}:{} has been used", + Address::from_script(&spk, args.network).unwrap(), + k, + spk_i, + ); + spk + })); } - let mut outpoints: Box> = Box::new(core::iter::empty()); - if utxos { let init_outpoints = graph.index.outpoints(); let utxos = graph .graph() - .filter_chain_unspents(&*chain, chain_tip, init_outpoints) + .filter_chain_unspents(&*chain, chain_tip.block_id(), init_outpoints) .map(|(_, utxo)| utxo) .collect::>(); - - outpoints = Box::new( - utxos - .into_iter() - .inspect(|utxo| { - eprintln!( - "Checking if outpoint {} (value: {}) has been spent", - utxo.outpoint, utxo.txout.value - ); - }) - .map(|utxo| utxo.outpoint), - ); + request = request.chain_outpoints(utxos.into_iter().map(|utxo| { + eprintln!( + "Checking if outpoint {} (value: {}) has been spent", + utxo.outpoint, utxo.txout.value + ); + utxo.outpoint + })); }; - let mut txids: Box> = Box::new(core::iter::empty()); - if unconfirmed { let unconfirmed_txids = graph .graph() - .list_chain_txs(&*chain, chain_tip) + .list_chain_txs(&*chain, chain_tip.block_id()) .filter(|canonical_tx| !canonical_tx.chain_position.is_confirmed()) .map(|canonical_tx| canonical_tx.tx_node.txid) .collect::>(); - txids = Box::new(unconfirmed_txids.into_iter().inspect(|txid| { - eprintln!("Checking if {} is confirmed yet", txid); - })); + request = request.chain_txids( + unconfirmed_txids + .into_iter() + .inspect(|txid| eprintln!("Checking if {} is confirmed yet", txid)), + ); } - let electrum_update = client - .sync::( - chain.tip(), - spks, - Some(graph.graph()), - txids, - outpoints, - scan_options.batch_size, - ) + let res = client + .sync(request, scan_options.batch_size) .context("scanning the blockchain")?; // drop lock on graph and chain drop((graph, chain)); - (electrum_update, BTreeMap::new()) + (res.chain_update, res.graph_update, None) } }; - let ( - ElectrumUpdate { - chain_update, - mut graph_update, - }, - keychain_update, - ) = response; - let now = std::time::UNIX_EPOCH .elapsed() .expect("must get time") @@ -316,26 +304,17 @@ fn main() -> anyhow::Result<()> { let mut chain = chain.lock().unwrap(); let mut graph = graph.lock().unwrap(); - let chain = chain.apply_update(chain_update)?; + let chain_changeset = chain.apply_update(chain_update)?; - let indexed_tx_graph = { - let mut changeset = - indexed_tx_graph::ChangeSet::::default(); - let (_, indexer) = graph.index.reveal_to_target_multi(&keychain_update); - changeset.append(indexed_tx_graph::ChangeSet { - indexer, - ..Default::default() - }); - changeset.append(graph.apply_update(graph_update.map_anchors(|a| { - ConfirmationHeightAnchor { - anchor_block: a.anchor_block, - confirmation_height: a.confirmation_height, - } - }))); - changeset - }; + let mut indexed_tx_graph_changeset = + indexed_tx_graph::ChangeSet::::default(); + if let Some(keychain_update) = keychain_update { + let (_, keychain_changeset) = graph.index.reveal_to_target_multi(&keychain_update); + indexed_tx_graph_changeset.append(keychain_changeset.into()); + } + indexed_tx_graph_changeset.append(graph.apply_update(graph_update)); - (chain, indexed_tx_graph) + (chain_changeset, indexed_tx_graph_changeset) }; let mut db = db.lock().unwrap(); diff --git a/example-crates/wallet_electrum/src/main.rs b/example-crates/wallet_electrum/src/main.rs index 8b4cc559..bdbf3212 100644 --- a/example-crates/wallet_electrum/src/main.rs +++ b/example-crates/wallet_electrum/src/main.rs @@ -3,17 +3,16 @@ const SEND_AMOUNT: Amount = Amount::from_sat(5000); const STOP_GAP: usize = 50; const BATCH_SIZE: usize = 5; -use std::io::Write; use std::str::FromStr; use bdk::bitcoin::{Address, Amount}; -use bdk::chain::ConfirmationTimeHeightAnchor; -use bdk::wallet::Update; +use bdk::chain::collections::HashSet; use bdk::{bitcoin::Network, Wallet}; use bdk::{KeychainKind, SignOptions}; +use bdk_electrum::ElectrumResultExt; use bdk_electrum::{ electrum_client::{self, ElectrumApi}, - ElectrumExt, ElectrumUpdate, + ElectrumExt, }; use bdk_file_store::Store; @@ -39,48 +38,24 @@ fn main() -> Result<(), anyhow::Error> { print!("Syncing..."); let client = electrum_client::Client::new("ssl://electrum.blockstream.info:60002")?; - let prev_tip = wallet.latest_checkpoint(); - let keychain_spks = wallet - .all_unbounded_spk_iters() - .into_iter() - .map(|(k, k_spks)| { - let mut once = Some(()); - let mut stdout = std::io::stdout(); - let k_spks = k_spks - .inspect(move |(spk_i, _)| match once.take() { - Some(_) => print!("\nScanning keychain [{:?}]", k), - None => print!(" {:<3}", spk_i), - }) - .inspect(move |_| stdout.flush().expect("must flush")); - (k, k_spks) - }) - .collect(); + let request = wallet.start_full_scan().inspect_spks_for_all_keychains({ + let mut once = HashSet::::new(); + move |k, spk_i, _| match once.insert(k) { + true => print!("\nScanning keychain [{:?}]", k), + false => print!(" {:<3}", spk_i), + } + }); - 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 mut update = client + .full_scan(request, STOP_GAP, BATCH_SIZE)? + .try_into_confirmation_time_result(&client)?; + + let now = std::time::UNIX_EPOCH.elapsed().unwrap().as_secs(); + let _ = update.graph_update.update_last_seen_unconfirmed(now); println!(); - let now = std::time::UNIX_EPOCH.elapsed().unwrap().as_secs(); - let _ = graph_update.update_last_seen_unconfirmed(now); - - let wallet_update = Update { - last_active_indices: keychain_update, - graph: graph_update, - chain: Some(chain_update), - }; - wallet.apply_update(wallet_update)?; + wallet.apply_update(update)?; wallet.commit()?; let balance = wallet.get_balance();