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

docs(bdk): clarify insert_txout docs

Browse Source 
Inserted txouts will not be shown in `list_unspent` or `list_output`.
This commit is contained in:
志宇 2023-11-21 05:06:53 +08:00
parent 6fb45d8a73
commit 278210bb89
No known key found for this signature in database
GPG Key ID: F6345C9837C2BDE8
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/bdk/src/wallet/mod.rs
View File

@ -814,15 +814,20 @@ impl<D> Wallet<D> {
} }
/// Inserts a [`TxOut`] at [`OutPoint`] into the wallet's transaction graph. /// Inserts a [`TxOut`] at [`OutPoint`] into the wallet's transaction graph.
/// Any inserted TxOuts are not persisted until [`commit`] is called.
/// ///
/// This can be used to add a `TxOut` that the wallet doesn't own but is used as an input to /// This is used for providing a previous output's value so that we can use [`calculate_fee`]
/// a [`Transaction`] passed to the [`calculate_fee`] or [`calculate_fee_rate`] functions. /// or [`calculate_fee_rate`] on a given transaction. Outputs inserted with this method will
/// not be returned in [`list_unspent`] or [`list_output`].
/// ///
/// Only insert TxOuts you trust the values for! /// Any inserted `TxOut`s are not persisted until [`commit`] is called.
///
/// **WARNING:** This should only be used to add `TxOut`s that the wallet does not own. Only
/// insert `TxOut`s that you trust the values for!
/// ///
/// [`calculate_fee`]: Self::calculate_fee /// [`calculate_fee`]: Self::calculate_fee
/// [`calculate_fee_rate`]: Self::calculate_fee_rate /// [`calculate_fee_rate`]: Self::calculate_fee_rate
/// [`list_unspent`]: Self::list_unspent
/// [`list_output`]: Self::list_output
/// [`commit`]: Self::commit /// [`commit`]: Self::commit
pub fn insert_txout(&mut self, outpoint: OutPoint, txout: TxOut) pub fn insert_txout(&mut self, outpoint: OutPoint, txout: TxOut)
where where