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.
5 #![deny(broken_intra_doc_links)]
9 #[macro_use] extern crate lightning;
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::util::events::{EventHandler, EventsProvider};
20 use lightning::util::logger::Logger;
22 use std::sync::atomic::{AtomicBool, Ordering};
24 use std::thread::JoinHandle;
25 use std::time::{Duration, Instant};
28 /// BackgroundProcessor takes care of tasks that (1) need to happen periodically to keep
29 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
30 /// responsibilities are:
31 /// * Monitoring whether the ChannelManager needs to be re-persisted to disk, and if so,
32 /// writing it to disk/backups by invoking the callback given to it at startup.
33 /// ChannelManager persistence should be done in the background.
34 /// * Calling `ChannelManager::timer_tick_occurred()` and
35 /// `PeerManager::timer_tick_occurred()` every minute (can be done in the
38 /// Note that if ChannelManager persistence fails and the persisted manager becomes out-of-date,
39 /// then there is a risk of channels force-closing on startup when the manager realizes it's
40 /// outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used
41 /// for unilateral chain closure fees are at risk.
42 pub struct BackgroundProcessor {
43 stop_thread: Arc<AtomicBool>,
44 /// May be used to retrieve and handle the error if `BackgroundProcessor`'s thread
45 /// exits due to an error while persisting.
46 pub thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
50 const FRESHNESS_TIMER: u64 = 60;
52 const FRESHNESS_TIMER: u64 = 1;
54 /// Trait which handles persisting a [`ChannelManager`] to disk.
56 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
57 pub trait ChannelManagerPersister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
59 M::Target: 'static + chain::Watch<Signer>,
60 T::Target: 'static + BroadcasterInterface,
61 K::Target: 'static + KeysInterface<Signer = Signer>,
62 F::Target: 'static + FeeEstimator,
63 L::Target: 'static + Logger,
65 /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
66 /// (which will cause the [`BackgroundProcessor`] which called this method to exit.
68 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
69 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;
72 impl<Fun, Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
73 ChannelManagerPersister<Signer, M, T, K, F, L> for Fun where
74 M::Target: 'static + chain::Watch<Signer>,
75 T::Target: 'static + BroadcasterInterface,
76 K::Target: 'static + KeysInterface<Signer = Signer>,
77 F::Target: 'static + FeeEstimator,
78 L::Target: 'static + Logger,
79 Fun: Fn(&ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>,
81 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
86 impl BackgroundProcessor {
87 /// Start a background thread that takes care of responsibilities enumerated in the top-level
90 /// If `persist_manager` returns an error, then this thread will return said error (and
91 /// `start()` will need to be called again to restart the `BackgroundProcessor`). Users should
92 /// wait on [`thread_handle`]'s `join()` method to be able to tell if and when an error is
93 /// returned, or implement `persist_manager` such that an error is never returned to the
94 /// `BackgroundProcessor`
96 /// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
97 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
98 /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
99 /// provided implementation.
101 /// [`thread_handle`]: BackgroundProcessor::thread_handle
102 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
103 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
104 /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
106 Signer: 'static + Sign,
107 CF: 'static + Deref + Send + Sync,
108 CW: 'static + Deref + Send + Sync,
109 T: 'static + Deref + Send + Sync,
110 K: 'static + Deref + Send + Sync,
111 F: 'static + Deref + Send + Sync,
112 L: 'static + Deref + Send + Sync,
113 P: 'static + Deref + Send + Sync,
114 Descriptor: 'static + SocketDescriptor + Send + Sync,
115 CMH: 'static + Deref + Send + Sync,
116 RMH: 'static + Deref + Send + Sync,
117 EH: 'static + EventHandler + Send + Sync,
118 CMP: 'static + Send + ChannelManagerPersister<Signer, CW, T, K, F, L>,
119 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
120 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
121 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, L>> + Send + Sync,
123 (persister: CMP, event_handler: EH, chain_monitor: M, channel_manager: CM, peer_manager: PM, logger: L) -> Self
125 CF::Target: 'static + chain::Filter,
126 CW::Target: 'static + chain::Watch<Signer>,
127 T::Target: 'static + BroadcasterInterface,
128 K::Target: 'static + KeysInterface<Signer = Signer>,
129 F::Target: 'static + FeeEstimator,
130 L::Target: 'static + Logger,
131 P::Target: 'static + channelmonitor::Persist<Signer>,
132 CMH::Target: 'static + ChannelMessageHandler,
133 RMH::Target: 'static + RoutingMessageHandler,
135 let stop_thread = Arc::new(AtomicBool::new(false));
136 let stop_thread_clone = stop_thread.clone();
137 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
138 let mut current_time = Instant::now();
140 peer_manager.process_events();
141 channel_manager.process_pending_events(&event_handler);
142 chain_monitor.process_pending_events(&event_handler);
143 let updates_available =
144 channel_manager.await_persistable_update_timeout(Duration::from_millis(100));
145 if updates_available {
146 persister.persist_manager(&*channel_manager)?;
148 // Exit the loop if the background processor was requested to stop.
149 if stop_thread.load(Ordering::Acquire) == true {
150 log_trace!(logger, "Terminating background processor.");
153 if current_time.elapsed().as_secs() > FRESHNESS_TIMER {
154 log_trace!(logger, "Calling ChannelManager's and PeerManager's timer_tick_occurred");
155 channel_manager.timer_tick_occurred();
156 peer_manager.timer_tick_occurred();
157 current_time = Instant::now();
161 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
164 /// Stop `BackgroundProcessor`'s thread.
165 pub fn stop(mut self) -> Result<(), std::io::Error> {
166 assert!(self.thread_handle.is_some());
167 self.stop_and_join_thread()
170 fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
171 self.stop_thread.store(true, Ordering::Release);
172 match self.thread_handle.take() {
173 Some(handle) => handle.join().unwrap(),
179 impl Drop for BackgroundProcessor {
181 self.stop_and_join_thread().unwrap();
187 use bitcoin::blockdata::block::BlockHeader;
188 use bitcoin::blockdata::constants::genesis_block;
189 use bitcoin::blockdata::transaction::{Transaction, TxOut};
190 use bitcoin::network::constants::Network;
191 use lightning::chain::{BestBlock, Confirm, chainmonitor};
192 use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
193 use lightning::chain::keysinterface::{InMemorySigner, KeysInterface, KeysManager};
194 use lightning::chain::transaction::OutPoint;
195 use lightning::get_event_msg;
196 use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, ChannelManager, SimpleArcChannelManager};
197 use lightning::ln::features::InitFeatures;
198 use lightning::ln::msgs::ChannelMessageHandler;
199 use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor};
200 use lightning::util::config::UserConfig;
201 use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
202 use lightning::util::ser::Writeable;
203 use lightning::util::test_utils;
204 use lightning_persister::FilesystemPersister;
206 use std::path::PathBuf;
207 use std::sync::{Arc, Mutex};
208 use std::time::Duration;
209 use super::{BackgroundProcessor, FRESHNESS_TIMER};
211 const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
213 #[derive(Clone, Eq, Hash, PartialEq)]
214 struct TestDescriptor{}
215 impl SocketDescriptor for TestDescriptor {
216 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
220 fn disconnect_socket(&mut self) {}
223 type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
226 node: Arc<SimpleArcChannelManager<ChainMonitor, test_utils::TestBroadcaster, test_utils::TestFeeEstimator, test_utils::TestLogger>>,
227 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, Arc<test_utils::TestLogger>>>,
228 chain_monitor: Arc<ChainMonitor>,
229 persister: Arc<FilesystemPersister>,
230 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
231 logger: Arc<test_utils::TestLogger>,
232 best_block: BestBlock,
237 let data_dir = self.persister.get_data_dir();
238 match fs::remove_dir_all(data_dir.clone()) {
239 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
245 fn get_full_filepath(filepath: String, filename: String) -> String {
246 let mut path = PathBuf::from(filepath);
248 path.to_str().unwrap().to_string()
251 fn create_nodes(num_nodes: usize, persist_dir: String) -> Vec<Node> {
252 let mut nodes = Vec::new();
253 for i in 0..num_nodes {
254 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
255 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
256 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
257 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
258 let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
259 let seed = [i as u8; 32];
260 let network = Network::Testnet;
261 let now = Duration::from_secs(genesis_block(network).header.time as u64);
262 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
263 let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
264 let best_block = BestBlock::from_genesis(network);
265 let params = ChainParameters { network, best_block };
266 let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
267 let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new() )};
268 let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(), &seed, logger.clone()));
269 let node = Node { node: manager, peer_manager, chain_monitor, persister, tx_broadcaster, logger, best_block };
275 macro_rules! open_channel {
276 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
277 begin_open_channel!($node_a, $node_b, $channel_value);
278 let events = $node_a.node.get_and_clear_pending_events();
279 assert_eq!(events.len(), 1);
280 let (temporary_channel_id, tx) = handle_funding_generation_ready!(events[0], $channel_value);
281 end_open_channel!($node_a, $node_b, temporary_channel_id, tx);
286 macro_rules! begin_open_channel {
287 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
288 $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
289 $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()));
290 $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()));
294 macro_rules! handle_funding_generation_ready {
295 ($event: expr, $channel_value: expr) => {{
297 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
298 assert_eq!(*channel_value_satoshis, $channel_value);
299 assert_eq!(user_channel_id, 42);
301 let tx = Transaction { version: 1 as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
302 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
304 (*temporary_channel_id, tx)
306 _ => panic!("Unexpected event"),
311 macro_rules! end_open_channel {
312 ($node_a: expr, $node_b: expr, $temporary_channel_id: expr, $tx: expr) => {{
313 $node_a.node.funding_transaction_generated(&$temporary_channel_id, $tx.clone()).unwrap();
314 $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()));
315 $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()));
319 fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
321 let prev_blockhash = node.best_block.block_hash();
322 let height = node.best_block.height() + 1;
323 let header = BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: Default::default(), time: height, bits: 42, nonce: 42 };
324 let txdata = vec![(0, tx)];
325 node.best_block = BestBlock::new(header.block_hash(), height);
328 node.node.transactions_confirmed(&header, &txdata, height);
329 node.chain_monitor.transactions_confirmed(&header, &txdata, height);
332 node.node.best_block_updated(&header, height);
333 node.chain_monitor.best_block_updated(&header, height);
339 fn confirm_transaction(node: &mut Node, tx: &Transaction) {
340 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
344 fn test_background_processor() {
345 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
346 // updates. Also test that when new updates are available, the manager signals that it needs
347 // re-persistence and is successfully re-persisted.
348 let nodes = create_nodes(2, "test_background_processor".to_string());
350 // Go through the channel creation process so that each node has something to persist. Since
351 // open_channel consumes events, it must complete before starting BackgroundProcessor to
352 // avoid a race with processing events.
353 let tx = open_channel!(nodes[0], nodes[1], 100000);
355 // Initiate the background processors to watch each node.
356 let data_dir = nodes[0].persister.get_data_dir();
357 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);
358 let event_handler = |_| {};
359 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());
361 macro_rules! check_persisted_data {
362 ($node: expr, $filepath: expr, $expected_bytes: expr) => {
363 match $node.write(&mut $expected_bytes) {
366 match std::fs::read($filepath) {
368 if bytes == $expected_bytes {
378 Err(e) => panic!("Unexpected error: {}", e)
383 // Check that the initial channel manager data is persisted as expected.
384 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "manager".to_string());
385 let mut expected_bytes = Vec::new();
386 check_persisted_data!(nodes[0].node, filepath.clone(), expected_bytes);
388 if !nodes[0].node.get_persistence_condvar_value() { break }
391 // Force-close the channel.
392 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
394 // Check that the force-close updates are persisted.
395 let mut expected_bytes = Vec::new();
396 check_persisted_data!(nodes[0].node, filepath.clone(), expected_bytes);
398 if !nodes[0].node.get_persistence_condvar_value() { break }
401 assert!(bg_processor.stop().is_ok());
405 fn test_timer_tick_called() {
406 // Test that ChannelManager's and PeerManager's `timer_tick_occurred` is called every
407 // `FRESHNESS_TIMER`.
408 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
409 let data_dir = nodes[0].persister.get_data_dir();
410 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);
411 let event_handler = |_| {};
412 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());
414 let log_entries = nodes[0].logger.lines.lock().unwrap();
415 let desired_log = "Calling ChannelManager's and PeerManager's timer_tick_occurred".to_string();
416 if log_entries.get(&("lightning_background_processor".to_string(), desired_log)).is_some() {
421 assert!(bg_processor.stop().is_ok());
425 fn test_persist_error() {
426 // Test that if we encounter an error during manager persistence, the thread panics.
427 let nodes = create_nodes(2, "test_persist_error".to_string());
428 open_channel!(nodes[0], nodes[1], 100000);
430 let persister = |_: &_| Err(std::io::Error::new(std::io::ErrorKind::Other, "test"));
431 let event_handler = |_| {};
432 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());
433 match bg_processor.stop() {
434 Ok(_) => panic!("Expected error persisting manager"),
436 assert_eq!(e.kind(), std::io::ErrorKind::Other);
437 assert_eq!(e.get_ref().unwrap().to_string(), "test");
443 fn test_background_event_handling() {
444 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
445 let channel_value = 100000;
446 let data_dir = nodes[0].persister.get_data_dir();
447 let persister = move |node: &_| FilesystemPersister::persist_manager(data_dir.clone(), node);
449 // Set up a background event handler for FundingGenerationReady events.
450 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
451 let event_handler = move |event| {
452 sender.send(handle_funding_generation_ready!(event, channel_value)).unwrap();
454 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());
456 // Open a channel and check that the FundingGenerationReady event was handled.
457 begin_open_channel!(nodes[0], nodes[1], channel_value);
458 let (temporary_channel_id, funding_tx) = receiver
459 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
460 .expect("FundingGenerationReady not handled within deadline");
461 end_open_channel!(nodes[0], nodes[1], temporary_channel_id, funding_tx);
463 // Confirm the funding transaction.
464 confirm_transaction(&mut nodes[0], &funding_tx);
465 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id());
466 confirm_transaction(&mut nodes[1], &funding_tx);
467 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id());
468 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &bs_funding);
469 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
470 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding);
471 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
473 assert!(bg_processor.stop().is_ok());
475 // Set up a background event handler for SpendableOutputs events.
476 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
477 let event_handler = move |event| sender.send(event).unwrap();
478 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());
480 // Force close the channel and check that the SpendableOutputs event was handled.
481 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
482 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
483 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
485 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
486 .expect("SpendableOutputs not handled within deadline");
488 Event::SpendableOutputs { .. } => {},
489 _ => panic!("Unexpected event: {:?}", event),
492 assert!(bg_processor.stop().is_ok());