X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Fevents.rs;h=5a0a9d0cc0a7cf584f7509fda22669fb28b9d5df;hb=782eb3658fbc53ceb9c64847692061f2198cb786;hp=0e04442c5f0827f51ea5d612b93a69dff7103828;hpb=3ba91cea59fc2a9c4edb6b06ba54244a640d659d;p=rust-lightning

diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
index 0e04442c5..5a0a9d0cc 100644
--- a/lightning/src/util/events.rs
+++ b/lightning/src/util/events.rs
@@ -409,8 +409,8 @@ pub enum Event {
 	/// provide failure information for each MPP part in the payment.
 	///
 	/// This event is provided once there are no further pending HTLCs for the payment and the
-	/// payment is no longer retryable, either due to a several-block timeout or because
-	/// [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
+	/// payment is no longer retryable due to [`ChannelManager::abandon_payment`] having been
+	/// called for the corresponding payment.
 	///
 	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 	PaymentFailed {
@@ -449,9 +449,14 @@ pub enum Event {
 	/// Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
 	/// something. You may wish to retry with a different route.
 	///
+	/// If you have given up retrying this payment and wish to fail it, you MUST call
+	/// [`ChannelManager::abandon_payment`] at least once for a given [`PaymentId`] or memory
+	/// related to payment tracking will leak.
+	///
 	/// Note that this does *not* indicate that all paths for an MPP payment have failed, see
 	/// [`Event::PaymentFailed`] and [`all_paths_failed`].
 	///
+	/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 	/// [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
 	PaymentPathFailed {
 		/// The id returned by [`ChannelManager::send_payment`] and used with