From: Wilmer Paulino Date: Tue, 11 Oct 2022 18:39:32 +0000 (-0400) Subject: Document expected call frequency of ChainMonitor::process_pending_events X-Git-Tag: v0.0.112~11^2~2 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=843b8263d5af413d687ea7de36db364251b6f352;p=rust-lightning Document expected call frequency of ChainMonitor::process_pending_events --- diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs index 2479e8f7e..3949810bf 100644 --- a/lightning/src/chain/chainmonitor.rs +++ b/lightning/src/chain/chainmonitor.rs @@ -707,6 +707,7 @@ impl even L::Target: Logger, P::Target: Persist, { + #[cfg(not(anchors))] /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity. /// /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in @@ -722,6 +723,29 @@ impl even handler.handle_event(&event); } } + #[cfg(anchors)] + /// Processes [`SpendableOutputs`] events produced from each [`ChannelMonitor`] upon maturity. + /// + /// For channels featuring anchor outputs, this method will also process [`BumpTransaction`] + /// events produced from each [`ChannelMonitor`] while there is a balance to claim onchain + /// within each channel. As the confirmation of a commitment transaction may be critical to the + /// safety of funds, this method must be invoked frequently, ideally once for every chain tip + /// update (block connected or disconnected). + /// + /// An [`EventHandler`] may safely call back to the provider, though this shouldn't be needed in + /// order to handle these events. + /// + /// [`SpendableOutputs`]: events::Event::SpendableOutputs + /// [`BumpTransaction`]: events::Event::BumpTransaction + fn process_pending_events(&self, handler: H) where H::Target: EventHandler { + let mut pending_events = Vec::new(); + for monitor_state in self.monitors.read().unwrap().values() { + pending_events.append(&mut monitor_state.monitor.get_and_clear_pending_events()); + } + for event in pending_events.drain(..) { + handler.handle_event(&event); + } + } } #[cfg(test)]