Skip to content

Commit fce7b5a

Browse files
Fix outdated PendingOutboundPayment::Abandoned docs
1 parent 0684d56 commit fce7b5a

File tree

1 file changed

+2
-7
lines changed

1 file changed

+2
-7
lines changed

lightning/src/ln/outbound_payment.rs

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

0 commit comments

Comments
 (0)