Document exactly our CLTV sanitization policy for final incoming HTLCs

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

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index 2c00a133575d60d9923f1e9afb0501b9cc4fa706..bfb29df2460b32180825e5b5d2da1c581ac2b210 100644 (file)
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -52,7 +52,8 @@ pub enum Event {
        /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
        /// ChannelManager::claim_funds to get it....
        /// Note that if the preimage is not known or the amount paid is incorrect, you must call
-       /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC.
+       /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC before
+       /// LATENCY_GRACE_PERIOD_BLOCKS to avoid any channel-closure by onchain monitoring.
        /// The amount paid should be considered 'incorrect' when it is less than or more than twice
        /// the amount expected.
        PaymentReceived {