]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add missing docs for BumpHTLCResolution
authorWilmer Paulino <wilmer@wilmerpaulino.com>
Wed, 15 Feb 2023 00:14:03 +0000 (16:14 -0800)
committerWilmer Paulino <wilmer@wilmerpaulino.com>
Mon, 20 Mar 2023 18:32:09 +0000 (11:32 -0700)
lightning/src/util/events.rs

index 754283dfb8c08761acfe7f73b1d11c50cf17c303..b64022026e38974e46eb544bf2856a48178ea1a9 100644 (file)
@@ -462,7 +462,10 @@ pub enum BumpTransactionEvent {
        /// [`EcdsaChannelSigner::sign_holder_htlc_transaction`]: crate::chain::keysinterface::EcdsaChannelSigner::sign_holder_htlc_transaction
        /// [`HTLCDescriptor::tx_input_witness`]: HTLCDescriptor::tx_input_witness
        HTLCResolution {
+               /// The target feerate that the resulting HTLC transaction must meet.
                target_feerate_sat_per_1000_weight: u32,
+               /// The set of pending HTLCs on the confirmed commitment that need to be claimed, preferably
+               /// by the same transaction.
                htlc_descriptors: Vec<HTLCDescriptor>,
        },
 }