Skip to content

Commit

Permalink
Document on claim events that amount_msat may be > invoice amount
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinewallace committed Jun 20, 2023
1 parent 0d94d9f commit 2127eb8
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions lightning/src/events/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,8 @@ pub enum Event {
///
/// Payments received on LDK versions prior to 0.0.115 will have this field unset.
onion_fields: Option<RecipientOnionFields>,
/// The value, in thousandths of a satoshi, that this payment is claimable for.
/// The value, in thousandths of a satoshi, that this payment is claimable for. May be greater
/// than the invoice amount.
///
/// May be less than the invoice amount if [`ChannelConfig::accept_underpaying_htlcs`] is set
/// and the previous hop took an extra fee.
Expand Down Expand Up @@ -446,7 +447,8 @@ pub enum Event {
/// The payment hash of the claimed payment. Note that LDK will not stop you from
/// registering duplicate payment hashes for inbound payments.
payment_hash: PaymentHash,
/// The value, in thousandths of a satoshi, that this payment is for.
/// The value, in thousandths of a satoshi, that this payment is for. May be greater than the
/// invoice amount.
amount_msat: u64,
/// The purpose of the claimed payment, i.e. whether the payment was for an invoice or a
/// spontaneous payment.
Expand Down

0 comments on commit 2127eb8

Please sign in to comment.