mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 23:08:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #3329 from arik-so/monitor_archive_docs_followup

Browse source 
Document monitor archival idempotency requirement (#3276 followup)
This commit is contained in:
Gursharan Singh 2024-10-15 13:54:46 -07:00 • committed by GitHub
commit 0db051b75a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
lightning/src/chain/chainmonitor.rs
View file

@ -162,6 +162,13 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
/// ///
/// Archiving the data in a backup location (rather than deleting it fully) is useful for /// Archiving the data in a backup location (rather than deleting it fully) is useful for
/// hedging against data loss in case of unexpected failure. /// hedging against data loss in case of unexpected failure.
///
/// Note that if a crash occurs during the archiving process, and its implementation is not
/// atomic, a state may emerge with the archival operation only being partially complete. In
/// that scenario, the monitor may still be loaded on startup pending successful completion of
/// the archive process. Additionally, because the archive operation could be retried on
/// restart, this method must in that case be idempotent, ensuring it can handle scenarios where
/// the monitor already exists in the archive.
fn archive_persisted_channel(&self, channel_funding_outpoint: OutPoint); fn archive_persisted_channel(&self, channel_funding_outpoint: OutPoint);
} }