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 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
11 #[macro_use] extern crate lightning;
14 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
15 use lightning::chain::chainmonitor::{ChainMonitor, Persist};
16 use lightning::chain::keysinterface::{Sign, KeysInterface};
17 use lightning::ln::channelmanager::ChannelManager;
18 use lightning::ln::msgs::{ChannelMessageHandler, RoutingMessageHandler};
19 use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescriptor};
20 use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
21 use lightning::util::events::{Event, EventHandler, EventsProvider};
22 use lightning::util::logger::Logger;
23 use lightning::util::persist::Persister;
25 use std::sync::atomic::{AtomicBool, Ordering};
27 use std::thread::JoinHandle;
28 use std::time::{Duration, Instant};
31 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
32 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
33 /// responsibilities are:
34 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
35 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
36 /// writing it to disk/backups by invoking the callback given to it at startup.
37 /// [`ChannelManager`] persistence should be done in the background.
38 /// * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
39 /// at the appropriate intervals.
40 /// * Calling [`NetworkGraph::remove_stale_channels`] (if a [`NetGraphMsgHandler`] is provided to
41 /// [`BackgroundProcessor::start`]).
43 /// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
44 /// upon as doing so may result in high latency.
48 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
49 /// there is a risk of channels force-closing on startup when the manager realizes it's outdated.
50 /// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
51 /// unilateral chain closure fees are at risk.
53 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
54 /// [`Event`]: lightning::util::events::Event
55 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
56 pub struct BackgroundProcessor {
57 stop_thread: Arc<AtomicBool>,
58 thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
62 const FRESHNESS_TIMER: u64 = 60;
64 const FRESHNESS_TIMER: u64 = 1;
66 #[cfg(all(not(test), not(debug_assertions)))]
67 const PING_TIMER: u64 = 10;
68 /// Signature operations take a lot longer without compiler optimisations.
69 /// Increasing the ping timer allows for this but slower devices will be disconnected if the
70 /// timeout is reached.
71 #[cfg(all(not(test), debug_assertions))]
72 const PING_TIMER: u64 = 30;
74 const PING_TIMER: u64 = 1;
76 /// Prune the network graph of stale entries hourly.
77 const NETWORK_PRUNE_TIMER: u64 = 60 * 60;
80 const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
82 const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;
85 /// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
86 struct DecoratingEventHandler<
88 N: Deref<Target = NetGraphMsgHandler<G, A, L>>,
89 G: Deref<Target = NetworkGraph>,
93 where A::Target: chain::Access, L::Target: Logger {
95 net_graph_msg_handler: Option<N>,
100 N: Deref<Target = NetGraphMsgHandler<G, A, L>>,
101 G: Deref<Target = NetworkGraph>,
104 > EventHandler for DecoratingEventHandler<E, N, G, A, L>
105 where A::Target: chain::Access, L::Target: Logger {
106 fn handle_event(&self, event: &Event) {
107 if let Some(event_handler) = &self.net_graph_msg_handler {
108 event_handler.handle_event(event);
110 self.event_handler.handle_event(event);
114 impl BackgroundProcessor {
115 /// Start a background thread that takes care of responsibilities enumerated in the [top-level
118 /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
119 /// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
120 /// either [`join`] or [`stop`].
122 /// # Data Persistence
124 /// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
125 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
126 /// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
127 /// provided implementation.
129 /// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
130 /// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See the `lightning-persister` crate
131 /// for LDK's provided implementation.
133 /// Typically, users should either implement [`Persister::persist_manager`] to never return an
134 /// error or call [`join`] and handle any error that may arise. For the latter case,
135 /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
139 /// `event_handler` is responsible for handling events that users should be notified of (e.g.,
140 /// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
141 /// functionality implemented by other handlers.
142 /// * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
144 /// [top-level documentation]: BackgroundProcessor
145 /// [`join`]: Self::join
146 /// [`stop`]: Self::stop
147 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
148 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
149 /// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
150 /// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
151 /// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
152 /// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
154 Signer: 'static + Sign,
155 CA: 'static + Deref + Send + Sync,
156 CF: 'static + Deref + Send + Sync,
157 CW: 'static + Deref + Send + Sync,
158 T: 'static + Deref + Send + Sync,
159 K: 'static + Deref + Send + Sync,
160 F: 'static + Deref + Send + Sync,
161 G: 'static + Deref<Target = NetworkGraph> + Send + Sync,
162 L: 'static + Deref + Send + Sync,
163 P: 'static + Deref + Send + Sync,
164 Descriptor: 'static + SocketDescriptor + Send + Sync,
165 CMH: 'static + Deref + Send + Sync,
166 RMH: 'static + Deref + Send + Sync,
167 EH: 'static + EventHandler + Send,
168 PS: 'static + Deref + Send,
169 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
170 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
171 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
172 UMH: 'static + Deref + Send + Sync,
173 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, L, UMH>> + Send + Sync,
175 persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
176 net_graph_msg_handler: Option<NG>, peer_manager: PM, logger: L
179 CA::Target: 'static + chain::Access,
180 CF::Target: 'static + chain::Filter,
181 CW::Target: 'static + chain::Watch<Signer>,
182 T::Target: 'static + BroadcasterInterface,
183 K::Target: 'static + KeysInterface<Signer = Signer>,
184 F::Target: 'static + FeeEstimator,
185 L::Target: 'static + Logger,
186 P::Target: 'static + Persist<Signer>,
187 CMH::Target: 'static + ChannelMessageHandler,
188 RMH::Target: 'static + RoutingMessageHandler,
189 UMH::Target: 'static + CustomMessageHandler,
190 PS::Target: 'static + Persister<Signer, CW, T, K, F, L>
192 let stop_thread = Arc::new(AtomicBool::new(false));
193 let stop_thread_clone = stop_thread.clone();
194 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
195 let event_handler = DecoratingEventHandler { event_handler, net_graph_msg_handler: net_graph_msg_handler.as_ref().map(|t| t.deref()) };
197 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
198 channel_manager.timer_tick_occurred();
200 let mut last_freshness_call = Instant::now();
201 let mut last_ping_call = Instant::now();
202 let mut last_prune_call = Instant::now();
203 let mut have_pruned = false;
206 peer_manager.process_events(); // Note that this may block on ChannelManager's locking
207 channel_manager.process_pending_events(&event_handler);
208 chain_monitor.process_pending_events(&event_handler);
210 // We wait up to 100ms, but track how long it takes to detect being put to sleep,
211 // see `await_start`'s use below.
212 let await_start = Instant::now();
213 let updates_available =
214 channel_manager.await_persistable_update_timeout(Duration::from_millis(100));
215 let await_time = await_start.elapsed();
217 if updates_available {
218 log_trace!(logger, "Persisting ChannelManager...");
219 persister.persist_manager(&*channel_manager)?;
220 log_trace!(logger, "Done persisting ChannelManager.");
222 // Exit the loop if the background processor was requested to stop.
223 if stop_thread.load(Ordering::Acquire) == true {
224 log_trace!(logger, "Terminating background processor.");
227 if last_freshness_call.elapsed().as_secs() > FRESHNESS_TIMER {
228 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred");
229 channel_manager.timer_tick_occurred();
230 last_freshness_call = Instant::now();
232 if await_time > Duration::from_secs(1) {
233 // On various platforms, we may be starved of CPU cycles for several reasons.
234 // E.g. on iOS, if we've been in the background, we will be entirely paused.
235 // Similarly, if we're on a desktop platform and the device has been asleep, we
236 // may not get any cycles.
237 // We detect this by checking if our max-100ms-sleep, above, ran longer than a
238 // full second, at which point we assume sockets may have been killed (they
239 // appear to be at least on some platforms, even if it has only been a second).
240 // Note that we have to take care to not get here just because user event
241 // processing was slow at the top of the loop. For example, the sample client
242 // may call Bitcoin Core RPCs during event handling, which very often takes
243 // more than a handful of seconds to complete, and shouldn't disconnect all our
245 log_trace!(logger, "100ms sleep took more than a second, disconnecting peers.");
246 peer_manager.disconnect_all_peers();
247 last_ping_call = Instant::now();
248 } else if last_ping_call.elapsed().as_secs() > PING_TIMER {
249 log_trace!(logger, "Calling PeerManager's timer_tick_occurred");
250 peer_manager.timer_tick_occurred();
251 last_ping_call = Instant::now();
254 // Note that we want to run a graph prune once not long after startup before
255 // falling back to our usual hourly prunes. This avoids short-lived clients never
256 // pruning their network graph. We run once 60 seconds after startup before
257 // continuing our normal cadence.
258 if last_prune_call.elapsed().as_secs() > if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER } {
259 if let Some(ref handler) = net_graph_msg_handler {
260 log_trace!(logger, "Pruning network graph of stale entries");
261 handler.network_graph().remove_stale_channels();
262 if let Err(e) = persister.persist_graph(handler.network_graph()) {
263 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
265 last_prune_call = Instant::now();
271 // After we exit, ensure we persist the ChannelManager one final time - this avoids
272 // some races where users quit while channel updates were in-flight, with
273 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
274 persister.persist_manager(&*channel_manager)?;
276 // Persist NetworkGraph on exit
277 if let Some(ref handler) = net_graph_msg_handler {
278 persister.persist_graph(handler.network_graph())?;
282 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
285 /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
286 /// [`ChannelManager`].
290 /// This function panics if the background thread has panicked such as while persisting or
293 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
294 pub fn join(mut self) -> Result<(), std::io::Error> {
295 assert!(self.thread_handle.is_some());
299 /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
300 /// [`ChannelManager`].
304 /// This function panics if the background thread has panicked such as while persisting or
307 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
308 pub fn stop(mut self) -> Result<(), std::io::Error> {
309 assert!(self.thread_handle.is_some());
310 self.stop_and_join_thread()
313 fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
314 self.stop_thread.store(true, Ordering::Release);
318 fn join_thread(&mut self) -> Result<(), std::io::Error> {
319 match self.thread_handle.take() {
320 Some(handle) => handle.join().unwrap(),
326 impl Drop for BackgroundProcessor {
328 self.stop_and_join_thread().unwrap();
334 use bitcoin::blockdata::block::BlockHeader;
335 use bitcoin::blockdata::constants::genesis_block;
336 use bitcoin::blockdata::transaction::{Transaction, TxOut};
337 use bitcoin::network::constants::Network;
338 use lightning::chain::{BestBlock, Confirm, chainmonitor};
339 use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
340 use lightning::chain::keysinterface::{InMemorySigner, Recipient, KeysInterface, KeysManager};
341 use lightning::chain::transaction::OutPoint;
342 use lightning::get_event_msg;
343 use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, ChannelManager, SimpleArcChannelManager};
344 use lightning::ln::features::InitFeatures;
345 use lightning::ln::msgs::{ChannelMessageHandler, Init};
346 use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
347 use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
348 use lightning::util::config::UserConfig;
349 use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
350 use lightning::util::ser::Writeable;
351 use lightning::util::test_utils;
352 use lightning::util::persist::KVStorePersister;
353 use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
354 use lightning_invoice::utils::DefaultRouter;
355 use lightning_persister::FilesystemPersister;
357 use std::path::PathBuf;
358 use std::sync::{Arc, Mutex};
359 use std::time::Duration;
360 use super::{BackgroundProcessor, FRESHNESS_TIMER};
362 const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
364 #[derive(Clone, Eq, Hash, PartialEq)]
365 struct TestDescriptor{}
366 impl SocketDescriptor for TestDescriptor {
367 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
371 fn disconnect_socket(&mut self) {}
374 type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
377 node: Arc<SimpleArcChannelManager<ChainMonitor, test_utils::TestBroadcaster, test_utils::TestFeeEstimator, test_utils::TestLogger>>,
378 net_graph_msg_handler: Option<Arc<NetGraphMsgHandler<Arc<NetworkGraph>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>>>,
379 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, Arc<test_utils::TestLogger>, IgnoringMessageHandler>>,
380 chain_monitor: Arc<ChainMonitor>,
381 persister: Arc<FilesystemPersister>,
382 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
383 network_graph: Arc<NetworkGraph>,
384 logger: Arc<test_utils::TestLogger>,
385 best_block: BestBlock,
390 let data_dir = self.persister.get_data_dir();
391 match fs::remove_dir_all(data_dir.clone()) {
392 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
399 graph_error: Option<(std::io::ErrorKind, &'static str)>,
400 manager_error: Option<(std::io::ErrorKind, &'static str)>,
401 filesystem_persister: FilesystemPersister,
405 fn new(data_dir: String) -> Self {
406 let filesystem_persister = FilesystemPersister::new(data_dir.clone());
407 Self { graph_error: None, manager_error: None, filesystem_persister }
410 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
411 Self { graph_error: Some((error, message)), ..self }
414 fn with_manager_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
415 Self { manager_error: Some((error, message)), ..self }
419 impl KVStorePersister for Persister {
420 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
421 if key == "manager" {
422 if let Some((error, message)) = self.manager_error {
423 return Err(std::io::Error::new(error, message))
427 if key == "network_graph" {
428 if let Some((error, message)) = self.graph_error {
429 return Err(std::io::Error::new(error, message))
433 self.filesystem_persister.persist(key, object)
437 fn get_full_filepath(filepath: String, filename: String) -> String {
438 let mut path = PathBuf::from(filepath);
440 path.to_str().unwrap().to_string()
443 fn create_nodes(num_nodes: usize, persist_dir: String) -> Vec<Node> {
444 let mut nodes = Vec::new();
445 for i in 0..num_nodes {
446 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
447 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
448 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
449 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
450 let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
451 let seed = [i as u8; 32];
452 let network = Network::Testnet;
453 let genesis_block = genesis_block(network);
454 let now = Duration::from_secs(genesis_block.header.time as u64);
455 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
456 let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
457 let best_block = BestBlock::from_genesis(network);
458 let params = ChainParameters { network, best_block };
459 let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
460 let network_graph = Arc::new(NetworkGraph::new(genesis_block.header.block_hash()));
461 let net_graph_msg_handler = Some(Arc::new(NetGraphMsgHandler::new(network_graph.clone(), Some(chain_source.clone()), logger.clone())));
462 let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new() )};
463 let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(Recipient::Node).unwrap(), &seed, logger.clone(), IgnoringMessageHandler{}));
464 let node = Node { node: manager, net_graph_msg_handler, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block };
468 for i in 0..num_nodes {
469 for j in (i+1)..num_nodes {
470 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
471 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &Init { features: InitFeatures::known(), remote_network_address: None });
478 macro_rules! open_channel {
479 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
480 begin_open_channel!($node_a, $node_b, $channel_value);
481 let events = $node_a.node.get_and_clear_pending_events();
482 assert_eq!(events.len(), 1);
483 let (temporary_channel_id, tx) = handle_funding_generation_ready!(&events[0], $channel_value);
484 end_open_channel!($node_a, $node_b, temporary_channel_id, tx);
489 macro_rules! begin_open_channel {
490 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
491 $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
492 $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()));
493 $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()));
497 macro_rules! handle_funding_generation_ready {
498 ($event: expr, $channel_value: expr) => {{
500 &Event::FundingGenerationReady { temporary_channel_id, channel_value_satoshis, ref output_script, user_channel_id } => {
501 assert_eq!(channel_value_satoshis, $channel_value);
502 assert_eq!(user_channel_id, 42);
504 let tx = Transaction { version: 1 as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
505 value: channel_value_satoshis, script_pubkey: output_script.clone(),
507 (temporary_channel_id, tx)
509 _ => panic!("Unexpected event"),
514 macro_rules! end_open_channel {
515 ($node_a: expr, $node_b: expr, $temporary_channel_id: expr, $tx: expr) => {{
516 $node_a.node.funding_transaction_generated(&$temporary_channel_id, $tx.clone()).unwrap();
517 $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()));
518 $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()));
522 fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
524 let prev_blockhash = node.best_block.block_hash();
525 let height = node.best_block.height() + 1;
526 let header = BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: Default::default(), time: height, bits: 42, nonce: 42 };
527 let txdata = vec![(0, tx)];
528 node.best_block = BestBlock::new(header.block_hash(), height);
531 node.node.transactions_confirmed(&header, &txdata, height);
532 node.chain_monitor.transactions_confirmed(&header, &txdata, height);
535 node.node.best_block_updated(&header, height);
536 node.chain_monitor.best_block_updated(&header, height);
542 fn confirm_transaction(node: &mut Node, tx: &Transaction) {
543 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
547 fn test_background_processor() {
548 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
549 // updates. Also test that when new updates are available, the manager signals that it needs
550 // re-persistence and is successfully re-persisted.
551 let nodes = create_nodes(2, "test_background_processor".to_string());
553 // Go through the channel creation process so that each node has something to persist. Since
554 // open_channel consumes events, it must complete before starting BackgroundProcessor to
555 // avoid a race with processing events.
556 let tx = open_channel!(nodes[0], nodes[1], 100000);
558 // Initiate the background processors to watch each node.
559 let data_dir = nodes[0].persister.get_data_dir();
560 let persister = Arc::new(Persister::new(data_dir));
561 let event_handler = |_: &_| {};
562 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
564 macro_rules! check_persisted_data {
565 ($node: expr, $filepath: expr) => {
566 let mut expected_bytes = Vec::new();
568 expected_bytes.clear();
569 match $node.write(&mut expected_bytes) {
571 match std::fs::read($filepath) {
573 if bytes == expected_bytes {
582 Err(e) => panic!("Unexpected error: {}", e)
588 // Check that the initial channel manager data is persisted as expected.
589 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "manager".to_string());
590 check_persisted_data!(nodes[0].node, filepath.clone());
593 if !nodes[0].node.get_persistence_condvar_value() { break }
596 // Force-close the channel.
597 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
599 // Check that the force-close updates are persisted.
600 check_persisted_data!(nodes[0].node, filepath.clone());
602 if !nodes[0].node.get_persistence_condvar_value() { break }
605 // Check network graph is persisted
606 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "network_graph".to_string());
607 if let Some(ref handler) = nodes[0].net_graph_msg_handler {
608 let network_graph = handler.network_graph();
609 check_persisted_data!(network_graph, filepath.clone());
612 assert!(bg_processor.stop().is_ok());
616 fn test_timer_tick_called() {
617 // Test that ChannelManager's and PeerManager's `timer_tick_occurred` is called every
618 // `FRESHNESS_TIMER`.
619 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
620 let data_dir = nodes[0].persister.get_data_dir();
621 let persister = Arc::new(Persister::new(data_dir));
622 let event_handler = |_: &_| {};
623 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
625 let log_entries = nodes[0].logger.lines.lock().unwrap();
626 let desired_log = "Calling ChannelManager's timer_tick_occurred".to_string();
627 let second_desired_log = "Calling PeerManager's timer_tick_occurred".to_string();
628 if log_entries.get(&("lightning_background_processor".to_string(), desired_log)).is_some() &&
629 log_entries.get(&("lightning_background_processor".to_string(), second_desired_log)).is_some() {
634 assert!(bg_processor.stop().is_ok());
638 fn test_channel_manager_persist_error() {
639 // Test that if we encounter an error during manager persistence, the thread panics.
640 let nodes = create_nodes(2, "test_persist_error".to_string());
641 open_channel!(nodes[0], nodes[1], 100000);
643 let data_dir = nodes[0].persister.get_data_dir();
644 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
645 let event_handler = |_: &_| {};
646 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
647 match bg_processor.join() {
648 Ok(_) => panic!("Expected error persisting manager"),
650 assert_eq!(e.kind(), std::io::ErrorKind::Other);
651 assert_eq!(e.get_ref().unwrap().to_string(), "test");
657 fn test_network_graph_persist_error() {
658 // Test that if we encounter an error during network graph persistence, an error gets returned.
659 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
660 let data_dir = nodes[0].persister.get_data_dir();
661 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
662 let event_handler = |_: &_| {};
663 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
665 match bg_processor.stop() {
666 Ok(_) => panic!("Expected error persisting network graph"),
668 assert_eq!(e.kind(), std::io::ErrorKind::Other);
669 assert_eq!(e.get_ref().unwrap().to_string(), "test");
675 fn test_background_event_handling() {
676 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
677 let channel_value = 100000;
678 let data_dir = nodes[0].persister.get_data_dir();
679 let persister = Arc::new(Persister::new(data_dir.clone()));
681 // Set up a background event handler for FundingGenerationReady events.
682 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
683 let event_handler = move |event: &Event| {
684 sender.send(handle_funding_generation_ready!(event, channel_value)).unwrap();
686 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
688 // Open a channel and check that the FundingGenerationReady event was handled.
689 begin_open_channel!(nodes[0], nodes[1], channel_value);
690 let (temporary_channel_id, funding_tx) = receiver
691 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
692 .expect("FundingGenerationReady not handled within deadline");
693 end_open_channel!(nodes[0], nodes[1], temporary_channel_id, funding_tx);
695 // Confirm the funding transaction.
696 confirm_transaction(&mut nodes[0], &funding_tx);
697 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id());
698 confirm_transaction(&mut nodes[1], &funding_tx);
699 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id());
700 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &bs_funding);
701 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
702 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding);
703 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
705 assert!(bg_processor.stop().is_ok());
707 // Set up a background event handler for SpendableOutputs events.
708 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
709 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
710 let persister = Arc::new(Persister::new(data_dir));
711 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
713 // Force close the channel and check that the SpendableOutputs event was handled.
714 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
715 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
716 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
718 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
719 .expect("SpendableOutputs not handled within deadline");
721 Event::SpendableOutputs { .. } => {},
722 Event::ChannelClosed { .. } => {},
723 _ => panic!("Unexpected event: {:?}", event),
726 assert!(bg_processor.stop().is_ok());
730 fn test_invoice_payer() {
731 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
732 let random_seed_bytes = keys_manager.get_secure_random_bytes();
733 let nodes = create_nodes(2, "test_invoice_payer".to_string());
735 // Initiate the background processors to watch each node.
736 let data_dir = nodes[0].persister.get_data_dir();
737 let persister = Arc::new(Persister::new(data_dir));
738 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
739 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
740 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
741 let event_handler = Arc::clone(&invoice_payer);
742 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].net_graph_msg_handler.clone(), nodes[0].peer_manager.clone(), nodes[0].logger.clone());
743 assert!(bg_processor.stop().is_ok());