projects
/
rust-lightning
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
| inline |
side by side
(parent:
e1394f3
)
Docuemnt when `PaymentPathFailed::payment_id` is `Some`
2023-05-doc-events-present
author
Matt Corallo
<git@bluematt.me>
Fri, 5 May 2023 04:08:55 +0000
(
04:08
+0000)
committer
Matt Corallo
<git@bluematt.me>
Fri, 5 May 2023 04:08:55 +0000
(
04:08
+0000)
The `PaymentPathFailed::payment_id` field has been `Some` since
the field was added in
73f601fd3d1c9defe553392264ca6dbcc53e4334
.
lightning/src/events/mod.rs
patch
|
blob
|
history
diff --git
a/lightning/src/events/mod.rs
b/lightning/src/events/mod.rs
index 046eb22f731535ca3b001a8e6b9b03c25adc50f1..665fd0ed23a51ae27b7c260b33717ac9690f74db 100644
(file)
--- a/
lightning/src/events/mod.rs
+++ b/
lightning/src/events/mod.rs
@@
-520,6
+520,8
@@
pub enum Event {
PaymentPathFailed {
/// The `payment_id` passed to [`ChannelManager::send_payment`].
///
+ /// This will be `Some` for all payment paths which failed on LDK 0.0.103 or later.
+ ///
/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
payment_id: Option<PaymentId>,