From d8c0a2beab30637b9ebc346270a5ec1f85ab695a Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Fri, 5 May 2023 04:08:55 +0000 Subject: [PATCH] Docuemnt when `PaymentPathFailed::payment_id` is `Some` The `PaymentPathFailed::payment_id` field has been `Some` since the field was added in 73f601fd3d1c9defe553392264ca6dbcc53e4334. --- lightning/src/events/mod.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs index 046eb22f7..665fd0ed2 100644 --- 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, -- 2.39.5