Persist `ChannelMonitor`s after new blocks are connected

[rust-lightning] / lightning / src / chain / mod.rs

diff --git a/lightning/src/chain/mod.rs b/lightning/src/chain/mod.rs
index 55755073bb1a7546d39ce65fd2fd8c9d0e9b4af5..25e5a97d288df42d4a2baf2263aae9e9d493f28e 100644 (file)
--- a/lightning/src/chain/mod.rs
+++ b/lightning/src/chain/mod.rs
@@ -285,6 +285,10 @@ pub trait Watch<ChannelSigner: Sign> {
        /// Returns any monitor events since the last call. Subsequent calls must only return new
        /// events.
        ///
+       /// Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
+       /// further events may be returned here until the [`ChannelMonitor`] has been fully persisted
+       /// to disk.
+       ///
        /// For details on asynchronous [`ChannelMonitor`] updating and returning
        /// [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
        fn release_pending_monitor_events(&self) -> Vec<MonitorEvent>;