]> Untitled Git - bdk/commitdiff
Improve docs of satisfaction_weight
authorLLFourn <lloyd.fourn@gmail.com>
Thu, 11 Feb 2021 23:25:57 +0000 (10:25 +1100)
committerLLFourn <lloyd.fourn@gmail.com>
Fri, 26 Feb 2021 02:33:52 +0000 (13:33 +1100)
src/types.rs

index 347325a8e0cb921e718caf16e63ae14e0210cd5d..9873150a84016db9c932a28def280f66abc61193 100644 (file)
@@ -106,8 +106,10 @@ pub struct LocalUtxo {
 /// A [`Utxo`] with its `satisfaction_weight`.
 #[derive(Debug, Clone, PartialEq)]
 pub struct WeightedUtxo {
-    /// The weight of the witness data or `scriptSig`.
-    /// This is used to properly maintain the feerate when doing coin selection.
+    /// The weight of the witness data and `scriptSig` expressed in [weight units]. This is used to
+    /// properly maintain the feerate when adding this input to a transaction during coin selection.
+    ///
+    /// [weight units]: https://en.bitcoin.it/wiki/Weight_units
     pub satisfaction_weight: usize,
     /// The UTXO
     pub utxo: Utxo,