From: Valentine Wallace Date: Sun, 12 Feb 2023 00:35:48 +0000 (-0500) Subject: Fix outdated PendingOutboundPayment::Abandoned docs X-Git-Tag: v0.0.114-beta~8^2~1 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=12bcc9ae43a5f00d43551e42bac96eaff5933562;p=rust-lightning Fix outdated PendingOutboundPayment::Abandoned docs --- diff --git a/lightning/src/ln/outbound_payment.rs b/lightning/src/ln/outbound_payment.rs index a28169032..e1c5fa547 100644 --- a/lightning/src/ln/outbound_payment.rs +++ b/lightning/src/ln/outbound_payment.rs @@ -64,13 +64,8 @@ pub(crate) enum PendingOutboundPayment { payment_hash: Option, timer_ticks_without_htlcs: u8, }, - /// When a payer gives up trying to retry a payment, they inform us, letting us generate a - /// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race - /// conditions in MPP-aware payment retriers (1), where the possibility of multiple - /// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a - /// downstream event handler as to when a payment has actually failed. - /// - /// (1) + /// When we've decided to give up retrying a payment, we mark it as abandoned so we can eventually + /// generate a `PaymentFailed` event when all HTLCs have irrevocably failed. Abandoned { session_privs: HashSet<[u8; 32]>, payment_hash: PaymentHash,