From: 志宇 Date: Mon, 20 Nov 2023 21:06:53 +0000 (+0800) Subject: docs(bdk): clarify `insert_txout` docs X-Git-Tag: v1.0.0-alpha.3~13^2 X-Git-Url: http://internal-gitweb-vhost/script/%22https:/struct.CommandStringError.html?a=commitdiff_plain;h=278210bb8918923005e80968df3dfcc3372c0a5c;p=bdk docs(bdk): clarify `insert_txout` docs Inserted txouts will not be shown in `list_unspent` or `list_output`. --- diff --git a/crates/bdk/src/wallet/mod.rs b/crates/bdk/src/wallet/mod.rs index a1d83467..442fe62e 100644 --- a/crates/bdk/src/wallet/mod.rs +++ b/crates/bdk/src/wallet/mod.rs @@ -814,15 +814,20 @@ impl Wallet { } /// 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 - /// a [`Transaction`] passed to the [`calculate_fee`] or [`calculate_fee_rate`] functions. + /// This is used for providing a previous output's value so that we can use [`calculate_fee`] + /// 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_rate`]: Self::calculate_fee_rate + /// [`list_unspent`]: Self::list_unspent + /// [`list_output`]: Self::list_output /// [`commit`]: Self::commit pub fn insert_txout(&mut self, outpoint: OutPoint, txout: TxOut) where