From: Matt Corallo <git@bluematt.me>
Date: Thu, 28 Sep 2023 20:45:27 +0000 (+0000)
Subject: Add more details about async persistence completion/backgrounding
X-Git-Tag: v0.0.117-rc1~11^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=34dd48c585cacb5dd5d127964bcf6da7abff9692;p=rust-lightning

Add more details about async persistence completion/backgrounding

This clarifies somewhat that async persistence should run
indefinitely or keep trying via polling, and that either is
acceptable.
---

diff --git a/lightning/src/chain/chainmonitor.rs b/lightning/src/chain/chainmonitor.rs
index 60d50bf0a..6d003df72 100644
--- a/lightning/src/chain/chainmonitor.rs
+++ b/lightning/src/chain/chainmonitor.rs
@@ -113,7 +113,10 @@ impl MonitorUpdateId {
 ///  [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
 ///
 ///  If at some point no further progress can be made towards persisting a pending update, the node
-///  should simply shut down.
+///  should simply shut down. Until then, the background task should either loop indefinitely, or
+///  persistence should be regularly retried with [`ChainMonitor::list_pending_monitor_updates`]
+///  and [`ChainMonitor::get_monitor`] (note that if a full monitor is persisted all pending
+///  monitor updates may be marked completed).
 ///
 /// # Using remote watchtowers
 ///