Skip to content

Commit f2005ba

Browse files
committed
Document when Events::PaymentSent::pending_fee_msat is Some
1 parent baefe5a commit f2005ba

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

lightning/src/events/mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -789,6 +789,8 @@ pub enum Event {
789789
/// If the recipient or an intermediate node misbehaves and gives us free money, this may
790790
/// overstate the amount paid, though this is unlikely.
791791
///
792+
/// This is only `None` for payments initiated on LDK versions prior to 0.0.103.
793+
///
792794
/// [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
793795
fee_paid_msat: Option<u64>,
794796
},

lightning/src/ln/outbound_payment.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ pub(crate) enum PendingOutboundPayment {
7171
keysend_preimage: Option<PaymentPreimage>,
7272
custom_tlvs: Vec<(u64, Vec<u8>)>,
7373
pending_amt_msat: u64,
74-
/// Used to track the fee paid. Only present if the payment was serialized on 0.0.103+.
74+
/// Used to track the fee paid. Present iff the payment was serialized on 0.0.103+.
7575
pending_fee_msat: Option<u64>,
7676
/// The total payment amount across all paths, used to verify that a retry is not overpaying.
7777
total_msat: u64,

0 commit comments

Comments
 (0)