Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document monitor archival idempotency requirement (#3276 followup) #3329

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions lightning/src/chain/chainmonitor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,13 @@ pub trait Persist<ChannelSigner: EcdsaChannelSigner> {
///
/// Archiving the data in a backup location (rather than deleting it fully) is useful for
/// hedging against data loss in case of unexpected failure.
///
/// Note that if a crash occurs during the archiving process, a state may emerge where the
/// monitor is copied to the archive path but isn't removed yet. In that scenario, the monitor
/// would still end up being loaded on startup pending successful archival completion.
/// Additionally, this scenario might see the monitor being written to the archive path twice,
/// which is why this method must be idempotent and be able to handle monitors already existing
/// in the archive directory.
fn archive_persisted_channel(&self, channel_funding_outpoint: OutPoint);
}

Expand Down
Loading