Skip to content

Commit ed1ef50

Browse files
Fix outdated PendingOutboundPayment::Abandoned docs
1 parent 76cf9eb commit ed1ef50

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

lightning/src/ln/outbound_payment.rs

+2-7
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,8 @@ pub(crate) enum PendingOutboundPayment {
6464
payment_hash: Option<PaymentHash>,
6565
timer_ticks_without_htlcs: u8,
6666
},
67-
/// When a payer gives up trying to retry a payment, they inform us, letting us generate a
68-
/// `PaymentFailed` event when all HTLCs have irrevocably failed. This avoids a number of race
69-
/// conditions in MPP-aware payment retriers (1), where the possibility of multiple
70-
/// `PaymentPathFailed` events with `all_paths_failed` can be pending at once, confusing a
71-
/// downstream event handler as to when a payment has actually failed.
72-
///
73-
/// (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
67+
/// When we've decided to give up retrying a payment, we mark it as abandoned so we can eventually
68+
/// generate a `PaymentFailed` event when all HTLCs have irrevocably failed.
7469
Abandoned {
7570
session_privs: HashSet<[u8; 32]>,
7671
payment_hash: PaymentHash,

0 commit comments

Comments
 (0)