frost/bdk
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(electrum): fixed full_scan, sync, and crate documentation

Browse Source
This commit is contained in:
Wei Chen 2024-05-06 15:46:49 +08:00 committed by 志宇
parent b1f861b932
commit 9ed33c25ea
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
2 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
crates/electrum/src/electrum_ext.rs
View File

@ -18,9 +18,8 @@ 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
/// - `request`: struct with data required to perform a spk-based blockchain client full scan,
/// see [`FullScanRequest`]
///
/// 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
@ -35,12 +34,8 @@ pub trait ElectrumExt {
/// Sync a set of scripts with the blockchain (via an Electrum client) for the data specified
/// and returns updates for [`bdk_chain`] data structures.
///
/// - `prev_tip`: the most recent blockchain tip present locally
/// - `misc_spks`: an iterator of scripts we want to sync transactions for
/// - `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
/// - `request`: struct with data required to perform a spk-based blockchain client sync,
/// see [`SyncRequest`]
///
/// `batch_size` specifies the max number of script pubkeys to request for in a single batch
/// request.
@ -450,7 +445,6 @@ fn populate_with_txids(
};
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 {

2
crates/electrum/src/lib.rs
View File

@ -7,7 +7,7 @@
//! 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 [`bdk_chain::TxGraph`], which includes `txid`s and full transactions.
//! [`bdk_chain`].
//!
//! Refer to [`example_electrum`] for a complete example.
//!