Add config knob for forwarding intercept payments

[rust-lightning] / lightning / src / util / events.rs

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index e3e458cb9005c72af363e5eff7c1285f93c34898..18058bc03a8e10505ce0f966729cb56d66a7d147 100644 (file)
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -612,13 +612,14 @@ pub enum Event {
        },
        /// Used to indicate that we've intercepted an HTLC forward. This event will only be generated if
        /// you've encoded an intercept scid in the receiver's invoice route hints using
-       /// [`ChannelManager::get_intercept_scid`].
+       /// [`ChannelManager::get_intercept_scid`] and have set [`UserConfig::accept_intercept_htlcs`].
        ///
        /// [`ChannelManager::forward_intercepted_htlc`] or
        /// [`ChannelManager::fail_intercepted_htlc`] MUST be called in response to this event. See
        /// their docs for more information.
        ///
        /// [`ChannelManager::get_intercept_scid`]: crate::ln::channelmanager::ChannelManager::get_intercept_scid
+       /// [`UserConfig::accept_intercept_htlcs`]: crate::util::config::UserConfig::accept_intercept_htlcs
        /// [`ChannelManager::forward_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::forward_intercepted_htlc
        /// [`ChannelManager::fail_intercepted_htlc`]: crate::ln::channelmanager::ChannelManager::fail_intercepted_htlc
        HTLCIntercepted {