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;
24 use std::sync::atomic::{AtomicBool, Ordering};
26 use std::thread::JoinHandle;
27 use std::time::{Duration, Instant};
30 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
31 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
32 /// responsibilities are:
33 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
34 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
35 /// writing it to disk/backups by invoking the callback given to it at startup.
36 /// [`ChannelManager`] persistence should be done in the background.
37 /// * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
38 /// at the appropriate intervals.
39 /// * Calling [`NetworkGraph::remove_stale_channels`] (if a [`NetGraphMsgHandler`] is provided to
40 /// [`BackgroundProcessor::start`]).
42 /// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
43 /// upon as doing so may result in high latency.
47 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
48 /// there is a risk of channels force-closing on startup when the manager realizes it's outdated.
49 /// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
50 /// unilateral chain closure fees are at risk.
52 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
53 /// [`Event`]: lightning::util::events::Event
54 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
55 pub struct BackgroundProcessor {
56 stop_thread: Arc<AtomicBool>,
57 thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
61 const FRESHNESS_TIMER: u64 = 60;
63 const FRESHNESS_TIMER: u64 = 1;
65 #[cfg(all(not(test), not(debug_assertions)))]
66 const PING_TIMER: u64 = 10;
67 /// Signature operations take a lot longer without compiler optimisations.
68 /// Increasing the ping timer allows for this but slower devices will be disconnected if the
69 /// timeout is reached.
70 #[cfg(all(not(test), debug_assertions))]
71 const PING_TIMER: u64 = 30;
73 const PING_TIMER: u64 = 1;
75 /// Prune the network graph of stale entries hourly.
76 const NETWORK_PRUNE_TIMER: u64 = 60 * 60;
79 const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
81 const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;
83 /// Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
84 pub trait Persister<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L: Deref>
86 M::Target: 'static + chain::Watch<Signer>,
87 T::Target: 'static + BroadcasterInterface,
88 K::Target: 'static + KeysInterface<Signer = Signer>,
89 F::Target: 'static + FeeEstimator,
90 L::Target: 'static + Logger,
92 /// Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
93 /// (which will cause the [`BackgroundProcessor`] which called this method to exit).
94 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error>;
96 /// Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
97 fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error>;
100 /// Decorates an [`EventHandler`] with common functionality provided by standard [`EventHandler`]s.
101 struct DecoratingEventHandler<
103 N: Deref<Target = NetGraphMsgHandler<G, A, L>>,
104 G: Deref<Target = NetworkGraph>,
108 where A::Target: chain::Access, L::Target: Logger {
110 net_graph_msg_handler: Option<N>,
115 N: Deref<Target = NetGraphMsgHandler<G, A, L>>,
116 G: Deref<Target = NetworkGraph>,
119 > EventHandler for DecoratingEventHandler<E, N, G, A, L>
120 where A::Target: chain::Access, L::Target: Logger {
121 fn handle_event(&self, event: &Event) {
122 if let Some(event_handler) = &self.net_graph_msg_handler {
123 event_handler.handle_event(event);
125 self.event_handler.handle_event(event);
129 impl BackgroundProcessor {
130 /// Start a background thread that takes care of responsibilities enumerated in the [top-level
133 /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
134 /// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
135 /// either [`join`] or [`stop`].
137 /// # Data Persistence
139 /// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
140 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
141 /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
142 /// provided implementation.
144 /// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
145 /// [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
146 /// for Rust-Lightning's provided implementation.
148 /// Typically, users should either implement [`Persister::persist_manager`] to never return an
149 /// error or call [`join`] and handle any error that may arise. For the latter case,
150 /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
154 /// `event_handler` is responsible for handling events that users should be notified of (e.g.,
155 /// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
156 /// functionality implemented by other handlers.
157 /// * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
159 /// [top-level documentation]: BackgroundProcessor
160 /// [`join`]: Self::join
161 /// [`stop`]: Self::stop
162 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
163 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
164 /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
165 /// [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
166 /// [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
167 /// [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
169 Signer: 'static + Sign,
170 CA: 'static + Deref + Send + Sync,
171 CF: 'static + Deref + Send + Sync,
172 CW: 'static + Deref + Send + Sync,
173 T: 'static + Deref + Send + Sync,
174 K: 'static + Deref + Send + Sync,
175 F: 'static + Deref + Send + Sync,
176 G: 'static + Deref<Target = NetworkGraph> + Send + Sync,
177 L: 'static + Deref + Send + Sync,
178 P: 'static + Deref + Send + Sync,
179 Descriptor: 'static + SocketDescriptor + Send + Sync,
180 CMH: 'static + Deref + Send + Sync,
181 RMH: 'static + Deref + Send + Sync,
182 EH: 'static + EventHandler + Send,
183 PS: 'static + Send + Persister<Signer, CW, T, K, F, L>,
184 M: 'static + Deref<Target = ChainMonitor<Signer, CF, T, F, L, P>> + Send + Sync,
185 CM: 'static + Deref<Target = ChannelManager<Signer, CW, T, K, F, L>> + Send + Sync,
186 NG: 'static + Deref<Target = NetGraphMsgHandler<G, CA, L>> + Send + Sync,
187 UMH: 'static + Deref + Send + Sync,
188 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, L, UMH>> + Send + Sync,
190 persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
191 net_graph_msg_handler: Option<NG>, peer_manager: PM, logger: L
194 CA::Target: 'static + chain::Access,
195 CF::Target: 'static + chain::Filter,
196 CW::Target: 'static + chain::Watch<Signer>,
197 T::Target: 'static + BroadcasterInterface,
198 K::Target: 'static + KeysInterface<Signer = Signer>,
199 F::Target: 'static + FeeEstimator,
200 L::Target: 'static + Logger,
201 P::Target: 'static + Persist<Signer>,
202 CMH::Target: 'static + ChannelMessageHandler,
203 RMH::Target: 'static + RoutingMessageHandler,
204 UMH::Target: 'static + CustomMessageHandler,
206 let stop_thread = Arc::new(AtomicBool::new(false));
207 let stop_thread_clone = stop_thread.clone();
208 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
209 let event_handler = DecoratingEventHandler { event_handler, net_graph_msg_handler: net_graph_msg_handler.as_ref().map(|t| t.deref()) };
211 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred on startup");
212 channel_manager.timer_tick_occurred();
214 let mut last_freshness_call = Instant::now();
215 let mut last_ping_call = Instant::now();
216 let mut last_prune_call = Instant::now();
217 let mut have_pruned = false;
220 peer_manager.process_events(); // Note that this may block on ChannelManager's locking
221 channel_manager.process_pending_events(&event_handler);
222 chain_monitor.process_pending_events(&event_handler);
224 // We wait up to 100ms, but track how long it takes to detect being put to sleep,
225 // see `await_start`'s use below.
226 let await_start = Instant::now();
227 let updates_available =
228 channel_manager.await_persistable_update_timeout(Duration::from_millis(100));
229 let await_time = await_start.elapsed();
231 if updates_available {
232 log_trace!(logger, "Persisting ChannelManager...");
233 persister.persist_manager(&*channel_manager)?;
234 log_trace!(logger, "Done persisting ChannelManager.");
236 // Exit the loop if the background processor was requested to stop.
237 if stop_thread.load(Ordering::Acquire) == true {
238 log_trace!(logger, "Terminating background processor.");
241 if last_freshness_call.elapsed().as_secs() > FRESHNESS_TIMER {
242 log_trace!(logger, "Calling ChannelManager's timer_tick_occurred");
243 channel_manager.timer_tick_occurred();
244 last_freshness_call = Instant::now();
246 if await_time > Duration::from_secs(1) {
247 // On various platforms, we may be starved of CPU cycles for several reasons.
248 // E.g. on iOS, if we've been in the background, we will be entirely paused.
249 // Similarly, if we're on a desktop platform and the device has been asleep, we
250 // may not get any cycles.
251 // We detect this by checking if our max-100ms-sleep, above, ran longer than a
252 // full second, at which point we assume sockets may have been killed (they
253 // appear to be at least on some platforms, even if it has only been a second).
254 // Note that we have to take care to not get here just because user event
255 // processing was slow at the top of the loop. For example, the sample client
256 // may call Bitcoin Core RPCs during event handling, which very often takes
257 // more than a handful of seconds to complete, and shouldn't disconnect all our
259 log_trace!(logger, "100ms sleep took more than a second, disconnecting peers.");
260 peer_manager.disconnect_all_peers();
261 last_ping_call = Instant::now();
262 } else if last_ping_call.elapsed().as_secs() > PING_TIMER {
263 log_trace!(logger, "Calling PeerManager's timer_tick_occurred");
264 peer_manager.timer_tick_occurred();
265 last_ping_call = Instant::now();
268 // Note that we want to run a graph prune once not long after startup before
269 // falling back to our usual hourly prunes. This avoids short-lived clients never
270 // pruning their network graph. We run once 60 seconds after startup before
271 // continuing our normal cadence.
272 if last_prune_call.elapsed().as_secs() > if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER } {
273 if let Some(ref handler) = net_graph_msg_handler {
274 log_trace!(logger, "Pruning network graph of stale entries");
275 handler.network_graph().remove_stale_channels();
276 if let Err(e) = persister.persist_graph(handler.network_graph()) {
277 log_error!(logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
279 last_prune_call = Instant::now();
285 // After we exit, ensure we persist the ChannelManager one final time - this avoids
286 // some races where users quit while channel updates were in-flight, with
287 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
288 persister.persist_manager(&*channel_manager)?;
290 // Persist NetworkGraph on exit
291 if let Some(ref handler) = net_graph_msg_handler {
292 persister.persist_graph(handler.network_graph())?;
296 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
299 /// Join `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 join(mut self) -> Result<(), std::io::Error> {
309 assert!(self.thread_handle.is_some());
313 /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
314 /// [`ChannelManager`].
318 /// This function panics if the background thread has panicked such as while persisting or
321 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
322 pub fn stop(mut self) -> Result<(), std::io::Error> {
323 assert!(self.thread_handle.is_some());
324 self.stop_and_join_thread()
327 fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
328 self.stop_thread.store(true, Ordering::Release);
332 fn join_thread(&mut self) -> Result<(), std::io::Error> {
333 match self.thread_handle.take() {
334 Some(handle) => handle.join().unwrap(),
340 impl Drop for BackgroundProcessor {
342 self.stop_and_join_thread().unwrap();
348 use bitcoin::blockdata::block::BlockHeader;
349 use bitcoin::blockdata::constants::genesis_block;
350 use bitcoin::blockdata::transaction::{Transaction, TxOut};
351 use bitcoin::network::constants::Network;
352 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
353 use lightning::chain::{BestBlock, Confirm, chainmonitor, self};
354 use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
355 use lightning::chain::keysinterface::{InMemorySigner, Recipient, KeysInterface, KeysManager, Sign};
356 use lightning::chain::transaction::OutPoint;
357 use lightning::get_event_msg;
358 use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, ChannelManager, SimpleArcChannelManager};
359 use lightning::ln::features::InitFeatures;
360 use lightning::ln::msgs::{ChannelMessageHandler, Init};
361 use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
362 use lightning::routing::network_graph::{NetworkGraph, NetGraphMsgHandler};
363 use lightning::util::config::UserConfig;
364 use lightning::util::events::{Event, MessageSendEventsProvider, MessageSendEvent};
365 use lightning::util::logger::Logger;
366 use lightning::util::ser::Writeable;
367 use lightning::util::test_utils;
368 use lightning_invoice::payment::{InvoicePayer, RetryAttempts};
369 use lightning_invoice::utils::DefaultRouter;
370 use lightning_persister::FilesystemPersister;
373 use std::path::PathBuf;
374 use std::sync::{Arc, Mutex};
375 use std::time::Duration;
376 use super::{BackgroundProcessor, FRESHNESS_TIMER};
378 const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
380 #[derive(Clone, Eq, Hash, PartialEq)]
381 struct TestDescriptor{}
382 impl SocketDescriptor for TestDescriptor {
383 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
387 fn disconnect_socket(&mut self) {}
390 type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
393 node: Arc<SimpleArcChannelManager<ChainMonitor, test_utils::TestBroadcaster, test_utils::TestFeeEstimator, test_utils::TestLogger>>,
394 net_graph_msg_handler: Option<Arc<NetGraphMsgHandler<Arc<NetworkGraph>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>>>,
395 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, Arc<test_utils::TestLogger>, IgnoringMessageHandler>>,
396 chain_monitor: Arc<ChainMonitor>,
397 persister: Arc<FilesystemPersister>,
398 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
399 network_graph: Arc<NetworkGraph>,
400 logger: Arc<test_utils::TestLogger>,
401 best_block: BestBlock,
406 let data_dir = self.persister.get_data_dir();
407 match fs::remove_dir_all(data_dir.clone()) {
408 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
418 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for Persister where
419 M::Target: 'static + chain::Watch<Signer>,
420 T::Target: 'static + BroadcasterInterface,
421 K::Target: 'static + KeysInterface<Signer = Signer>,
422 F::Target: 'static + FeeEstimator,
423 L::Target: 'static + Logger,
425 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
426 FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager)
429 fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
430 FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph)
434 fn get_full_filepath(filepath: String, filename: String) -> String {
435 let mut path = PathBuf::from(filepath);
437 path.to_str().unwrap().to_string()
440 fn create_nodes(num_nodes: usize, persist_dir: String) -> Vec<Node> {
441 let mut nodes = Vec::new();
442 for i in 0..num_nodes {
443 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), blocks: Arc::new(Mutex::new(Vec::new()))});
444 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
445 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
446 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
447 let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
448 let seed = [i as u8; 32];
449 let network = Network::Testnet;
450 let genesis_block = genesis_block(network);
451 let now = Duration::from_secs(genesis_block.header.time as u64);
452 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
453 let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
454 let best_block = BestBlock::from_genesis(network);
455 let params = ChainParameters { network, best_block };
456 let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), keys_manager.clone(), UserConfig::default(), params));
457 let network_graph = Arc::new(NetworkGraph::new(genesis_block.header.block_hash()));
458 let net_graph_msg_handler = Some(Arc::new(NetGraphMsgHandler::new(network_graph.clone(), Some(chain_source.clone()), logger.clone())));
459 let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new() )};
460 let peer_manager = Arc::new(PeerManager::new(msg_handler, keys_manager.get_node_secret(Recipient::Node).unwrap(), &seed, logger.clone(), IgnoringMessageHandler{}));
461 let node = Node { node: manager, net_graph_msg_handler, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block };
465 for i in 0..num_nodes {
466 for j in (i+1)..num_nodes {
467 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &Init { features: InitFeatures::known() });
468 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &Init { features: InitFeatures::known() });
475 macro_rules! open_channel {
476 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
477 begin_open_channel!($node_a, $node_b, $channel_value);
478 let events = $node_a.node.get_and_clear_pending_events();
479 assert_eq!(events.len(), 1);
480 let (temporary_channel_id, tx) = handle_funding_generation_ready!(&events[0], $channel_value);
481 end_open_channel!($node_a, $node_b, temporary_channel_id, tx);
486 macro_rules! begin_open_channel {
487 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
488 $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
489 $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()));
490 $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()));
494 macro_rules! handle_funding_generation_ready {
495 ($event: expr, $channel_value: expr) => {{
497 &Event::FundingGenerationReady { temporary_channel_id, channel_value_satoshis, ref output_script, user_channel_id } => {
498 assert_eq!(channel_value_satoshis, $channel_value);
499 assert_eq!(user_channel_id, 42);
501 let tx = Transaction { version: 1 as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
502 value: channel_value_satoshis, script_pubkey: output_script.clone(),
504 (temporary_channel_id, tx)
506 _ => panic!("Unexpected event"),
511 macro_rules! end_open_channel {
512 ($node_a: expr, $node_b: expr, $temporary_channel_id: expr, $tx: expr) => {{
513 $node_a.node.funding_transaction_generated(&$temporary_channel_id, $tx.clone()).unwrap();
514 $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()));
515 $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()));
519 fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
521 let prev_blockhash = node.best_block.block_hash();
522 let height = node.best_block.height() + 1;
523 let header = BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: Default::default(), time: height, bits: 42, nonce: 42 };
524 let txdata = vec![(0, tx)];
525 node.best_block = BestBlock::new(header.block_hash(), height);
528 node.node.transactions_confirmed(&header, &txdata, height);
529 node.chain_monitor.transactions_confirmed(&header, &txdata, height);
532 node.node.best_block_updated(&header, height);
533 node.chain_monitor.best_block_updated(&header, height);
539 fn confirm_transaction(node: &mut Node, tx: &Transaction) {
540 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
544 fn test_background_processor() {
545 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
546 // updates. Also test that when new updates are available, the manager signals that it needs
547 // re-persistence and is successfully re-persisted.
548 let nodes = create_nodes(2, "test_background_processor".to_string());
550 // Go through the channel creation process so that each node has something to persist. Since
551 // open_channel consumes events, it must complete before starting BackgroundProcessor to
552 // avoid a race with processing events.
553 let tx = open_channel!(nodes[0], nodes[1], 100000);
555 // Initiate the background processors to watch each node.
556 let data_dir = nodes[0].persister.get_data_dir();
557 let persister = Persister { data_dir };
558 let event_handler = |_: &_| {};
559 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());
561 macro_rules! check_persisted_data {
562 ($node: expr, $filepath: expr) => {
563 let mut expected_bytes = Vec::new();
565 expected_bytes.clear();
566 match $node.write(&mut expected_bytes) {
568 match std::fs::read($filepath) {
570 if bytes == expected_bytes {
579 Err(e) => panic!("Unexpected error: {}", e)
585 // Check that the initial channel manager data is persisted as expected.
586 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "manager".to_string());
587 check_persisted_data!(nodes[0].node, filepath.clone());
590 if !nodes[0].node.get_persistence_condvar_value() { break }
593 // Force-close the channel.
594 nodes[0].node.force_close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
596 // Check that the force-close updates are persisted.
597 check_persisted_data!(nodes[0].node, filepath.clone());
599 if !nodes[0].node.get_persistence_condvar_value() { break }
602 // Check network graph is persisted
603 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "network_graph".to_string());
604 if let Some(ref handler) = nodes[0].net_graph_msg_handler {
605 let network_graph = handler.network_graph();
606 check_persisted_data!(network_graph, filepath.clone());
609 assert!(bg_processor.stop().is_ok());
613 fn test_timer_tick_called() {
614 // Test that ChannelManager's and PeerManager's `timer_tick_occurred` is called every
615 // `FRESHNESS_TIMER`.
616 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
617 let data_dir = nodes[0].persister.get_data_dir();
618 let persister = Persister { data_dir };
619 let event_handler = |_: &_| {};
620 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());
622 let log_entries = nodes[0].logger.lines.lock().unwrap();
623 let desired_log = "Calling ChannelManager's timer_tick_occurred".to_string();
624 let second_desired_log = "Calling PeerManager's timer_tick_occurred".to_string();
625 if log_entries.get(&("lightning_background_processor".to_string(), desired_log)).is_some() &&
626 log_entries.get(&("lightning_background_processor".to_string(), second_desired_log)).is_some() {
631 assert!(bg_processor.stop().is_ok());
635 fn test_channel_manager_persist_error() {
636 // Test that if we encounter an error during manager persistence, the thread panics.
637 let nodes = create_nodes(2, "test_persist_error".to_string());
638 open_channel!(nodes[0], nodes[1], 100000);
640 struct ChannelManagerErrorPersister {
644 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for ChannelManagerErrorPersister where
645 M::Target: 'static + chain::Watch<Signer>,
646 T::Target: 'static + BroadcasterInterface,
647 K::Target: 'static + KeysInterface<Signer = Signer>,
648 F::Target: 'static + FeeEstimator,
649 L::Target: 'static + Logger,
651 fn persist_manager(&self, _channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
652 Err(std::io::Error::new(std::io::ErrorKind::Other, "test"))
655 fn persist_graph(&self, network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
656 FilesystemPersister::persist_network_graph(self.data_dir.clone(), network_graph)
660 let data_dir = nodes[0].persister.get_data_dir();
661 let persister = ChannelManagerErrorPersister{ data_dir };
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());
664 match bg_processor.join() {
665 Ok(_) => panic!("Expected error persisting manager"),
667 assert_eq!(e.kind(), std::io::ErrorKind::Other);
668 assert_eq!(e.get_ref().unwrap().to_string(), "test");
674 fn test_network_graph_persist_error() {
675 // Test that if we encounter an error during network graph persistence, an error gets returned.
676 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
677 struct NetworkGraphErrorPersister {
681 impl<Signer: Sign, M: Deref, T: Deref, K: Deref, F: Deref, L:Deref> super::Persister<Signer, M, T, K, F, L> for NetworkGraphErrorPersister where
682 M::Target: 'static + chain::Watch<Signer>,
683 T::Target: 'static + BroadcasterInterface,
684 K::Target: 'static + KeysInterface<Signer = Signer>,
685 F::Target: 'static + FeeEstimator,
686 L::Target: 'static + Logger,
688 fn persist_manager(&self, channel_manager: &ChannelManager<Signer, M, T, K, F, L>) -> Result<(), std::io::Error> {
689 FilesystemPersister::persist_manager(self.data_dir.clone(), channel_manager)
692 fn persist_graph(&self, _network_graph: &NetworkGraph) -> Result<(), std::io::Error> {
693 Err(std::io::Error::new(std::io::ErrorKind::Other, "test"))
697 let data_dir = nodes[0].persister.get_data_dir();
698 let persister = NetworkGraphErrorPersister { data_dir };
699 let event_handler = |_: &_| {};
700 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());
702 match bg_processor.stop() {
703 Ok(_) => panic!("Expected error persisting network graph"),
705 assert_eq!(e.kind(), std::io::ErrorKind::Other);
706 assert_eq!(e.get_ref().unwrap().to_string(), "test");
712 fn test_background_event_handling() {
713 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
714 let channel_value = 100000;
715 let data_dir = nodes[0].persister.get_data_dir();
716 let persister = Persister { data_dir: data_dir.clone() };
718 // Set up a background event handler for FundingGenerationReady events.
719 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
720 let event_handler = move |event: &Event| {
721 sender.send(handle_funding_generation_ready!(event, channel_value)).unwrap();
723 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());
725 // Open a channel and check that the FundingGenerationReady event was handled.
726 begin_open_channel!(nodes[0], nodes[1], channel_value);
727 let (temporary_channel_id, funding_tx) = receiver
728 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
729 .expect("FundingGenerationReady not handled within deadline");
730 end_open_channel!(nodes[0], nodes[1], temporary_channel_id, funding_tx);
732 // Confirm the funding transaction.
733 confirm_transaction(&mut nodes[0], &funding_tx);
734 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendFundingLocked, nodes[1].node.get_our_node_id());
735 confirm_transaction(&mut nodes[1], &funding_tx);
736 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id());
737 nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &bs_funding);
738 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
739 nodes[1].node.handle_funding_locked(&nodes[0].node.get_our_node_id(), &as_funding);
740 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
742 assert!(bg_processor.stop().is_ok());
744 // Set up a background event handler for SpendableOutputs events.
745 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
746 let event_handler = move |event: &Event| sender.send(event.clone()).unwrap();
747 let bg_processor = BackgroundProcessor::start(Persister{ data_dir: data_dir.clone() }, 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());
749 // Force close the channel and check that the SpendableOutputs event was handled.
750 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id).unwrap();
751 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
752 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
754 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
755 .expect("SpendableOutputs not handled within deadline");
757 Event::SpendableOutputs { .. } => {},
758 Event::ChannelClosed { .. } => {},
759 _ => panic!("Unexpected event: {:?}", event),
762 assert!(bg_processor.stop().is_ok());
766 fn test_invoice_payer() {
767 let keys_manager = test_utils::TestKeysInterface::new(&[0u8; 32], Network::Testnet);
768 let random_seed_bytes = keys_manager.get_secure_random_bytes();
769 let nodes = create_nodes(2, "test_invoice_payer".to_string());
771 // Initiate the background processors to watch each node.
772 let data_dir = nodes[0].persister.get_data_dir();
773 let persister = Persister { data_dir };
774 let scorer = Arc::new(Mutex::new(test_utils::TestScorer::with_penalty(0)));
775 let router = DefaultRouter::new(Arc::clone(&nodes[0].network_graph), Arc::clone(&nodes[0].logger), random_seed_bytes);
776 let invoice_payer = Arc::new(InvoicePayer::new(Arc::clone(&nodes[0].node), router, scorer, Arc::clone(&nodes[0].logger), |_: &_| {}, RetryAttempts(2)));
777 let event_handler = Arc::clone(&invoice_payer);
778 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());
779 assert!(bg_processor.stop().is_ok());