From 88d689a323d7d03b2bcbba4716cc920513ae6164 Mon Sep 17 00:00:00 2001 From: Valentine Wallace Date: Wed, 11 Sep 2024 13:57:19 -0400 Subject: [PATCH] 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. --- lightning/src/events/mod.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs index cd4b140ff..3538aa367 100644 --- a/lightning/src/events/mod.rs +++ b/lightning/src/events/mod.rs @@ -560,11 +560,15 @@ pub enum PaymentFailureReason { /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time /// [`InvoiceRequestExpired`]: Self::InvoiceRequestExpired PaymentExpired, - /// We failed to find a route while retrying the payment. + /// We failed to find a route while sending or retrying the payment. /// /// Note that this generally indicates that we've exhausted the available set of possible /// routes - we tried the payment over a few routes but were not able to find any further /// candidate routes beyond those. + /// + /// Also used for [`BlindedPathCreationFailed`] when downgrading to versions prior to 0.0.124. + /// + /// [`BlindedPathCreationFailed`]: Self::BlindedPathCreationFailed RouteNotFound, /// This error should generally never happen. This likely means that there is a problem with /// your router. -- 2.39.5