Skip to content

Commit 84bc362

Browse files
committed
Doc Clarity: Persist ChannelMonitors and MonitorUpdates sequentially
Clarified in documentation that users must persist `ChannelMonitor`s and `ChannelMonitorUpdate`s in sequential order, even more so when using async persistence.
1 parent 5e41425 commit 84bc362

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

lightning/src/chain/chainmonitor.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,9 @@ impl MonitorUpdateId {
9393
/// Persistence can happen in one of two ways - synchronously completing before the trait method
9494
/// calls return or asynchronously in the background.
9595
///
96+
/// [`ChannelMonitor`]'s and [`ChannelMonitorUpdate`]'s must be persisted sequentially, in the
97+
/// order they are provided.
98+
///
9699
/// # For those implementing synchronous persistence
97100
///
98101
/// * If persistence completes fully (including any relevant `fsync()` calls), the implementation

0 commit comments

Comments
 (0)