Skip to content

Commit b9dab4e

Browse files
committed
f more doc tweaks
1 parent 54f3bca commit b9dab4e

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

lightning/src/util/events.rs

+6-4
Original file line numberDiff line numberDiff line change
@@ -156,12 +156,14 @@ pub enum Event {
156156
/// The fee, in milli-satoshis, which was earned as a result of the payment.
157157
///
158158
/// Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
159-
/// was pending, the amount the next hop claimed may have been rounded down, causing a
160-
/// higher fee than expected. In this case, `claim_from_onchain_tx` will be set.
159+
/// was pending, the amount the next hop claimed will have been rounded down to the nearest
160+
/// whole satoshi. Thus, the fee calculated here may be higher than expected as we still
161+
/// claimed the full value in millisatoshis from the source. In this case,
162+
/// `claim_from_onchain_tx` will be set.
161163
///
162164
/// If the channel which sent us the payment has been force-closed, we will claim the funds
163-
/// via an on-chain transaction. In that case we do not consider the on-chain transaction
164-
/// fees involved in such a claim and this value will be `None`. It is possible duplicate
165+
/// via an on-chain transaction. In that case we do not yet know the on-chain transaction
166+
/// fees which we will spend and will instead set this to `None`. It is possible duplicate
165167
/// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
166168
/// `None`.
167169
fee_earned_msat: Option<u64>,

0 commit comments

Comments
 (0)