Skip to content

Commit 43907a8

Browse files
committed
Add internal docs for ChannelMonitor::payment_preimages
1 parent 44699ba commit 43907a8

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lightning/src/chain/channelmonitor.rs

+4
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,10 @@ pub(crate) struct ChannelMonitorImpl<Signer: Sign> {
655655
// deserialization
656656
current_holder_commitment_number: u64,
657657

658+
/// The set of payment hashes from inbound payments for which we know the preimage. Payment
659+
/// preimages which are not included in any unrevoked local commitment transaction or unrevoked
660+
/// remote commitment transactions are automatically removed when commitment transactions are
661+
/// revoked.
658662
payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
659663

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

0 commit comments

Comments
 (0)