Improve docs of satisfaction_weight

This commit is contained in:
LLFourn 2021-02-12 10:25:57 +11:00
parent 7c1dcd8a72
commit d9a102afa9
No known key found for this signature in database
GPG Key ID: A27093B54DA11F65

View 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,