From: Matt Corallo <649246+TheBlueMatt@users.noreply.github.com>
Date: Tue, 26 Mar 2019 15:58:55 +0000 (-0400)
Subject: Merge pull request #329 from dongcarl/patch-1
X-Git-Tag: v0.0.12~217
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=f5a572926f03ebde71ab8da04405a82a50779cd4;hp=a58e2ba098230e27e43ecdfcb5517fed18ad8106;p=rust-lightning

Merge pull request #329 from dongcarl/patch-1

Improve README usability
---

diff --git a/src/ln/channelmonitor.rs b/src/ln/channelmonitor.rs
index ac03b7bb8..25f41d882 100644
--- 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 {
-	/// 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.
@@ -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.
+	///
+	/// 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