Skip to content

Commit

Permalink
docs(electrum): enhance API docs for fetch_prev_txouts argument
Browse files Browse the repository at this point in the history
  • Loading branch information
thunderbiscuit committed Aug 7, 2024
1 parent 6123778 commit 4dd92a6
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions crates/electrum/src/bdk_electrum_client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,16 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
/// - `request`: struct with data required to perform a spk-based blockchain client full scan,
/// see [`FullScanRequest`]
/// - `stop_gap`: the full scan for each keychain stops after a gap of script pubkeys with no
/// associated transactions
/// associated transactions
/// - `batch_size`: specifies the max number of script pubkeys to request for in a single batch
/// request
/// - `fetch_prev_txouts`: specifies whether or not we want previous `TxOut`s for fee
/// request
/// - `fetch_prev_txouts`: specifies whether we want previous `TxOut`s for fee calculation. Note
/// that this requires additional calls to the Electrum server, but is
/// necessary for calculating the fee on a transaction if your wallet
/// does not own the inputs. Methods like Wallet.calculate_fee and
/// Wallet.calculate_fee_rate will return a
/// CalculateFeeError::MissingTxOut error if those TxOuts are not present
/// in the transaction graph.
pub fn full_scan<K: Ord + Clone>(
&self,
request: FullScanRequest<K>,
Expand Down Expand Up @@ -154,9 +160,14 @@ impl<E: ElectrumApi> BdkElectrumClient<E> {
/// - `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
/// - `fetch_prev_txouts`: specifies whether or not we want previous `TxOut`s for fee
/// calculation
/// request
/// - `fetch_prev_txouts`: specifies whether we want previous `TxOut`s for fee calculation. Note
// that this requires additional calls to the Electrum server, but is
// necessary for calculating the fee on a transaction if your wallet
// does not own the inputs. Methods like Wallet.calculate_fee and
// Wallet.calculate_fee_rate will return a
// CalculateFeeError::MissingTxOut error if those TxOuts are not present
// in the transaction graph.
///
/// If the scripts to sync are unknown, such as when restoring or importing a keychain that
/// may include scripts that have been used, use [`full_scan`] with the keychain.
Expand Down

0 comments on commit 4dd92a6

Please sign in to comment.