Clarify event doc specifying anchor support
authorTony Giorgio <tonygiorgio@protonmail.com>
Sun, 25 Jun 2023 02:20:50 +0000 (21:20 -0500)
committerTony Giorgio <tonygiorgio@protonmail.com>
Fri, 30 Jun 2023 03:10:02 +0000 (22:10 -0500)
lightning/src/events/mod.rs

index b9fb955a5a2e5d0beb0df60b950466ac6d387d46..a6601e4d99c21653ee991614d6662fefba92176b 100644 (file)
@@ -833,8 +833,11 @@ pub enum Event {
        /// Indicates that a transaction originating from LDK needs to have its fee bumped. This event
        /// requires confirmed external funds to be readily available to spend.
        ///
-       /// LDK does not currently generate this event. It is limited to the scope of channels with
-       /// anchor outputs, which will be introduced in a future release.
+       /// LDK does not currently generate this event unless the
+       /// [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`] config flag is set to true.
+       /// It is limited to the scope of channels with anchor outputs.
+       ///
+       /// [`ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx`]: crate::util::config::ChannelHandshakeConfig::negotiate_anchors_zero_fee_htlc_tx
        BumpTransaction(BumpTransactionEvent),
 }