Integrate Persist into ChainMonitor.
[rust-lightning] / lightning / src / chain / chainmonitor.rs
index 6c67f54f11a63b38d07c4da843870d5c48d2d372..469837f07ed6cf8f790bd4abe2315ed3d7f43b49 100644 (file)
@@ -34,7 +34,8 @@ use bitcoin::blockdata::block::BlockHeader;
 use chain;
 use chain::Filter;
 use chain::chaininterface::{BroadcasterInterface, FeeEstimator};
-use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateErr, MonitorEvent, MonitorUpdateError};
+use chain::channelmonitor;
+use chain::channelmonitor::{ChannelMonitor, ChannelMonitorUpdate, ChannelMonitorUpdateErr, MonitorEvent, Persist};
 use chain::transaction::{OutPoint, TransactionData};
 use chain::keysinterface::ChannelKeys;
 use util::logger::Logger;
@@ -55,25 +56,28 @@ use std::ops::Deref;
 /// [`chain::Watch`]: ../trait.Watch.html
 /// [`ChannelManager`]: ../../ln/channelmanager/struct.ChannelManager.html
 /// [module-level documentation]: index.html
-pub struct ChainMonitor<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref>
+pub struct ChainMonitor<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref>
        where C::Target: chain::Filter,
         T::Target: BroadcasterInterface,
         F::Target: FeeEstimator,
         L::Target: Logger,
+        P::Target: channelmonitor::Persist<ChanSigner>,
 {
        /// The monitors
        pub monitors: Mutex<HashMap<OutPoint, ChannelMonitor<ChanSigner>>>,
        chain_source: Option<C>,
        broadcaster: T,
        logger: L,
-       fee_estimator: F
+       fee_estimator: F,
+       persister: P,
 }
 
-impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref> ChainMonitor<ChanSigner, C, T, F, L>
-       where C::Target: chain::Filter,
-             T::Target: BroadcasterInterface,
-             F::Target: FeeEstimator,
-             L::Target: Logger,
+impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> ChainMonitor<ChanSigner, C, T, F, L, P>
+where C::Target: chain::Filter,
+           T::Target: BroadcasterInterface,
+           F::Target: FeeEstimator,
+           L::Target: Logger,
+           P::Target: channelmonitor::Persist<ChanSigner>,
 {
        /// Dispatches to per-channel monitors, which are responsible for updating their on-chain view
        /// of a channel and reacting accordingly based on transactions in the connected block. See
@@ -124,27 +128,47 @@ impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref> ChainMonit
        /// transactions relevant to the watched channels.
        ///
        /// [`chain::Filter`]: ../trait.Filter.html
-       pub fn new(chain_source: Option<C>, broadcaster: T, logger: L, feeest: F) -> Self {
+       pub fn new(chain_source: Option<C>, broadcaster: T, logger: L, feeest: F, persister: P) -> Self {
                Self {
                        monitors: Mutex::new(HashMap::new()),
                        chain_source,
                        broadcaster,
                        logger,
                        fee_estimator: feeest,
+                       persister,
                }
        }
+}
+
+impl<ChanSigner: ChannelKeys, C: Deref + Sync + Send, T: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send, P: Deref + Sync + Send> chain::Watch for ChainMonitor<ChanSigner, C, T, F, L, P>
+where C::Target: chain::Filter,
+           T::Target: BroadcasterInterface,
+           F::Target: FeeEstimator,
+           L::Target: Logger,
+           P::Target: channelmonitor::Persist<ChanSigner>,
+{
+       type Keys = ChanSigner;
 
        /// Adds the monitor that watches the channel referred to by the given outpoint.
        ///
        /// Calls back to [`chain::Filter`] with the funding transaction and outputs to watch.
        ///
+       /// Note that we persist the given `ChannelMonitor` while holding the `ChainMonitor`
+       /// monitors lock.
+       ///
        /// [`chain::Filter`]: ../trait.Filter.html
-       fn add_monitor(&self, outpoint: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), MonitorUpdateError> {
+       fn watch_channel(&self, funding_outpoint: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr> {
                let mut monitors = self.monitors.lock().unwrap();
-               let entry = match monitors.entry(outpoint) {
-                       hash_map::Entry::Occupied(_) => return Err(MonitorUpdateError("Channel monitor for given outpoint is already present")),
+               let entry = match monitors.entry(funding_outpoint) {
+                       hash_map::Entry::Occupied(_) => {
+                               log_error!(self.logger, "Failed to add new channel data: channel monitor for given outpoint is already present");
+                               return Err(ChannelMonitorUpdateErr::PermanentFailure)},
                        hash_map::Entry::Vacant(e) => e,
                };
+               if let Err(e) = self.persister.persist_new_channel(funding_outpoint, &monitor) {
+                       log_error!(self.logger, "Failed to persist new channel data");
+                       return Err(e);
+               }
                {
                        let funding_txo = monitor.get_funding_txo();
                        log_trace!(self.logger, "Got new Channel Monitor for channel {}", log_bytes!(funding_txo.0.to_channel_id()[..]));
@@ -162,38 +186,34 @@ impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref> ChainMonit
                Ok(())
        }
 
-       /// Updates the monitor that watches the channel referred to by the given outpoint.
-       fn update_monitor(&self, outpoint: OutPoint, update: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
+       /// Note that we persist the given `ChannelMonitor` update while holding the
+       /// `ChainMonitor` monitors lock.
+       fn update_channel(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> {
+               // Update the monitor that watches the channel referred to by the given outpoint.
                let mut monitors = self.monitors.lock().unwrap();
-               match monitors.get_mut(&outpoint) {
+               match monitors.get_mut(&funding_txo) {
+                       None => {
+                               log_error!(self.logger, "Failed to update channel monitor: no such monitor registered");
+                               Err(ChannelMonitorUpdateErr::PermanentFailure)
+                       },
                        Some(orig_monitor) => {
                                log_trace!(self.logger, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor));
-                               orig_monitor.update_monitor(update, &self.broadcaster, &self.logger)
-                       },
-                       None => Err(MonitorUpdateError("No such monitor registered"))
-               }
-       }
-}
-
-impl<ChanSigner: ChannelKeys, C: Deref + Sync + Send, T: Deref + Sync + Send, F: Deref + Sync + Send, L: Deref + Sync + Send> chain::Watch for ChainMonitor<ChanSigner, C, T, F, L>
-       where C::Target: chain::Filter,
-             T::Target: BroadcasterInterface,
-             F::Target: FeeEstimator,
-             L::Target: Logger,
-{
-       type Keys = ChanSigner;
-
-       fn watch_channel(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr> {
-               match self.add_monitor(funding_txo, monitor) {
-                       Ok(_) => Ok(()),
-                       Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
-               }
-       }
-
-       fn update_channel(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> {
-               match self.update_monitor(funding_txo, update) {
-                       Ok(_) => Ok(()),
-                       Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
+                               let update_res = orig_monitor.update_monitor(&update, &self.broadcaster, &self.logger);
+                               if let Err(e) = &update_res {
+                                       log_error!(self.logger, "Failed to update channel monitor: {:?}", e);
+                               }
+                               // Even if updating the monitor returns an error, the monitor's state will
+                               // still be changed. So, persist the updated monitor despite the error.
+                               let persist_res = self.persister.update_persisted_channel(funding_txo, &update, orig_monitor);
+                               if let Err(ref e) = persist_res {
+                                       log_error!(self.logger, "Failed to persist channel monitor update: {:?}", e);
+                               }
+                               if update_res.is_err() {
+                                       Err(ChannelMonitorUpdateErr::PermanentFailure)
+                               } else {
+                                       persist_res
+                               }
+                       }
                }
        }
 
@@ -206,11 +226,12 @@ impl<ChanSigner: ChannelKeys, C: Deref + Sync + Send, T: Deref + Sync + Send, F:
        }
 }
 
-impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref> events::EventsProvider for ChainMonitor<ChanSigner, C, T, F, L>
+impl<ChanSigner: ChannelKeys, C: Deref, T: Deref, F: Deref, L: Deref, P: Deref> events::EventsProvider for ChainMonitor<ChanSigner, C, T, F, L, P>
        where C::Target: chain::Filter,
              T::Target: BroadcasterInterface,
              F::Target: FeeEstimator,
              L::Target: Logger,
+             P::Target: channelmonitor::Persist<ChanSigner>,
 {
        fn get_and_clear_pending_events(&self) -> Vec<Event> {
                let mut pending_events = Vec::new();