Skip to content

Commit fbbd8d6

Browse files
committed
f tweak docs
1 parent ca32c69 commit fbbd8d6

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning/src/util/events.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -155,16 +155,18 @@ pub enum Event {
155155
PaymentForwarded {
156156
/// The fee, in milli-satoshis, which was earned as a result of the payment.
157157
///
158-
/// Note that if we force-closed a channel while a forwarded HTLC was pending, the amount
159-
/// the next hop claimed may have been rounded down, causing a higher fee than expected.
158+
/// 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.
160161
///
161162
/// If the channel which sent us the payment has been force-closed, we will claim the funds
162163
/// via an on-chain transaction. In that case we do not consider the on-chain transaction
163164
/// fees involved in such a claim and this value will be `None`. It is possible duplicate
164165
/// `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
165166
/// `None`.
166167
fee_earned_msat: Option<u64>,
167-
/// If this is `true`, the forwarded HTLC was claimed on-chain after a force-closure.
168+
/// If this is `true`, the forwarded HTLC will be claimed on-chain after a the channel on
169+
/// which we received the HTLC was force-closed.
168170
claim_from_onchain_tx: bool,
169171
},
170172
}

0 commit comments

Comments
 (0)