mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-01-19 14:44:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for PaymentFailureReason::RouteNotFound

Browse Source 
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.
This commit is contained in:
Valentine Wallace 2024-09-11 13:57:19 -04:00
parent 3945bf86f9
commit 88d689a323
No known key found for this signature in database
GPG Key ID: FD3E106A2CE099B4
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
lightning/src/events/mod.rs
View File

@ -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.