Expand comment on ChannelMonitorUpdateErr::PermanentFailure a bit
[rust-lightning] / src / ln / channelmonitor.rs
index 79900e328933740fc33e3c6dbc037677455bc642..48e5c002c34543b56648014033a209fa7a61d31c 100644 (file)
@@ -71,6 +71,8 @@ pub enum ChannelMonitorUpdateErr {
        /// 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
        /// of this channel). This will force-close the channel in question.
+       ///
+       /// Should also be used to indicate a failure to update the local copy of the channel monitor.
        PermanentFailure,
 }