Make rand a dev-dep by having the user randomize HTLC forward delay

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

diff --git a/src/util/events.rs b/src/util/events.rs
index e4bed8f2e35494be576688f1119b6538d183de09..96a5b48a76d26877cf58545528fb99f4c3e3b91b 100644 (file)
--- a/src/util/events.rs
+++ b/src/util/events.rs
@@ -92,7 +92,10 @@ pub enum Event {
        /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
        /// time in the future.
        PendingHTLCsForwardable {
-               /// The amount of time that should be waited prior to calling process_pending_htlc_forwards
+               /// The minimum amount of time that should be waited prior to calling
+               /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
+               /// you should wait a random amount of time in roughly the range (now + time_forwardable,
+               /// now + 5*time_forwardable).
                time_forwardable: Duration,
        },
        /// Used to indicate that an output was generated on-chain which you should know how to spend.