Skip to content

Commit 88d689a

Browse files
Update docs for PaymentFailureReason::RouteNotFound
Since we started using this error in send_payment_for_bolt12_invoice, this error type is no longer only used on retry but also on initial send.
1 parent 3945bf8 commit 88d689a

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lightning/src/events/mod.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -560,11 +560,15 @@ pub enum PaymentFailureReason {
560560
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
561561
/// [`InvoiceRequestExpired`]: Self::InvoiceRequestExpired
562562
PaymentExpired,
563-
/// We failed to find a route while retrying the payment.
563+
/// We failed to find a route while sending or retrying the payment.
564564
///
565565
/// Note that this generally indicates that we've exhausted the available set of possible
566566
/// routes - we tried the payment over a few routes but were not able to find any further
567567
/// candidate routes beyond those.
568+
///
569+
/// Also used for [`BlindedPathCreationFailed`] when downgrading to versions prior to 0.0.124.
570+
///
571+
/// [`BlindedPathCreationFailed`]: Self::BlindedPathCreationFailed
568572
RouteNotFound,
569573
/// This error should generally never happen. This likely means that there is a problem with
570574
/// your router.

0 commit comments

Comments
 (0)