]> Untitled Git - bdk/commitdiff
docs(bdk): clarify `insert_txout` docs
author志宇 <hello@evanlinjin.me>
Mon, 20 Nov 2023 21:06:53 +0000 (05:06 +0800)
committer志宇 <hello@evanlinjin.me>
Mon, 20 Nov 2023 21:06:53 +0000 (05:06 +0800)
Inserted txouts will not be shown in `list_unspent` or `list_output`.

crates/bdk/src/wallet/mod.rs

index a1d834672d5a9f5fe59c54a0db6ad677952e7885..442fe62e295ba7a398c8dda8f61d8f60bf54d1cd 100644 (file)
@@ -814,15 +814,20 @@ impl<D> Wallet<D> {
     }
 
     /// 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