Skip to content

Commit ecc1f22

Browse files
committed
f Add note that amount_msat field excludes fees
1 parent 7cb4a97 commit ecc1f22

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

lightning/src/events/mod.rs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -931,11 +931,15 @@ pub enum Event {
931931
payment_hash: PaymentHash,
932932
/// The total amount that was paid, across all paths.
933933
///
934+
/// Note that, like [`Route::get_total_amount`], this does *not* include the paid fees.
935+
///
934936
/// This is only `None` for payments initiated on LDK versions prior to 0.2.
937+
///
938+
/// [`Route::get_total_amount`]: crate::routing::router::Route::get_total_amount
935939
amount_msat: Option<u64>,
936940
/// The total fee which was spent at intermediate hops in this payment, across all paths.
937941
///
938-
/// Note that, like [`Route::get_total_fees`] this does *not* include any potential
942+
/// Note that, like [`Route::get_total_fees`], this does *not* include any potential
939943
/// overpayment to the recipient node.
940944
///
941945
/// If the recipient or an intermediate node misbehaves and gives us free money, this may

0 commit comments

Comments
 (0)