Skip to content

Commit a647883

Browse files
committed
Update docs on PaymentFailureReason::RouteNotFound to add context
tnull noted on discord that its somewhat unclear to users what `RouteNotFound` actually means - that we ran out of routes, rather than could not find a route at all - so the docs are updated here.
1 parent 7ab438d commit a647883

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning/src/events/mod.rs

+4
Original file line numberDiff line numberDiff line change
@@ -368,6 +368,10 @@ pub enum PaymentFailureReason {
368368
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
369369
PaymentExpired,
370370
/// We failed to find a route while retrying the payment.
371+
///
372+
/// Note that this generally indicates that we've exhausted the available set of possible
373+
/// routes - we tried the payment over a few routes but were not able to find any further
374+
/// candidate routes beyond those.
371375
RouteNotFound,
372376
/// This error should generally never happen. This likely means that there is a problem with
373377
/// your router.

0 commit comments

Comments
 (0)