_ Git - rust-lightning/blob - lightning-background-processor/src/lib.rs

   1 //! Utilities that take care of tasks that (1) need to happen periodically to keep Rust-Lightning
   2 //! running properly, and (2) either can or should be run in the background. See docs for
   3 //! [`BackgroundProcessor`] for more details on the nitty-gritty.
   4
   5 #![deny(broken_intra_doc_links)]
   6 #![deny(missing_docs)]
   7 #![deny(unsafe_code)]
   8
   9 #[macro_use] extern crate lightning;
  10
  11 use lightning::chain;
  12 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
  13 use lightning::chain::chainmonitor::ChainMonitor;
  14 use lightning::chain::channelmonitor;
  15 use lightning::chain::keysinterface::{Sign, KeysInterface};
  16 use lightning::ln::channelmanager::ChannelManager;
  17 use lightning::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
  18 use lightning::ln::peer_handler::{PeerManager, SocketDescriptor};
  19 use lightning::ln::peer_handler::CustomMessageHandler;
  20 use lightning::util::events::{EventHandler, EventsProvider};
  21 use lightning::util::logger::Logger;
  22 use std::sync::Arc;
  23 use std::sync::atomic::{AtomicBool, Ordering};
  24 use std::thread;
  25 use std::thread::JoinHandle;
  26 use std::time::{Duration, Instant};
  27 use std::ops::Deref;
  28
  29 /// BackgroundProcessor takes care of tasks that (1) need to happen periodically to keep
  30 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
  31 /// responsibilities are:
  32 /// * Monitoring whether the ChannelManager needs to be re-persisted to disk, and if so,
  33 ///   writing it to disk/backups by invoking the callback given to it at startup.
  34 ///   ChannelManager persistence should be done in the background.
  35 /// * Calling `ChannelManager::timer_tick_occurred()` and
  36 ///   `PeerManager::timer_tick_occurred()` every minute (can be done in the
  37 ///   background).
  38 ///
  39 /// Note that if ChannelManager persistence fails and the persisted manager becomes out-of-date,
  40 /// then there is a risk of channels force-closing on startup when the manager realizes it's
  41 /// outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used
  42 /// for unilateral chain closure fees are at risk.
  43 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
  44 pub struct BackgroundProcessor {
  45         stop_thread: Arc<AtomicBool>,
  46         thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
  47 }
  48
  49 #[cfg(not(test))]
  50 const FRESHNESS_TIMER: u64 = 60;
  51 #[cfg(test)]
  52 const FRESHNESS_TIMER: u64 = 1;
  53
  54 const PING_TIMER: u64 = 5;
  55
  56 /// Trait which handles persisting a [`ChannelManager`] to disk.
  57 ///
  58 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  59 pub trait ChannelManagerPersister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
  60 where
  61         M::Target: 'static + chain::Watch<Signer>,
  62         T::Target: 'static + BroadcasterInterface,
  63         K::Target: 'static + KeysInterface<Signer = Signer>,
  64         F::Target: 'static + FeeEstimator,
  65         L::Target: 'static + Logger,
  66 {
  67         /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
  68         /// (which will cause the [`BackgroundProcessor`] which called this method to exit.
  69         ///
  70         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  71         fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;
  72 }
  73
  74 impl<Fun, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
  75 ChannelManagerPersister<Signer, M, T, K, F, L> for Fun where
  76         M::Target: 'static + chain::Watch<Signer>,
  77         T::Target: 'static + BroadcasterInterface,
  78         K::Target: 'static + KeysInterface<Signer = Signer>,
  79         F::Target: 'static + FeeEstimator,
  80         L::Target: 'static + Logger,
  81         Fun: Fn(&ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>,
  82 {
  83         fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
  84                 self(channel_manager)
  85         }
  86 }
  87
  88 impl BackgroundProcessor {
  89         /// Start a background thread that takes care of responsibilities enumerated in the [top-level
  90         /// documentation].
  91         ///
  92         /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
  93         /// `persist_manager` returns an error. In case of an error, the error is retrieved by calling
  94         /// either [`join`] or [`stop`].
  95         ///
  96         /// Typically, users should either implement [`ChannelManagerPersister`] to never return an
  97         /// error or call [`join`] and handle any error that may arise. For the latter case, the
  98         /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
  99         ///
 100         /// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
 101         /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 102         /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
 103         /// provided implementation.
 104         ///
 105         /// [top-level documentation]: Self
 106         /// [`join`]: Self::join
 107         /// [`stop`]: Self::stop
 108         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 109         /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
 110         /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
 111         pub fn start<
 112                 Signer: 'static + Sign,
 113                 CF: 'static + Deref + Send + Sync,
 114                 CW: 'static + Deref + Send + Sync,
 115                 T: 'static + Deref + Send + Sync,
 116                 K: 'static + Deref + Send + Sync,
 117                 F: 'static + Deref + Send + Sync,
 118                 L: 'static + Deref + Send + Sync,
 119                 P: 'static + Deref + Send + Sync,
 120                 Descriptor: 'static + SocketDescriptor + Send + Sync,
 121                 CMH: 'static + Deref + Send + Sync,
 122                 RMH: 'static + Deref + Send + Sync,
 123                 EH: 'static + EventHandler + Send + Sync,
 124                 CMP: 'static + Send + ChannelManagerPersister<Signer, CW, T, K, F, L>,
 125                 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
 126                 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
 127                 UMH: 'static + Deref + Send + Sync,
 128                 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, L, UMH>> + Send + Sync,
 129         >
 130         (persister: CMP, event_handler: EH, chain_monitor: M, channel_manager: CM, peer_manager: PM, logger: L) -> Self
 131         where
 132                 CF::Target: 'static + chain::Filter,
 133                 CW::Target: 'static + chain::Watch<Signer>,
 134                 T::Target: 'static + BroadcasterInterface,
 135                 K::Target: 'static + KeysInterface<Signer = Signer>,
 136                 F::Target: 'static + FeeEstimator,
 137                 L::Target: 'static + Logger,
 138                 P::Target: 'static + channelmonitor::Persist<Signer>,
 139                 CMH::Target: 'static + ChannelMessageHandler,
 140                 RMH::Target: 'static + RoutingMessageHandler,
 141                 UMH::Target: 'static + CustomMessageHandler,
 142         {
 143                 let stop_thread = Arc::new(AtomicBool::new(false));
 144                 let stop_thread_clone = stop_thread.clone();
 145                 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 146                         log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
 147                         channel_manager.timer_tick_occurred();
 148
 149                         let mut last_freshness_call = Instant::now();
 150                         let mut last_ping_call = Instant::now();
 151                         loop {
 152                                 peer_manager.process_events();
 153                                 channel_manager.process_pending_events(&event_handler);
 154                                 chain_monitor.process_pending_events(&event_handler);
 155                                 let updates_available =
 156                                         channel_manager.await_persistable_update_timeout(Duration::from_millis(100));
 157                                 if updates_available {
 158                                         persister.persist_manager(&*channel_manager)?;
 159                                 }
 160                                 // Exit the loop if the background processor was requested to stop.
 161                                 if stop_thread.load(Ordering::Acquire) == true {
 162                                         log_trace!(logger, "Terminating background processor.");
 163                                         return Ok(());
 164                                 }
 165                                 if last_freshness_call.elapsed().as_secs() > FRESHNESS_TIMER {
 166                                         log_trace!(logger, "Calling ChannelManager's timer_tick_occurred");
 167                                         channel_manager.timer_tick_occurred();
 168                                         last_freshness_call = Instant::now();
 169                                 }
 170                                 if last_ping_call.elapsed().as_secs() > PING_TIMER * 2 {
 171                                         // On various platforms, we may be starved of CPU cycles for several reasons.
 172                                         // E.g. on iOS, if we've been in the background, we will be entirely paused.
 173                                         // Similarly, if we're on a desktop platform and the device has been asleep, we
 174                                         // may not get any cycles.
 175                                         // In any case, if we've been entirely paused for more than double our ping
 176                                         // timer, we should have disconnected all sockets by now (and they're probably
 177                                         // dead anyway), so disconnect them by calling `timer_tick_occurred()` twice.
 178                                         log_trace!(logger, "Awoke after more than double our ping timer, disconnecting peers.");
 179                                         peer_manager.timer_tick_occurred();
 180                                         peer_manager.timer_tick_occurred();
 181                                         last_ping_call = Instant::now();
 182                                 } else if last_ping_call.elapsed().as_secs() > PING_TIMER {
 183                                         log_trace!(logger, "Calling PeerManager's timer_tick_occurred");
 184                                         peer_manager.timer_tick_occurred();
 185                                         last_ping_call = Instant::now();
 186                                 }
 187                         }
 188                 });
 189                 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
 190         }
 191
 192         /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 193         /// [`ChannelManager`].
 194         ///
 195         /// # Panics
 196         ///
 197         /// This function panics if the background thread has panicked such as while persisting or
 198         /// handling events.
 199         ///
 200         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 201         pub fn join(mut self) -> Result<(), std::io::Error> {
 202                 assert!(self.thread_handle.is_some());
 203                 self.join_thread()
 204         }
 205
 206         /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 207         /// [`ChannelManager`].
 208         ///
 209         /// # Panics
 210         ///
 211         /// This function panics if the background thread has panicked such as while persisting or
 212         /// handling events.
 213         ///
 214         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 215         pub fn stop(mut self) -> Result<(), std::io::Error> {
 216                 assert!(self.thread_handle.is_some());
 217                 self.stop_and_join_thread()
 218         }
 219
 220         fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
 221                 self.stop_thread.store(true, Ordering::Release);
 222                 self.join_thread()
 223         }
 224
 225         fn join_thread(&mut self) -> Result<(), std::io::Error> {
 226                 match self.thread_handle.take() {
 227                         Some(handle) => handle.join().unwrap(),
 228                         None => Ok(()),
 229                 }
 230         }
 231 }
 232
 233 impl Drop for BackgroundProcessor {
 234         fn drop(&mut self) {
 235                 self.stop_and_join_thread().unwrap();
 236         }
 237 }
 238
 239 #[cfg(test)]
 240 mod tests {
 241         use bitcoin::blockdata::block::BlockHeader;
 242         use bitcoin::blockdata::constants::genesis_block;
 243         use bitcoin::blockdata::transaction::{Transaction, TxOut};
 244         use bitcoin::network::constants::Network;
 245         use lightning::chain::{BestBlock, Confirm, chainmonitor};
 246         use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
 247         use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
 248         use lightning::chain::transaction::OutPoint;
 249         use lightning::get_event_msg;
 250         use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, ChannelManager, SimpleArcChannelManager};
 251         use lightning::ln::features::InitFeatures;
 252         use lightning::ln::msgs::{ChannelMessageHandler, Init};
 253         use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
 254         use lightning::util::config::UserConfig;
 255         use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
 256         use lightning::util::ser::Writeable;
 257         use lightning::util::test_utils;
 258         use lightning_persister::FilesystemPersister;
 259         use std::fs;
 260         use std::path::PathBuf;
 261         use std::sync::{Arc, Mutex};
 262         use std::time::Duration;
 263         use super::{BackgroundProcessor, FRESHNESS_TIMER};
 264
 265         const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
 266
 267         #[derive(Clone, Eq, Hash, PartialEq)]
 268         struct TestDescriptor{}
 269         impl SocketDescriptor for TestDescriptor {
 270                 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
 271                         0
 272                 }
 273
 274                 fn disconnect_socket(&mut self) {}
 275         }
 276
 277         type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
 278
 279         struct Node {
 280                 node: Arc<SimpleArcChannelManager<ChainMonitor, test_utils::TestBroadcaster, test_utils::TestFeeEstimator, test_utils::TestLogger>>,
 281                 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, Arc<test_utils::TestLogger>, IgnoringMessageHandler>>,
 282                 chain_monitor: Arc<ChainMonitor>,
 283                 persister: Arc<FilesystemPersister>,
 284                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
 285                 logger: Arc<test_utils::TestLogger>,
 286                 best_block: BestBlock,
 287         }
 288
 289         impl Drop for Node {
 290                 fn drop(&mut self) {
 291                         let data_dir = self.persister.get_data_dir();
 292                         match fs::remove_dir_all(data_dir.clone()) {
 293                                 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
 294                                 _ => {}
 295                         }
 296                 }
 297         }
 298
 299         fn get_full_filepath(filepath: String, filename: String) -> String {
 300                 let mut path = PathBuf::from(filepath);
 301                 path.push(filename);
 302                 path.to_str().unwrap().to_string()
 303         }
 304
 305         fn create_nodes(num_nodes: usize, persist_dir: String) -> Vec<Node> {
 306                 let mut nodes = Vec::new();
 307                 for i in 0..num_nodes {
 308                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
 309                         let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
 310                         let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
 311                         let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
 312                         let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
 313                         let seed = [i as u8; 32];
 314                         let network = Network::Testnet;
 315                         let now = Duration::from_secs(genesis_block(network).header.time as u64);
 316                         let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
 317                         let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
 318                         let best_block = BestBlock::from_genesis(network);
 319                         let params = ChainParameters { network, best_block };
 320                         let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
 321                         let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new() )};
 322                         let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(), &seed, logger.clone(), IgnoringMessageHandler{}));
 323                         let node = Node { node: manager, peer_manager, chain_monitor, persister, tx_broadcaster, logger, best_block };
 324                         nodes.push(node);
 325                 }
 326
 327                 for i in 0..num_nodes {
 328                         for j in (i+1)..num_nodes {
 329                                 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &Init { features: InitFeatures::known() });
 330                                 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &Init { features: InitFeatures::known() });
 331                         }
 332                 }
 333
 334                 nodes
 335         }
 336
 337         macro_rules! open_channel {
 338                 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
 339                         begin_open_channel!($node_a, $node_b, $channel_value);
 340                         let events = $node_a.node.get_and_clear_pending_events();
 341                         assert_eq!(events.len(), 1);
 342                         let (temporary_channel_id, tx) = handle_funding_generation_ready!(events[0], $channel_value);
 343                         end_open_channel!($node_a, $node_b, temporary_channel_id, tx);
 344                         tx
 345                 }}
 346         }
 347
 348         macro_rules! begin_open_channel {
 349                 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
 350                         $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
 351                         $node_b.node.handle_open_channel(&$node_a.node.get_our_node_id(), InitFeatures::known(), &get_event_msg!($node_a, MessageSendEvent::SendOpenChannel, $node_b.node.get_our_node_id()));
 352                         $node_a.node.handle_accept_channel(&$node_b.node.get_our_node_id(), InitFeatures::known(), &get_event_msg!($node_b, MessageSendEvent::SendAcceptChannel, $node_a.node.get_our_node_id()));
 353                 }}
 354         }
 355
 356         macro_rules! handle_funding_generation_ready {
 357                 ($event: expr, $channel_value: expr) => {{
 358                         match $event {
 359                                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 360                                         assert_eq!(*channel_value_satoshis, $channel_value);
 361                                         assert_eq!(user_channel_id, 42);
 362
 363                                         let tx = Transaction { version: 1 as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 364                                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 365                                         }]};
 366                                         (*temporary_channel_id, tx)
 367                                 },
 368                                 _ => panic!("Unexpected event"),
 369                         }
 370                 }}
 371         }
 372
 373         macro_rules! end_open_channel {
 374                 ($node_a: expr, $node_b: expr, $temporary_channel_id: expr, $tx: expr) => {{
 375                         $node_a.node.funding_transaction_generated(&$temporary_channel_id, $tx.clone()).unwrap();
 376                         $node_b.node.handle_funding_created(&$node_a.node.get_our_node_id(), &get_event_msg!($node_a, MessageSendEvent::SendFundingCreated, $node_b.node.get_our_node_id()));
 377                         $node_a.node.handle_funding_signed(&$node_b.node.get_our_node_id(), &get_event_msg!($node_b, MessageSendEvent::SendFundingSigned, $node_a.node.get_our_node_id()));
 378                 }}
 379         }
 380
 381         fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
 382                 for i in 1..=depth {
 383                         let prev_blockhash = node.best_block.block_hash();
 384                         let height = node.best_block.height() + 1;
 385                         let header = BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: Default::default(), time: height, bits: 42, nonce: 42 };
 386                         let txdata = vec![(0, tx)];
 387                         node.best_block = BestBlock::new(header.block_hash(), height);
 388                         match i {
 389                                 1 => {
 390                                         node.node.transactions_confirmed(&header, &txdata, height);
 391                                         node.chain_monitor.transactions_confirmed(&header, &txdata, height);
 392                                 },
 393                                 x if x == depth => {
 394                                         node.node.best_block_updated(&header, height);
 395                                         node.chain_monitor.best_block_updated(&header, height);
 396                                 },
 397                                 _ => {},
 398                         }
 399                 }
 400         }
 401         fn confirm_transaction(node: &mut Node, tx: &Transaction) {
 402                 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
 403         }
 404
 405         #[test]
 406         fn test_background_processor() {
 407                 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
 408                 // updates. Also test that when new updates are available, the manager signals that it needs
 409                 // re-persistence and is successfully re-persisted.
 410                 let nodes = create_nodes(2, "test_background_processor".to_string());
 411
 412                 // Go through the channel creation process so that each node has something to persist. Since
 413                 // open_channel consumes events, it must complete before starting BackgroundProcessor to
 414                 // avoid a race with processing events.
 415                 let tx = open_channel!(nodes[0], nodes[1], 100000);
 416
 417                 // Initiate the background processors to watch each node.
 418                 let data_dir = nodes[0].persister.get_data_dir();
 419                 let persister = move |node: &ChannelManager<InMemorySigner, Arc<ChainMonitor>, Arc<test_utils::TestBroadcaster>, Arc<KeysManager>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>>| FilesystemPersister::persist_manager(data_dir.clone(), node);
 420                 let event_handler = |_| {};
 421                 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 422
 423                 macro_rules! check_persisted_data {
 424                         ($node: expr, $filepath: expr, $expected_bytes: expr) => {
 425                                 match $node.write(&mut $expected_bytes) {
 426                                         Ok(()) => {
 427                                                 loop {
 428                                                         match std::fs::read($filepath) {
 429                                                                 Ok(bytes) => {
 430                                                                         if bytes == $expected_bytes {
 431                                                                                 break
 432                                                                         } else {
 433                                                                                 continue
 434                                                                         }
 435                                                                 },
 436                                                                 Err(_) => continue
 437                                                         }
 438                                                 }
 439                                         },
 440                                         Err(e) => panic!("Unexpected error: {}", e)
 441                                 }
 442                         }
 443                 }
 444
 445                 // Check that the initial channel manager data is persisted as expected.
 446                 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "manager".to_string());
 447                 let mut expected_bytes = Vec::new();
 448                 check_persisted_data!(nodes[0].node, filepath.clone(), expected_bytes);
 449                 loop {
 450                         if !nodes[0].node.get_persistence_condvar_value() { break }
 451                 }
 452
 453                 // Force-close the channel.
 454                 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 455
 456                 // Check that the force-close updates are persisted.
 457                 let mut expected_bytes = Vec::new();
 458                 check_persisted_data!(nodes[0].node, filepath.clone(), expected_bytes);
 459                 loop {
 460                         if !nodes[0].node.get_persistence_condvar_value() { break }
 461                 }
 462
 463                 assert!(bg_processor.stop().is_ok());
 464         }
 465
 466         #[test]
 467         fn test_timer_tick_called() {
 468                 // Test that ChannelManager's and PeerManager's `timer_tick_occurred` is called every
 469                 // `FRESHNESS_TIMER`.
 470                 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
 471                 let data_dir = nodes[0].persister.get_data_dir();
 472                 let persister = move |node: &ChannelManager<InMemorySigner, Arc<ChainMonitor>, Arc<test_utils::TestBroadcaster>, Arc<KeysManager>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>>| FilesystemPersister::persist_manager(data_dir.clone(), node);
 473                 let event_handler = |_| {};
 474                 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 475                 loop {
 476                         let log_entries = nodes[0].logger.lines.lock().unwrap();
 477                         let desired_log = "Calling ChannelManager's timer_tick_occurred".to_string();
 478                         let second_desired_log = "Calling PeerManager's timer_tick_occurred".to_string();
 479                         if log_entries.get(&("lightning_background_processor".to_string(), desired_log)).is_some() &&
 480                                         log_entries.get(&("lightning_background_processor".to_string(), second_desired_log)).is_some() {
 481                                 break
 482                         }
 483                 }
 484
 485                 assert!(bg_processor.stop().is_ok());
 486         }
 487
 488         #[test]
 489         fn test_persist_error() {
 490                 // Test that if we encounter an error during manager persistence, the thread panics.
 491                 let nodes = create_nodes(2, "test_persist_error".to_string());
 492                 open_channel!(nodes[0], nodes[1], 100000);
 493
 494                 let persister = |_: &_| Err(std::io::Error::new(std::io::ErrorKind::Other, "test"));
 495                 let event_handler = |_| {};
 496                 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 497                 match bg_processor.join() {
 498                         Ok(_) => panic!("Expected error persisting manager"),
 499                         Err(e) => {
 500                                 assert_eq!(e.kind(), std::io::ErrorKind::Other);
 501                                 assert_eq!(e.get_ref().unwrap().to_string(), "test");
 502                         },
 503                 }
 504         }
 505
 506         #[test]
 507         fn test_background_event_handling() {
 508                 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
 509                 let channel_value = 100000;
 510                 let data_dir = nodes[0].persister.get_data_dir();
 511                 let persister = move |node: &_| FilesystemPersister::persist_manager(data_dir.clone(), node);
 512
 513                 // Set up a background event handler for FundingGenerationReady events.
 514                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 515                 let event_handler = move |event| {
 516                         sender.send(handle_funding_generation_ready!(event, channel_value)).unwrap();
 517                 };
 518                 let bg_processor = BackgroundProcessor::start(persister.clone(), event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 519
 520                 // Open a channel and check that the FundingGenerationReady event was handled.
 521                 begin_open_channel!(nodes[0], nodes[1], channel_value);
 522                 let (temporary_channel_id, funding_tx) = receiver
 523                         .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
 524                         .expect("FundingGenerationReady not handled within deadline");
 525                 end_open_channel!(nodes[0], nodes[1], temporary_channel_id, funding_tx);
 526
 527                 // Confirm the funding transaction.
 528                 confirm_transaction(&mut nodes[0], &funding_tx);
 529                 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id());
 530                 confirm_transaction(&mut nodes[1], &funding_tx);
 531                 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id());
 532                 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &bs_funding);
 533                 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
 534                 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding);
 535                 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
 536
 537                 assert!(bg_processor.stop().is_ok());
 538
 539                 // Set up a background event handler for SpendableOutputs events.
 540                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
 541                 let event_handler = move |event| sender.send(event).unwrap();
 542                 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
 543
 544                 // Force close the channel and check that the SpendableOutputs event was handled.
 545                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
 546                 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
 547                 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
 548                 let event = receiver
 549                         .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
 550                         .expect("SpendableOutputs not handled within deadline");
 551                 match event {
 552                         Event::SpendableOutputs { .. } => {},
 553                         _ => panic!("Unexpected event: {:?}", event),
 554                 }
 555
 556                 assert!(bg_processor.stop().is_ok());
 557         }
 558 }