From: Matt Corallo Date: Thu, 29 Feb 2024 14:50:26 +0000 (+0000) Subject: Update docs on `PaymentFailureReason::RouteNotFound` to add context X-Git-Tag: v0.0.123-beta~53^2 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=a6478838e83e535939dd851f32a46d5cc8c44592;p=rust-lightning 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. --- diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs index d08d3c5a..485a23e0 100644 --- a/lightning/src/events/mod.rs +++ b/lightning/src/events/mod.rs @@ -368,6 +368,10 @@ pub enum PaymentFailureReason { /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time PaymentExpired, /// We failed to find a route while 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. RouteNotFound, /// This error should generally never happen. This likely means that there is a problem with /// your router.