Skip to content

Commit 3b75eee

Browse files
Fix docs on ChannelMonitor::payment_preimages
1 parent 0ca79af commit 3b75eee

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1256,18 +1256,19 @@ pub(crate) struct ChannelMonitorImpl<Signer: EcdsaChannelSigner> {
12561256
// deserialization
12571257
current_holder_commitment_number: u64,
12581258

1259-
/// The set of payment hashes from inbound payments for which we know the preimage. Payment
1260-
/// preimages that are not included in any unrevoked local commitment transaction or unrevoked
1261-
/// remote commitment transactions are automatically removed when commitment transactions are
1262-
/// revoked. Note that this happens one revocation after it theoretically could, leaving
1263-
/// preimages present here for the previous state even when the channel is "at rest". This is a
1264-
/// good safety buffer, but also is important as it ensures we retain payment preimages for the
1265-
/// previous local commitment transaction, which may have been broadcast already when we see
1266-
/// the revocation (in setups with redundant monitors).
1259+
/// The set of payment hashes from inbound payments and forwards for which we know the preimage.
1260+
/// Payment preimages that are not included in any unrevoked local commitment transaction or
1261+
/// unrevoked remote commitment transactions are automatically removed when commitment
1262+
/// transactions are revoked. Note that this happens one revocation after it theoretically could,
1263+
/// leaving preimages present here for the previous state even when the channel is "at rest".
1264+
/// This is a good safety buffer, but also is important as it ensures we retain payment preimages
1265+
/// for the previous local commitment transaction, which may have been broadcast already when we
1266+
/// see the revocation (in setups with redundant monitors).
12671267
///
12681268
/// We also store [`PaymentClaimDetails`] here, tracking the payment information(s) for this
12691269
/// preimage for inbound payments. This allows us to rebuild the inbound payment information on
1270-
/// startup even if we lost our `ChannelManager`.
1270+
/// startup even if we lost our `ChannelManager`. For forwardeds, the list of
1271+
/// [`PaymentClaimDetails`] is empty.
12711272
payment_preimages: HashMap<PaymentHash, (PaymentPreimage, Vec<PaymentClaimDetails>)>,
12721273

12731274
// Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated

0 commit comments

Comments
 (0)