From b8c99f5d5c90179431dfe399cfd200f5859c5b0f Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Fri, 22 Apr 2022 17:58:19 +0000 Subject: [PATCH] Add internal docs for ChannelMonitor::payment_preimages --- lightning/src/chain/channelmonitor.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs index 0aa7d35d4e9..3c58f158f5f 100644 --- a/lightning/src/chain/channelmonitor.rs +++ b/lightning/src/chain/channelmonitor.rs @@ -655,6 +655,10 @@ pub(crate) struct ChannelMonitorImpl { // deserialization current_holder_commitment_number: u64, + /// The set of payment hashes from inbound payments for which we know the preimage. Payment + /// preimages which are not included in any unrevoked local commitment transaction or unrevoked + /// remote commitment transactions are automatically removed when commitment transactions are + /// revoked. payment_preimages: HashMap, // Note that `MonitorEvent`s MUST NOT be generated during update processing, only generated