projects
/
rust-lightning
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (parent:
d22650c
)
Update docs for TemporaryFailure to note other use-cases
2019-03-temp-failure-use-cases
author
Matt Corallo
<git@bluematt.me>
Mon, 25 Mar 2019 21:26:32 +0000
(17:26 -0400)
committer
Matt Corallo
<git@bluematt.me>
Mon, 25 Mar 2019 21:27:04 +0000
(17:27 -0400)
src/ln/channelmonitor.rs
patch
|
blob
|
history
diff --git
a/src/ln/channelmonitor.rs
b/src/ln/channelmonitor.rs
index 8900b5078dc8b30c6fdd262ed0277f1f81e00266..a06d530a9a68e39e759fdb609c21c282088eff21 100644
(file)
--- a/
src/ln/channelmonitor.rs
+++ b/
src/ln/channelmonitor.rs
@@
-48,8
+48,8
@@
use std::{hash,cmp, mem};
/// An error enum representing a failure to persist a channel monitor update.
#[derive(Clone)]
pub enum ChannelMonitorUpdateErr {
/// An error enum representing a failure to persist a channel monitor update.
#[derive(Clone)]
pub enum ChannelMonitorUpdateErr {
- /// Used to indicate a temporary failure (eg connection to a watchtower
failed, but is expected
- /// to succeed at some point in the future).
+ /// Used to indicate a temporary failure (eg connection to a watchtower
or remote backup of
+ ///
our state failed, but is expected
to succeed at some point in the future).
///
/// Such a failure will "freeze" a channel, preventing us from revoking old states or
/// submitting new commitment transactions to the remote party.
///
/// Such a failure will "freeze" a channel, preventing us from revoking old states or
/// submitting new commitment transactions to the remote party.
@@
-71,6
+71,10
@@
pub enum ChannelMonitorUpdateErr {
/// Note that even if updates made after TemporaryFailure succeed you must still call
/// test_restore_channel_monitor to ensure you have the latest monitor and re-enable normal
/// channel operation.
/// Note that even if updates made after TemporaryFailure succeed you must still call
/// test_restore_channel_monitor to ensure you have the latest monitor and re-enable normal
/// channel operation.
+ ///
+ /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
+ /// remote location (with local copies persisted immediately), it is anticipated that all
+ /// updates will return TemporaryFailure until the remote copies could be updated.
TemporaryFailure,
/// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
/// different watchtower and cannot update with all watchtowers that were previously informed
TemporaryFailure,
/// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
/// different watchtower and cannot update with all watchtowers that were previously informed