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 // Prefix these with `rustdoc::` when we update our MSRV to be >= 1.52 to remove warnings.
6 #![deny(broken_intra_doc_links)]
7 #![deny(private_intra_doc_links)]
10 #![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
12 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
14 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
16 #[cfg(any(test, feature = "std"))]
19 #[cfg(not(feature = "std"))]
22 #[macro_use] extern crate lightning;
23 extern crate lightning_rapid_gossip_sync;
26 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
27 use lightning::chain::chainmonitor::{ChainMonitor, Persist};
28 use lightning::chain::keysinterface::{EntropySource, NodeSigner, SignerProvider};
29 use lightning::events::{Event, PathFailure};
30 #[cfg(feature = "std")]
31 use lightning::events::{EventHandler, EventsProvider};
32 use lightning::ln::channelmanager::ChannelManager;
33 use lightning::ln::msgs::{ChannelMessageHandler, OnionMessageHandler, RoutingMessageHandler};
34 use lightning::ln::peer_handler::{CustomMessageHandler, PeerManager, SocketDescriptor};
35 use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
36 use lightning::routing::utxo::UtxoLookup;
37 use lightning::routing::router::Router;
38 use lightning::routing::scoring::{Score, WriteableScore};
39 use lightning::util::logger::Logger;
40 use lightning::util::persist::Persister;
41 #[cfg(feature = "std")]
42 use lightning::util::wakers::Sleeper;
43 use lightning_rapid_gossip_sync::RapidGossipSync;
46 use core::time::Duration;
48 #[cfg(feature = "std")]
50 #[cfg(feature = "std")]
51 use core::sync::atomic::{AtomicBool, Ordering};
52 #[cfg(feature = "std")]
53 use std::thread::{self, JoinHandle};
54 #[cfg(feature = "std")]
55 use std::time::Instant;
57 #[cfg(not(feature = "std"))]
60 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
61 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
62 /// responsibilities are:
63 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
64 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
65 /// writing it to disk/backups by invoking the callback given to it at startup.
66 /// [`ChannelManager`] persistence should be done in the background.
67 /// * Calling [`ChannelManager::timer_tick_occurred`], [`ChainMonitor::rebroadcast_pending_claims`]
68 /// and [`PeerManager::timer_tick_occurred`] at the appropriate intervals.
69 /// * Calling [`NetworkGraph::remove_stale_channels_and_tracking`] (if a [`GossipSync`] with a
70 /// [`NetworkGraph`] is provided to [`BackgroundProcessor::start`]).
72 /// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
73 /// upon as doing so may result in high latency.
77 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
78 /// there is a risk of channels force-closing on startup when the manager realizes it's outdated.
79 /// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
80 /// unilateral chain closure fees are at risk.
82 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
83 /// [`Event`]: lightning::events::Event
84 #[cfg(feature = "std")]
85 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
86 pub struct BackgroundProcessor {
87 stop_thread: Arc<AtomicBool>,
88 thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
92 const FRESHNESS_TIMER: u64 = 60;
94 const FRESHNESS_TIMER: u64 = 1;
96 #[cfg(all(not(test), not(debug_assertions)))]
97 const PING_TIMER: u64 = 10;
98 /// Signature operations take a lot longer without compiler optimisations.
99 /// Increasing the ping timer allows for this but slower devices will be disconnected if the
100 /// timeout is reached.
101 #[cfg(all(not(test), debug_assertions))]
102 const PING_TIMER: u64 = 30;
104 const PING_TIMER: u64 = 1;
106 /// Prune the network graph of stale entries hourly.
107 const NETWORK_PRUNE_TIMER: u64 = 60 * 60;
110 const SCORER_PERSIST_TIMER: u64 = 30;
112 const SCORER_PERSIST_TIMER: u64 = 1;
115 const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
117 const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;
120 const REBROADCAST_TIMER: u64 = 30;
122 const REBROADCAST_TIMER: u64 = 1;
124 #[cfg(feature = "futures")]
125 /// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
126 const fn min_u64(a: u64, b: u64) -> u64 { if a < b { a } else { b } }
127 #[cfg(feature = "futures")]
128 const FASTEST_TIMER: u64 = min_u64(min_u64(FRESHNESS_TIMER, PING_TIMER),
129 min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)));
131 /// Either [`P2PGossipSync`] or [`RapidGossipSync`].
133 P: Deref<Target = P2PGossipSync<G, U, L>>,
134 R: Deref<Target = RapidGossipSync<G, L>>,
135 G: Deref<Target = NetworkGraph<L>>,
139 where U::Target: UtxoLookup, L::Target: Logger {
140 /// Gossip sync via the lightning peer-to-peer network as defined by BOLT 7.
142 /// Rapid gossip sync from a trusted server.
149 P: Deref<Target = P2PGossipSync<G, U, L>>,
150 R: Deref<Target = RapidGossipSync<G, L>>,
151 G: Deref<Target = NetworkGraph<L>>,
154 > GossipSync<P, R, G, U, L>
155 where U::Target: UtxoLookup, L::Target: Logger {
156 fn network_graph(&self) -> Option<&G> {
158 GossipSync::P2P(gossip_sync) => Some(gossip_sync.network_graph()),
159 GossipSync::Rapid(gossip_sync) => Some(gossip_sync.network_graph()),
160 GossipSync::None => None,
164 fn prunable_network_graph(&self) -> Option<&G> {
166 GossipSync::P2P(gossip_sync) => Some(gossip_sync.network_graph()),
167 GossipSync::Rapid(gossip_sync) => {
168 if gossip_sync.is_initial_sync_complete() {
169 Some(gossip_sync.network_graph())
174 GossipSync::None => None,
179 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
180 impl<P: Deref<Target = P2PGossipSync<G, U, L>>, G: Deref<Target = NetworkGraph<L>>, U: Deref, L: Deref>
181 GossipSync<P, &RapidGossipSync<G, L>, G, U, L>
183 U::Target: UtxoLookup,
186 /// Initializes a new [`GossipSync::P2P`] variant.
187 pub fn p2p(gossip_sync: P) -> Self {
188 GossipSync::P2P(gossip_sync)
192 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
193 impl<'a, R: Deref<Target = RapidGossipSync<G, L>>, G: Deref<Target = NetworkGraph<L>>, L: Deref>
195 &P2PGossipSync<G, &'a (dyn UtxoLookup + Send + Sync), L>,
198 &'a (dyn UtxoLookup + Send + Sync),
204 /// Initializes a new [`GossipSync::Rapid`] variant.
205 pub fn rapid(gossip_sync: R) -> Self {
206 GossipSync::Rapid(gossip_sync)
210 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
213 &P2PGossipSync<&'a NetworkGraph<L>, &'a (dyn UtxoLookup + Send + Sync), L>,
214 &RapidGossipSync<&'a NetworkGraph<L>, L>,
216 &'a (dyn UtxoLookup + Send + Sync),
222 /// Initializes a new [`GossipSync::None`] variant.
223 pub fn none() -> Self {
228 fn handle_network_graph_update<L: Deref>(
229 network_graph: &NetworkGraph<L>, event: &Event
230 ) where L::Target: Logger {
231 if let Event::PaymentPathFailed {
232 failure: PathFailure::OnPath { network_update: Some(ref upd) }, .. } = event
234 network_graph.handle_network_update(upd);
238 fn update_scorer<'a, S: 'static + Deref<Target = SC> + Send + Sync, SC: 'a + WriteableScore<'a>>(
239 scorer: &'a S, event: &Event
241 let mut score = scorer.lock();
243 Event::PaymentPathFailed { ref path, short_channel_id: Some(scid), .. } => {
244 score.payment_path_failed(path, *scid);
246 Event::PaymentPathFailed { ref path, payment_failed_permanently: true, .. } => {
247 // Reached if the destination explicitly failed it back. We treat this as a successful probe
248 // because the payment made it all the way to the destination with sufficient liquidity.
249 score.probe_successful(path);
251 Event::PaymentPathSuccessful { path, .. } => {
252 score.payment_path_successful(path);
254 Event::ProbeSuccessful { path, .. } => {
255 score.probe_successful(path);
257 Event::ProbeFailed { path, short_channel_id: Some(scid), .. } => {
258 score.probe_failed(path, *scid);
264 macro_rules! define_run_body {
265 ($persister: ident, $chain_monitor: ident, $process_chain_monitor_events: expr,
266 $channel_manager: ident, $process_channel_manager_events: expr,
267 $gossip_sync: ident, $peer_manager: ident, $logger: ident, $scorer: ident,
268 $loop_exit_check: expr, $await: expr, $get_timer: expr, $timer_elapsed: expr,
269 $check_slow_await: expr)
271 log_trace!($logger, "Calling ChannelManager's timer_tick_occurred on startup");
272 $channel_manager.timer_tick_occurred();
273 log_trace!($logger, "Rebroadcasting monitor's pending claims on startup");
274 $chain_monitor.rebroadcast_pending_claims();
276 let mut last_freshness_call = $get_timer(FRESHNESS_TIMER);
277 let mut last_ping_call = $get_timer(PING_TIMER);
278 let mut last_prune_call = $get_timer(FIRST_NETWORK_PRUNE_TIMER);
279 let mut last_scorer_persist_call = $get_timer(SCORER_PERSIST_TIMER);
280 let mut last_rebroadcast_call = $get_timer(REBROADCAST_TIMER);
281 let mut have_pruned = false;
284 $process_channel_manager_events;
285 $process_chain_monitor_events;
287 // Note that the PeerManager::process_events may block on ChannelManager's locks,
288 // hence it comes last here. When the ChannelManager finishes whatever it's doing,
289 // we want to ensure we get into `persist_manager` as quickly as we can, especially
290 // without running the normal event processing above and handing events to users.
292 // Specifically, on an *extremely* slow machine, we may see ChannelManager start
293 // processing a message effectively at any point during this loop. In order to
294 // minimize the time between such processing completing and persisting the updated
295 // ChannelManager, we want to minimize methods blocking on a ChannelManager
296 // generally, and as a fallback place such blocking only immediately before
298 $peer_manager.process_events();
300 // Exit the loop if the background processor was requested to stop.
301 if $loop_exit_check {
302 log_trace!($logger, "Terminating background processor.");
306 // We wait up to 100ms, but track how long it takes to detect being put to sleep,
307 // see `await_start`'s use below.
308 let mut await_start = None;
309 if $check_slow_await { await_start = Some($get_timer(1)); }
310 let updates_available = $await;
311 let await_slow = if $check_slow_await { $timer_elapsed(&mut await_start.unwrap(), 1) } else { false };
313 // Exit the loop if the background processor was requested to stop.
314 if $loop_exit_check {
315 log_trace!($logger, "Terminating background processor.");
319 if updates_available {
320 log_trace!($logger, "Persisting ChannelManager...");
321 $persister.persist_manager(&*$channel_manager)?;
322 log_trace!($logger, "Done persisting ChannelManager.");
324 if $timer_elapsed(&mut last_freshness_call, FRESHNESS_TIMER) {
325 log_trace!($logger, "Calling ChannelManager's timer_tick_occurred");
326 $channel_manager.timer_tick_occurred();
327 last_freshness_call = $get_timer(FRESHNESS_TIMER);
330 // On various platforms, we may be starved of CPU cycles for several reasons.
331 // E.g. on iOS, if we've been in the background, we will be entirely paused.
332 // Similarly, if we're on a desktop platform and the device has been asleep, we
333 // may not get any cycles.
334 // We detect this by checking if our max-100ms-sleep, above, ran longer than a
335 // full second, at which point we assume sockets may have been killed (they
336 // appear to be at least on some platforms, even if it has only been a second).
337 // Note that we have to take care to not get here just because user event
338 // processing was slow at the top of the loop. For example, the sample client
339 // may call Bitcoin Core RPCs during event handling, which very often takes
340 // more than a handful of seconds to complete, and shouldn't disconnect all our
342 log_trace!($logger, "100ms sleep took more than a second, disconnecting peers.");
343 $peer_manager.disconnect_all_peers();
344 last_ping_call = $get_timer(PING_TIMER);
345 } else if $timer_elapsed(&mut last_ping_call, PING_TIMER) {
346 log_trace!($logger, "Calling PeerManager's timer_tick_occurred");
347 $peer_manager.timer_tick_occurred();
348 last_ping_call = $get_timer(PING_TIMER);
351 // Note that we want to run a graph prune once not long after startup before
352 // falling back to our usual hourly prunes. This avoids short-lived clients never
353 // pruning their network graph. We run once 60 seconds after startup before
354 // continuing our normal cadence.
355 let prune_timer = if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER };
356 if $timer_elapsed(&mut last_prune_call, prune_timer) {
357 // The network graph must not be pruned while rapid sync completion is pending
358 if let Some(network_graph) = $gossip_sync.prunable_network_graph() {
359 #[cfg(feature = "std")] {
360 log_trace!($logger, "Pruning and persisting network graph.");
361 network_graph.remove_stale_channels_and_tracking();
363 #[cfg(not(feature = "std"))] {
364 log_warn!($logger, "Not pruning network graph, consider enabling `std` or doing so manually with remove_stale_channels_and_tracking_with_time.");
365 log_trace!($logger, "Persisting network graph.");
368 if let Err(e) = $persister.persist_graph(network_graph) {
369 log_error!($logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
374 let prune_timer = if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER };
375 last_prune_call = $get_timer(prune_timer);
378 if $timer_elapsed(&mut last_scorer_persist_call, SCORER_PERSIST_TIMER) {
379 if let Some(ref scorer) = $scorer {
380 log_trace!($logger, "Persisting scorer");
381 if let Err(e) = $persister.persist_scorer(&scorer) {
382 log_error!($logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
385 last_scorer_persist_call = $get_timer(SCORER_PERSIST_TIMER);
388 if $timer_elapsed(&mut last_rebroadcast_call, REBROADCAST_TIMER) {
389 log_trace!($logger, "Rebroadcasting monitor's pending claims");
390 $chain_monitor.rebroadcast_pending_claims();
391 last_rebroadcast_call = $get_timer(REBROADCAST_TIMER);
395 // After we exit, ensure we persist the ChannelManager one final time - this avoids
396 // some races where users quit while channel updates were in-flight, with
397 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
398 $persister.persist_manager(&*$channel_manager)?;
400 // Persist Scorer on exit
401 if let Some(ref scorer) = $scorer {
402 $persister.persist_scorer(&scorer)?;
405 // Persist NetworkGraph on exit
406 if let Some(network_graph) = $gossip_sync.network_graph() {
407 $persister.persist_graph(network_graph)?;
414 #[cfg(feature = "futures")]
415 pub(crate) mod futures_util {
416 use core::future::Future;
417 use core::task::{Poll, Waker, RawWaker, RawWakerVTable};
419 use core::marker::Unpin;
420 pub(crate) struct Selector<
421 A: Future<Output=()> + Unpin, B: Future<Output=()> + Unpin, C: Future<Output=bool> + Unpin
427 pub(crate) enum SelectorOutput {
432 A: Future<Output=()> + Unpin, B: Future<Output=()> + Unpin, C: Future<Output=bool> + Unpin
433 > Future for Selector<A, B, C> {
434 type Output = SelectorOutput;
435 fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<SelectorOutput> {
436 match Pin::new(&mut self.a).poll(ctx) {
437 Poll::Ready(()) => { return Poll::Ready(SelectorOutput::A); },
440 match Pin::new(&mut self.b).poll(ctx) {
441 Poll::Ready(()) => { return Poll::Ready(SelectorOutput::B); },
444 match Pin::new(&mut self.c).poll(ctx) {
445 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
452 // If we want to poll a future without an async context to figure out if it has completed or
453 // not without awaiting, we need a Waker, which needs a vtable...we fill it with dummy values
454 // but sadly there's a good bit of boilerplate here.
455 fn dummy_waker_clone(_: *const ()) -> RawWaker { RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE) }
456 fn dummy_waker_action(_: *const ()) { }
458 const DUMMY_WAKER_VTABLE: RawWakerVTable = RawWakerVTable::new(
459 dummy_waker_clone, dummy_waker_action, dummy_waker_action, dummy_waker_action);
460 pub(crate) fn dummy_waker() -> Waker { unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) } }
462 #[cfg(feature = "futures")]
463 use futures_util::{Selector, SelectorOutput, dummy_waker};
464 #[cfg(feature = "futures")]
467 /// Processes background events in a future.
469 /// `sleeper` should return a future which completes in the given amount of time and returns a
470 /// boolean indicating whether the background processing should exit. Once `sleeper` returns a
471 /// future which outputs `true`, the loop will exit and this function's future will complete.
472 /// The `sleeper` future is free to return early after it has triggered the exit condition.
474 /// See [`BackgroundProcessor::start`] for information on which actions this handles.
476 /// Requires the `futures` feature. Note that while this method is available without the `std`
477 /// feature, doing so will skip calling [`NetworkGraph::remove_stale_channels_and_tracking`],
478 /// you should call [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] regularly
479 /// manually instead.
481 /// The `mobile_interruptable_platform` flag should be set if we're currently running on a
482 /// mobile device, where we may need to check for interruption of the application regularly. If you
483 /// are unsure, you should set the flag, as the performance impact of it is minimal unless there
484 /// are hundreds or thousands of simultaneous process calls running.
486 /// For example, in order to process background events in a [Tokio](https://tokio.rs/) task, you
487 /// could setup `process_events_async` like this:
489 /// # struct MyPersister {}
490 /// # impl lightning::util::persist::KVStorePersister for MyPersister {
491 /// # fn persist<W: lightning::util::ser::Writeable>(&self, key: &str, object: &W) -> lightning::io::Result<()> { Ok(()) }
493 /// # struct MyEventHandler {}
494 /// # impl MyEventHandler {
495 /// # async fn handle_event(&self, _: lightning::events::Event) {}
497 /// # #[derive(Eq, PartialEq, Clone, Hash)]
498 /// # struct MySocketDescriptor {}
499 /// # impl lightning::ln::peer_handler::SocketDescriptor for MySocketDescriptor {
500 /// # fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize { 0 }
501 /// # fn disconnect_socket(&mut self) {}
503 /// # use std::sync::{Arc, Mutex};
504 /// # use std::sync::atomic::{AtomicBool, Ordering};
505 /// # use lightning_background_processor::{process_events_async, GossipSync};
506 /// # type MyBroadcaster = dyn lightning::chain::chaininterface::BroadcasterInterface + Send + Sync;
507 /// # type MyFeeEstimator = dyn lightning::chain::chaininterface::FeeEstimator + Send + Sync;
508 /// # type MyNodeSigner = dyn lightning::chain::keysinterface::NodeSigner + Send + Sync;
509 /// # type MyUtxoLookup = dyn lightning::routing::utxo::UtxoLookup + Send + Sync;
510 /// # type MyFilter = dyn lightning::chain::Filter + Send + Sync;
511 /// # type MyLogger = dyn lightning::util::logger::Logger + Send + Sync;
512 /// # type MyChainMonitor = lightning::chain::chainmonitor::ChainMonitor<lightning::chain::keysinterface::InMemorySigner, Arc<MyFilter>, Arc<MyBroadcaster>, Arc<MyFeeEstimator>, Arc<MyLogger>, Arc<MyPersister>>;
513 /// # type MyPeerManager = lightning::ln::peer_handler::SimpleArcPeerManager<MySocketDescriptor, MyChainMonitor, MyBroadcaster, MyFeeEstimator, MyUtxoLookup, MyLogger>;
514 /// # type MyNetworkGraph = lightning::routing::gossip::NetworkGraph<Arc<MyLogger>>;
515 /// # type MyGossipSync = lightning::routing::gossip::P2PGossipSync<Arc<MyNetworkGraph>, Arc<MyUtxoLookup>, Arc<MyLogger>>;
516 /// # type MyChannelManager = lightning::ln::channelmanager::SimpleArcChannelManager<MyChainMonitor, MyBroadcaster, MyFeeEstimator, MyLogger>;
517 /// # type MyScorer = Mutex<lightning::routing::scoring::ProbabilisticScorer<Arc<MyNetworkGraph>, Arc<MyLogger>>>;
519 /// # async fn setup_background_processing(my_persister: Arc<MyPersister>, my_event_handler: Arc<MyEventHandler>, my_chain_monitor: Arc<MyChainMonitor>, my_channel_manager: Arc<MyChannelManager>, my_gossip_sync: Arc<MyGossipSync>, my_logger: Arc<MyLogger>, my_scorer: Arc<MyScorer>, my_peer_manager: Arc<MyPeerManager>) {
520 /// let background_persister = Arc::clone(&my_persister);
521 /// let background_event_handler = Arc::clone(&my_event_handler);
522 /// let background_chain_mon = Arc::clone(&my_chain_monitor);
523 /// let background_chan_man = Arc::clone(&my_channel_manager);
524 /// let background_gossip_sync = GossipSync::p2p(Arc::clone(&my_gossip_sync));
525 /// let background_peer_man = Arc::clone(&my_peer_manager);
526 /// let background_logger = Arc::clone(&my_logger);
527 /// let background_scorer = Arc::clone(&my_scorer);
529 /// // Setup the sleeper.
530 /// let (stop_sender, stop_receiver) = tokio::sync::watch::channel(());
532 /// let sleeper = move |d| {
533 /// let mut receiver = stop_receiver.clone();
534 /// Box::pin(async move {
536 /// _ = tokio::time::sleep(d) => false,
537 /// _ = receiver.changed() => true,
542 /// let mobile_interruptable_platform = false;
544 /// let handle = tokio::spawn(async move {
545 /// process_events_async(
546 /// background_persister,
547 /// |e| background_event_handler.handle_event(e),
548 /// background_chain_mon,
549 /// background_chan_man,
550 /// background_gossip_sync,
551 /// background_peer_man,
552 /// background_logger,
553 /// Some(background_scorer),
555 /// mobile_interruptable_platform,
558 /// .expect("Failed to process events");
561 /// // Stop the background processing.
562 /// stop_sender.send(()).unwrap();
563 /// handle.await.unwrap();
566 #[cfg(feature = "futures")]
567 pub async fn process_events_async<
569 UL: 'static + Deref + Send + Sync,
570 CF: 'static + Deref + Send + Sync,
571 CW: 'static + Deref + Send + Sync,
572 T: 'static + Deref + Send + Sync,
573 ES: 'static + Deref + Send + Sync,
574 NS: 'static + Deref + Send + Sync,
575 SP: 'static + Deref + Send + Sync,
576 F: 'static + Deref + Send + Sync,
577 R: 'static + Deref + Send + Sync,
578 G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
579 L: 'static + Deref + Send + Sync,
580 P: 'static + Deref + Send + Sync,
581 Descriptor: 'static + SocketDescriptor + Send + Sync,
582 CMH: 'static + Deref + Send + Sync,
583 RMH: 'static + Deref + Send + Sync,
584 OMH: 'static + Deref + Send + Sync,
585 EventHandlerFuture: core::future::Future<Output = ()>,
586 EventHandler: Fn(Event) -> EventHandlerFuture,
587 PS: 'static + Deref + Send,
588 M: 'static + Deref<Target = ChainMonitor<<SP::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
589 CM: 'static + Deref<Target = ChannelManager<CW, T, ES, NS, SP, F, R, L>> + Send + Sync,
590 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send + Sync,
591 RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
592 UMH: 'static + Deref + Send + Sync,
593 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, OMH, L, UMH, NS>> + Send + Sync,
594 S: 'static + Deref<Target = SC> + Send + Sync,
595 SC: for<'b> WriteableScore<'b>,
596 SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
597 Sleeper: Fn(Duration) -> SleepFuture
599 persister: PS, event_handler: EventHandler, chain_monitor: M, channel_manager: CM,
600 gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM, logger: L, scorer: Option<S>,
601 sleeper: Sleeper, mobile_interruptable_platform: bool,
602 ) -> Result<(), lightning::io::Error>
604 UL::Target: 'static + UtxoLookup,
605 CF::Target: 'static + chain::Filter,
606 CW::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
607 T::Target: 'static + BroadcasterInterface,
608 ES::Target: 'static + EntropySource,
609 NS::Target: 'static + NodeSigner,
610 SP::Target: 'static + SignerProvider,
611 F::Target: 'static + FeeEstimator,
612 R::Target: 'static + Router,
613 L::Target: 'static + Logger,
614 P::Target: 'static + Persist<<SP::Target as SignerProvider>::Signer>,
615 CMH::Target: 'static + ChannelMessageHandler,
616 OMH::Target: 'static + OnionMessageHandler,
617 RMH::Target: 'static + RoutingMessageHandler,
618 UMH::Target: 'static + CustomMessageHandler,
619 PS::Target: 'static + Persister<'a, CW, T, ES, NS, SP, F, R, L, SC>,
621 let mut should_break = false;
622 let async_event_handler = |event| {
623 let network_graph = gossip_sync.network_graph();
624 let event_handler = &event_handler;
625 let scorer = &scorer;
627 if let Some(network_graph) = network_graph {
628 handle_network_graph_update(network_graph, &event)
630 if let Some(ref scorer) = scorer {
631 update_scorer(scorer, &event);
633 event_handler(event).await;
636 define_run_body!(persister,
637 chain_monitor, chain_monitor.process_pending_events_async(async_event_handler).await,
638 channel_manager, channel_manager.process_pending_events_async(async_event_handler).await,
639 gossip_sync, peer_manager, logger, scorer, should_break, {
641 a: channel_manager.get_persistable_update_future(),
642 b: chain_monitor.get_update_future(),
643 c: sleeper(if mobile_interruptable_platform { Duration::from_millis(100) } else { Duration::from_secs(FASTEST_TIMER) }),
646 SelectorOutput::A => true,
647 SelectorOutput::B => false,
648 SelectorOutput::C(exit) => {
653 }, |t| sleeper(Duration::from_secs(t)),
654 |fut: &mut SleepFuture, _| {
655 let mut waker = dummy_waker();
656 let mut ctx = task::Context::from_waker(&mut waker);
657 match core::pin::Pin::new(fut).poll(&mut ctx) {
658 task::Poll::Ready(exit) => { should_break = exit; true },
659 task::Poll::Pending => false,
661 }, mobile_interruptable_platform)
664 #[cfg(feature = "std")]
665 impl BackgroundProcessor {
666 /// Start a background thread that takes care of responsibilities enumerated in the [top-level
669 /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
670 /// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
671 /// either [`join`] or [`stop`].
673 /// # Data Persistence
675 /// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
676 /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
677 /// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
678 /// provided implementation.
680 /// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if
681 /// [`GossipSync`] is supplied. See [`NetworkGraph::write`] for writing out a [`NetworkGraph`].
682 /// See the `lightning-persister` crate for LDK's provided implementation.
684 /// Typically, users should either implement [`Persister::persist_manager`] to never return an
685 /// error or call [`join`] and handle any error that may arise. For the latter case,
686 /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
690 /// `event_handler` is responsible for handling events that users should be notified of (e.g.,
691 /// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
692 /// functionality implemented by other handlers.
693 /// * [`P2PGossipSync`] if given will update the [`NetworkGraph`] based on payment failures.
695 /// # Rapid Gossip Sync
697 /// If rapid gossip sync is meant to run at startup, pass [`RapidGossipSync`] via `gossip_sync`
698 /// to indicate that the [`BackgroundProcessor`] should not prune the [`NetworkGraph`] instance
699 /// until the [`RapidGossipSync`] instance completes its first sync.
701 /// [top-level documentation]: BackgroundProcessor
702 /// [`join`]: Self::join
703 /// [`stop`]: Self::stop
704 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
705 /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
706 /// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
707 /// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
708 /// [`NetworkGraph`]: lightning::routing::gossip::NetworkGraph
709 /// [`NetworkGraph::write`]: lightning::routing::gossip::NetworkGraph#impl-Writeable
712 UL: 'static + Deref + Send + Sync,
713 CF: 'static + Deref + Send + Sync,
714 CW: 'static + Deref + Send + Sync,
715 T: 'static + Deref + Send + Sync,
716 ES: 'static + Deref + Send + Sync,
717 NS: 'static + Deref + Send + Sync,
718 SP: 'static + Deref + Send + Sync,
719 F: 'static + Deref + Send + Sync,
720 R: 'static + Deref + Send + Sync,
721 G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
722 L: 'static + Deref + Send + Sync,
723 P: 'static + Deref + Send + Sync,
724 Descriptor: 'static + SocketDescriptor + Send + Sync,
725 CMH: 'static + Deref + Send + Sync,
726 OMH: 'static + Deref + Send + Sync,
727 RMH: 'static + Deref + Send + Sync,
728 EH: 'static + EventHandler + Send,
729 PS: 'static + Deref + Send,
730 M: 'static + Deref<Target = ChainMonitor<<SP::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
731 CM: 'static + Deref<Target = ChannelManager<CW, T, ES, NS, SP, F, R, L>> + Send + Sync,
732 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send + Sync,
733 RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
734 UMH: 'static + Deref + Send + Sync,
735 PM: 'static + Deref<Target = PeerManager<Descriptor, CMH, RMH, OMH, L, UMH, NS>> + Send + Sync,
736 S: 'static + Deref<Target = SC> + Send + Sync,
737 SC: for <'b> WriteableScore<'b>,
739 persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
740 gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM, logger: L, scorer: Option<S>,
743 UL::Target: 'static + UtxoLookup,
744 CF::Target: 'static + chain::Filter,
745 CW::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
746 T::Target: 'static + BroadcasterInterface,
747 ES::Target: 'static + EntropySource,
748 NS::Target: 'static + NodeSigner,
749 SP::Target: 'static + SignerProvider,
750 F::Target: 'static + FeeEstimator,
751 R::Target: 'static + Router,
752 L::Target: 'static + Logger,
753 P::Target: 'static + Persist<<SP::Target as SignerProvider>::Signer>,
754 CMH::Target: 'static + ChannelMessageHandler,
755 OMH::Target: 'static + OnionMessageHandler,
756 RMH::Target: 'static + RoutingMessageHandler,
757 UMH::Target: 'static + CustomMessageHandler,
758 PS::Target: 'static + Persister<'a, CW, T, ES, NS, SP, F, R, L, SC>,
760 let stop_thread = Arc::new(AtomicBool::new(false));
761 let stop_thread_clone = stop_thread.clone();
762 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
763 let event_handler = |event| {
764 let network_graph = gossip_sync.network_graph();
765 if let Some(network_graph) = network_graph {
766 handle_network_graph_update(network_graph, &event)
768 if let Some(ref scorer) = scorer {
769 update_scorer(scorer, &event);
771 event_handler.handle_event(event);
773 define_run_body!(persister, chain_monitor, chain_monitor.process_pending_events(&event_handler),
774 channel_manager, channel_manager.process_pending_events(&event_handler),
775 gossip_sync, peer_manager, logger, scorer, stop_thread.load(Ordering::Acquire),
776 Sleeper::from_two_futures(
777 channel_manager.get_persistable_update_future(),
778 chain_monitor.get_update_future()
779 ).wait_timeout(Duration::from_millis(100)),
780 |_| Instant::now(), |time: &Instant, dur| time.elapsed().as_secs() > dur, false)
782 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
785 /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
786 /// [`ChannelManager`].
790 /// This function panics if the background thread has panicked such as while persisting or
793 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
794 pub fn join(mut self) -> Result<(), std::io::Error> {
795 assert!(self.thread_handle.is_some());
799 /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
800 /// [`ChannelManager`].
804 /// This function panics if the background thread has panicked such as while persisting or
807 /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
808 pub fn stop(mut self) -> Result<(), std::io::Error> {
809 assert!(self.thread_handle.is_some());
810 self.stop_and_join_thread()
813 fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
814 self.stop_thread.store(true, Ordering::Release);
818 fn join_thread(&mut self) -> Result<(), std::io::Error> {
819 match self.thread_handle.take() {
820 Some(handle) => handle.join().unwrap(),
826 #[cfg(feature = "std")]
827 impl Drop for BackgroundProcessor {
829 self.stop_and_join_thread().unwrap();
833 #[cfg(all(feature = "std", test))]
835 use bitcoin::blockdata::block::BlockHeader;
836 use bitcoin::blockdata::constants::genesis_block;
837 use bitcoin::blockdata::locktime::PackedLockTime;
838 use bitcoin::blockdata::transaction::{Transaction, TxOut};
839 use bitcoin::network::constants::Network;
840 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1};
841 use lightning::chain::{BestBlock, Confirm, chainmonitor};
842 use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
843 use lightning::chain::keysinterface::{InMemorySigner, KeysManager};
844 use lightning::chain::transaction::OutPoint;
845 use lightning::events::{Event, PathFailure, MessageSendEventsProvider, MessageSendEvent};
846 use lightning::{get_event_msg, get_event};
847 use lightning::ln::PaymentHash;
848 use lightning::ln::channelmanager;
849 use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, MIN_CLTV_EXPIRY_DELTA, PaymentId};
850 use lightning::ln::features::{ChannelFeatures, NodeFeatures};
851 use lightning::ln::msgs::{ChannelMessageHandler, Init};
852 use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
853 use lightning::routing::gossip::{NetworkGraph, NodeId, P2PGossipSync};
854 use lightning::routing::router::{DefaultRouter, Path, RouteHop};
855 use lightning::routing::scoring::{ChannelUsage, Score};
856 use lightning::util::config::UserConfig;
857 use lightning::util::ser::Writeable;
858 use lightning::util::test_utils;
859 use lightning::util::persist::KVStorePersister;
860 use lightning_persister::FilesystemPersister;
861 use std::collections::VecDeque;
863 use std::path::PathBuf;
864 use std::sync::{Arc, Mutex};
865 use std::sync::mpsc::SyncSender;
866 use std::time::Duration;
867 use bitcoin::hashes::Hash;
868 use bitcoin::TxMerkleNode;
869 use lightning_rapid_gossip_sync::RapidGossipSync;
870 use super::{BackgroundProcessor, GossipSync, FRESHNESS_TIMER};
872 const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
874 #[derive(Clone, Hash, PartialEq, Eq)]
875 struct TestDescriptor{}
876 impl SocketDescriptor for TestDescriptor {
877 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
881 fn disconnect_socket(&mut self) {}
884 type ChannelManager = channelmanager::ChannelManager<Arc<ChainMonitor>, Arc<test_utils::TestBroadcaster>, Arc<KeysManager>, Arc<KeysManager>, Arc<KeysManager>, Arc<test_utils::TestFeeEstimator>, Arc<DefaultRouter< Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestLogger>, Arc<Mutex<TestScorer>>>>, Arc<test_utils::TestLogger>>;
886 type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
888 type PGS = Arc<P2PGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>>;
889 type RGS = Arc<RapidGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestLogger>>>;
892 node: Arc<ChannelManager>,
893 p2p_gossip_sync: PGS,
894 rapid_gossip_sync: RGS,
895 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, IgnoringMessageHandler, Arc<test_utils::TestLogger>, IgnoringMessageHandler, Arc<KeysManager>>>,
896 chain_monitor: Arc<ChainMonitor>,
897 persister: Arc<FilesystemPersister>,
898 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
899 network_graph: Arc<NetworkGraph<Arc<test_utils::TestLogger>>>,
900 logger: Arc<test_utils::TestLogger>,
901 best_block: BestBlock,
902 scorer: Arc<Mutex<TestScorer>>,
906 fn p2p_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
907 GossipSync::P2P(self.p2p_gossip_sync.clone())
910 fn rapid_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
911 GossipSync::Rapid(self.rapid_gossip_sync.clone())
914 fn no_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
921 let data_dir = self.persister.get_data_dir();
922 match fs::remove_dir_all(data_dir.clone()) {
923 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
930 graph_error: Option<(std::io::ErrorKind, &'static str)>,
931 graph_persistence_notifier: Option<SyncSender<()>>,
932 manager_error: Option<(std::io::ErrorKind, &'static str)>,
933 scorer_error: Option<(std::io::ErrorKind, &'static str)>,
934 filesystem_persister: FilesystemPersister,
938 fn new(data_dir: String) -> Self {
939 let filesystem_persister = FilesystemPersister::new(data_dir);
940 Self { graph_error: None, graph_persistence_notifier: None, manager_error: None, scorer_error: None, filesystem_persister }
943 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
944 Self { graph_error: Some((error, message)), ..self }
947 fn with_graph_persistence_notifier(self, sender: SyncSender<()>) -> Self {
948 Self { graph_persistence_notifier: Some(sender), ..self }
951 fn with_manager_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
952 Self { manager_error: Some((error, message)), ..self }
955 fn with_scorer_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
956 Self { scorer_error: Some((error, message)), ..self }
960 impl KVStorePersister for Persister {
961 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
962 if key == "manager" {
963 if let Some((error, message)) = self.manager_error {
964 return Err(std::io::Error::new(error, message))
968 if key == "network_graph" {
969 if let Some(sender) = &self.graph_persistence_notifier {
970 match sender.send(()) {
972 Err(std::sync::mpsc::SendError(())) => println!("Persister failed to notify as receiver went away."),
976 if let Some((error, message)) = self.graph_error {
977 return Err(std::io::Error::new(error, message))
982 if let Some((error, message)) = self.scorer_error {
983 return Err(std::io::Error::new(error, message))
987 self.filesystem_persister.persist(key, object)
992 event_expectations: Option<VecDeque<TestResult>>,
997 PaymentFailure { path: Path, short_channel_id: u64 },
998 PaymentSuccess { path: Path },
999 ProbeFailure { path: Path },
1000 ProbeSuccess { path: Path },
1005 Self { event_expectations: None }
1008 fn expect(&mut self, expectation: TestResult) {
1009 self.event_expectations.get_or_insert_with(VecDeque::new).push_back(expectation);
1013 impl lightning::util::ser::Writeable for TestScorer {
1014 fn write<W: lightning::util::ser::Writer>(&self, _: &mut W) -> Result<(), lightning::io::Error> { Ok(()) }
1017 impl Score for TestScorer {
1018 fn channel_penalty_msat(
1019 &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, _usage: ChannelUsage
1020 ) -> u64 { unimplemented!(); }
1022 fn payment_path_failed(&mut self, actual_path: &Path, actual_short_channel_id: u64) {
1023 if let Some(expectations) = &mut self.event_expectations {
1024 match expectations.pop_front().unwrap() {
1025 TestResult::PaymentFailure { path, short_channel_id } => {
1026 assert_eq!(actual_path, &path);
1027 assert_eq!(actual_short_channel_id, short_channel_id);
1029 TestResult::PaymentSuccess { path } => {
1030 panic!("Unexpected successful payment path: {:?}", path)
1032 TestResult::ProbeFailure { path } => {
1033 panic!("Unexpected probe failure: {:?}", path)
1035 TestResult::ProbeSuccess { path } => {
1036 panic!("Unexpected probe success: {:?}", path)
1042 fn payment_path_successful(&mut self, actual_path: &Path) {
1043 if let Some(expectations) = &mut self.event_expectations {
1044 match expectations.pop_front().unwrap() {
1045 TestResult::PaymentFailure { path, .. } => {
1046 panic!("Unexpected payment path failure: {:?}", path)
1048 TestResult::PaymentSuccess { path } => {
1049 assert_eq!(actual_path, &path);
1051 TestResult::ProbeFailure { path } => {
1052 panic!("Unexpected probe failure: {:?}", path)
1054 TestResult::ProbeSuccess { path } => {
1055 panic!("Unexpected probe success: {:?}", path)
1061 fn probe_failed(&mut self, actual_path: &Path, _: u64) {
1062 if let Some(expectations) = &mut self.event_expectations {
1063 match expectations.pop_front().unwrap() {
1064 TestResult::PaymentFailure { path, .. } => {
1065 panic!("Unexpected payment path failure: {:?}", path)
1067 TestResult::PaymentSuccess { path } => {
1068 panic!("Unexpected payment path success: {:?}", path)
1070 TestResult::ProbeFailure { path } => {
1071 assert_eq!(actual_path, &path);
1073 TestResult::ProbeSuccess { path } => {
1074 panic!("Unexpected probe success: {:?}", path)
1079 fn probe_successful(&mut self, actual_path: &Path) {
1080 if let Some(expectations) = &mut self.event_expectations {
1081 match expectations.pop_front().unwrap() {
1082 TestResult::PaymentFailure { path, .. } => {
1083 panic!("Unexpected payment path failure: {:?}", path)
1085 TestResult::PaymentSuccess { path } => {
1086 panic!("Unexpected payment path success: {:?}", path)
1088 TestResult::ProbeFailure { path } => {
1089 panic!("Unexpected probe failure: {:?}", path)
1091 TestResult::ProbeSuccess { path } => {
1092 assert_eq!(actual_path, &path);
1099 impl Drop for TestScorer {
1100 fn drop(&mut self) {
1101 if std::thread::panicking() {
1105 if let Some(event_expectations) = &self.event_expectations {
1106 if !event_expectations.is_empty() {
1107 panic!("Unsatisfied event expectations: {:?}", event_expectations);
1113 fn get_full_filepath(filepath: String, filename: String) -> String {
1114 let mut path = PathBuf::from(filepath);
1115 path.push(filename);
1116 path.to_str().unwrap().to_string()
1119 fn create_nodes(num_nodes: usize, persist_dir: String) -> Vec<Node> {
1120 let network = Network::Testnet;
1121 let mut nodes = Vec::new();
1122 for i in 0..num_nodes {
1123 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster::new(network));
1124 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
1125 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
1126 let genesis_block = genesis_block(network);
1127 let network_graph = Arc::new(NetworkGraph::new(network, logger.clone()));
1128 let scorer = Arc::new(Mutex::new(TestScorer::new()));
1129 let seed = [i as u8; 32];
1130 let router = Arc::new(DefaultRouter::new(network_graph.clone(), logger.clone(), seed, scorer.clone()));
1131 let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Testnet));
1132 let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", persist_dir, i)));
1133 let now = Duration::from_secs(genesis_block.header.time as u64);
1134 let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
1135 let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
1136 let best_block = BestBlock::from_network(network);
1137 let params = ChainParameters { network, best_block };
1138 let manager = Arc::new(ChannelManager::new(fee_estimator.clone(), chain_monitor.clone(), tx_broadcaster.clone(), router.clone(), logger.clone(), keys_manager.clone(), keys_manager.clone(), keys_manager.clone(), UserConfig::default(), params));
1139 let p2p_gossip_sync = Arc::new(P2PGossipSync::new(network_graph.clone(), Some(chain_source.clone()), logger.clone()));
1140 let rapid_gossip_sync = Arc::new(RapidGossipSync::new(network_graph.clone(), logger.clone()));
1141 let msg_handler = MessageHandler { chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new()), route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new()), onion_message_handler: IgnoringMessageHandler{}};
1142 let peer_manager = Arc::new(PeerManager::new(msg_handler, 0, &seed, logger.clone(), IgnoringMessageHandler{}, keys_manager.clone()));
1143 let node = Node { node: manager, p2p_gossip_sync, rapid_gossip_sync, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block, scorer };
1147 for i in 0..num_nodes {
1148 for j in (i+1)..num_nodes {
1149 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &Init { features: nodes[j].node.init_features(), remote_network_address: None }, true).unwrap();
1150 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &Init { features: nodes[i].node.init_features(), remote_network_address: None }, false).unwrap();
1157 macro_rules! open_channel {
1158 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
1159 begin_open_channel!($node_a, $node_b, $channel_value);
1160 let events = $node_a.node.get_and_clear_pending_events();
1161 assert_eq!(events.len(), 1);
1162 let (temporary_channel_id, tx) = handle_funding_generation_ready!(events[0], $channel_value);
1163 $node_a.node.funding_transaction_generated(&temporary_channel_id, &$node_b.node.get_our_node_id(), tx.clone()).unwrap();
1164 $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()));
1165 get_event!($node_b, Event::ChannelPending);
1166 $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()));
1167 get_event!($node_a, Event::ChannelPending);
1172 macro_rules! begin_open_channel {
1173 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
1174 $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
1175 $node_b.node.handle_open_channel(&$node_a.node.get_our_node_id(), &get_event_msg!($node_a, MessageSendEvent::SendOpenChannel, $node_b.node.get_our_node_id()));
1176 $node_a.node.handle_accept_channel(&$node_b.node.get_our_node_id(), &get_event_msg!($node_b, MessageSendEvent::SendAcceptChannel, $node_a.node.get_our_node_id()));
1180 macro_rules! handle_funding_generation_ready {
1181 ($event: expr, $channel_value: expr) => {{
1183 Event::FundingGenerationReady { temporary_channel_id, channel_value_satoshis, ref output_script, user_channel_id, .. } => {
1184 assert_eq!(channel_value_satoshis, $channel_value);
1185 assert_eq!(user_channel_id, 42);
1187 let tx = Transaction { version: 1 as i32, lock_time: PackedLockTime(0), input: Vec::new(), output: vec![TxOut {
1188 value: channel_value_satoshis, script_pubkey: output_script.clone(),
1190 (temporary_channel_id, tx)
1192 _ => panic!("Unexpected event"),
1197 fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
1198 for i in 1..=depth {
1199 let prev_blockhash = node.best_block.block_hash();
1200 let height = node.best_block.height() + 1;
1201 let header = BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 };
1202 let txdata = vec![(0, tx)];
1203 node.best_block = BestBlock::new(header.block_hash(), height);
1206 node.node.transactions_confirmed(&header, &txdata, height);
1207 node.chain_monitor.transactions_confirmed(&header, &txdata, height);
1209 x if x == depth => {
1210 node.node.best_block_updated(&header, height);
1211 node.chain_monitor.best_block_updated(&header, height);
1217 fn confirm_transaction(node: &mut Node, tx: &Transaction) {
1218 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
1222 fn test_background_processor() {
1223 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
1224 // updates. Also test that when new updates are available, the manager signals that it needs
1225 // re-persistence and is successfully re-persisted.
1226 let nodes = create_nodes(2, "test_background_processor".to_string());
1228 // Go through the channel creation process so that each node has something to persist. Since
1229 // open_channel consumes events, it must complete before starting BackgroundProcessor to
1230 // avoid a race with processing events.
1231 let tx = open_channel!(nodes[0], nodes[1], 100000);
1233 // Initiate the background processors to watch each node.
1234 let data_dir = nodes[0].persister.get_data_dir();
1235 let persister = Arc::new(Persister::new(data_dir));
1236 let event_handler = |_: _| {};
1237 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].p2p_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1239 macro_rules! check_persisted_data {
1240 ($node: expr, $filepath: expr) => {
1241 let mut expected_bytes = Vec::new();
1243 expected_bytes.clear();
1244 match $node.write(&mut expected_bytes) {
1246 match std::fs::read($filepath) {
1248 if bytes == expected_bytes {
1257 Err(e) => panic!("Unexpected error: {}", e)
1263 // Check that the initial channel manager data is persisted as expected.
1264 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "manager".to_string());
1265 check_persisted_data!(nodes[0].node, filepath.clone());
1268 if !nodes[0].node.get_persistence_condvar_value() { break }
1271 // Force-close the channel.
1272 nodes[0].node.force_close_broadcasting_latest_txn(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id(), &nodes[1].node.get_our_node_id()).unwrap();
1274 // Check that the force-close updates are persisted.
1275 check_persisted_data!(nodes[0].node, filepath.clone());
1277 if !nodes[0].node.get_persistence_condvar_value() { break }
1280 // Check network graph is persisted
1281 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "network_graph".to_string());
1282 check_persisted_data!(nodes[0].network_graph, filepath.clone());
1284 // Check scorer is persisted
1285 let filepath = get_full_filepath("test_background_processor_persister_0".to_string(), "scorer".to_string());
1286 check_persisted_data!(nodes[0].scorer, filepath.clone());
1288 if !std::thread::panicking() {
1289 bg_processor.stop().unwrap();
1294 fn test_timer_tick_called() {
1295 // Test that `ChannelManager::timer_tick_occurred` is called every `FRESHNESS_TIMER`,
1296 // `ChainMonitor::rebroadcast_pending_claims` is called every `REBROADCAST_TIMER`, and
1297 // `PeerManager::timer_tick_occurred` every `PING_TIMER`.
1298 let nodes = create_nodes(1, "test_timer_tick_called".to_string());
1299 let data_dir = nodes[0].persister.get_data_dir();
1300 let persister = Arc::new(Persister::new(data_dir));
1301 let event_handler = |_: _| {};
1302 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1304 let log_entries = nodes[0].logger.lines.lock().unwrap();
1305 let desired_log_1 = "Calling ChannelManager's timer_tick_occurred".to_string();
1306 let desired_log_2 = "Calling PeerManager's timer_tick_occurred".to_string();
1307 let desired_log_3 = "Rebroadcasting monitor's pending claims".to_string();
1308 if log_entries.get(&("lightning_background_processor".to_string(), desired_log_1)).is_some() &&
1309 log_entries.get(&("lightning_background_processor".to_string(), desired_log_2)).is_some() &&
1310 log_entries.get(&("lightning_background_processor".to_string(), desired_log_3)).is_some() {
1315 if !std::thread::panicking() {
1316 bg_processor.stop().unwrap();
1321 fn test_channel_manager_persist_error() {
1322 // Test that if we encounter an error during manager persistence, the thread panics.
1323 let nodes = create_nodes(2, "test_persist_error".to_string());
1324 open_channel!(nodes[0], nodes[1], 100000);
1326 let data_dir = nodes[0].persister.get_data_dir();
1327 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
1328 let event_handler = |_: _| {};
1329 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1330 match bg_processor.join() {
1331 Ok(_) => panic!("Expected error persisting manager"),
1333 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1334 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1340 #[cfg(feature = "futures")]
1341 async fn test_channel_manager_persist_error_async() {
1342 // Test that if we encounter an error during manager persistence, the thread panics.
1343 let nodes = create_nodes(2, "test_persist_error_sync".to_string());
1344 open_channel!(nodes[0], nodes[1], 100000);
1346 let data_dir = nodes[0].persister.get_data_dir();
1347 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
1349 let bp_future = super::process_events_async(
1350 persister, |_: _| {async {}}, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1351 nodes[0].rapid_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1352 Some(nodes[0].scorer.clone()), move |dur: Duration| {
1353 Box::pin(async move {
1354 tokio::time::sleep(dur).await;
1359 match bp_future.await {
1360 Ok(_) => panic!("Expected error persisting manager"),
1362 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1363 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1369 fn test_network_graph_persist_error() {
1370 // Test that if we encounter an error during network graph persistence, an error gets returned.
1371 let nodes = create_nodes(2, "test_persist_network_graph_error".to_string());
1372 let data_dir = nodes[0].persister.get_data_dir();
1373 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
1374 let event_handler = |_: _| {};
1375 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].p2p_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1377 match bg_processor.stop() {
1378 Ok(_) => panic!("Expected error persisting network graph"),
1380 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1381 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1387 fn test_scorer_persist_error() {
1388 // Test that if we encounter an error during scorer persistence, an error gets returned.
1389 let nodes = create_nodes(2, "test_persist_scorer_error".to_string());
1390 let data_dir = nodes[0].persister.get_data_dir();
1391 let persister = Arc::new(Persister::new(data_dir).with_scorer_error(std::io::ErrorKind::Other, "test"));
1392 let event_handler = |_: _| {};
1393 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1395 match bg_processor.stop() {
1396 Ok(_) => panic!("Expected error persisting scorer"),
1398 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1399 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1405 fn test_background_event_handling() {
1406 let mut nodes = create_nodes(2, "test_background_event_handling".to_string());
1407 let channel_value = 100000;
1408 let data_dir = nodes[0].persister.get_data_dir();
1409 let persister = Arc::new(Persister::new(data_dir.clone()));
1411 // Set up a background event handler for FundingGenerationReady events.
1412 let (funding_generation_send, funding_generation_recv) = std::sync::mpsc::sync_channel(1);
1413 let (channel_pending_send, channel_pending_recv) = std::sync::mpsc::sync_channel(1);
1414 let event_handler = move |event: Event| match event {
1415 Event::FundingGenerationReady { .. } => funding_generation_send.send(handle_funding_generation_ready!(event, channel_value)).unwrap(),
1416 Event::ChannelPending { .. } => channel_pending_send.send(()).unwrap(),
1417 Event::ChannelReady { .. } => {},
1418 _ => panic!("Unexpected event: {:?}", event),
1421 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1423 // Open a channel and check that the FundingGenerationReady event was handled.
1424 begin_open_channel!(nodes[0], nodes[1], channel_value);
1425 let (temporary_channel_id, funding_tx) = funding_generation_recv
1426 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1427 .expect("FundingGenerationReady not handled within deadline");
1428 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1429 nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id()));
1430 get_event!(nodes[1], Event::ChannelPending);
1431 nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id()));
1432 let _ = channel_pending_recv.recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1433 .expect("ChannelPending not handled within deadline");
1435 // Confirm the funding transaction.
1436 confirm_transaction(&mut nodes[0], &funding_tx);
1437 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
1438 confirm_transaction(&mut nodes[1], &funding_tx);
1439 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
1440 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &bs_funding);
1441 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1442 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_funding);
1443 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1445 if !std::thread::panicking() {
1446 bg_processor.stop().unwrap();
1449 // Set up a background event handler for SpendableOutputs events.
1450 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1451 let event_handler = move |event: Event| match event {
1452 Event::SpendableOutputs { .. } => sender.send(event).unwrap(),
1453 Event::ChannelReady { .. } => {},
1454 Event::ChannelClosed { .. } => {},
1455 _ => panic!("Unexpected event: {:?}", event),
1457 let persister = Arc::new(Persister::new(data_dir));
1458 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1460 // Force close the channel and check that the SpendableOutputs event was handled.
1461 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1462 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
1463 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
1465 let event = receiver
1466 .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1467 .expect("Events not handled within deadline");
1469 Event::SpendableOutputs { .. } => {},
1470 _ => panic!("Unexpected event: {:?}", event),
1473 if !std::thread::panicking() {
1474 bg_processor.stop().unwrap();
1479 fn test_scorer_persistence() {
1480 let nodes = create_nodes(2, "test_scorer_persistence".to_string());
1481 let data_dir = nodes[0].persister.get_data_dir();
1482 let persister = Arc::new(Persister::new(data_dir));
1483 let event_handler = |_: _| {};
1484 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1487 let log_entries = nodes[0].logger.lines.lock().unwrap();
1488 let expected_log = "Persisting scorer".to_string();
1489 if log_entries.get(&("lightning_background_processor".to_string(), expected_log)).is_some() {
1494 if !std::thread::panicking() {
1495 bg_processor.stop().unwrap();
1499 macro_rules! do_test_not_pruning_network_graph_until_graph_sync_completion {
1500 ($nodes: expr, $receive: expr, $sleep: expr) => {
1501 let features = ChannelFeatures::empty();
1502 $nodes[0].network_graph.add_channel_from_partial_announcement(
1503 42, 53, features, $nodes[0].node.get_our_node_id(), $nodes[1].node.get_our_node_id()
1504 ).expect("Failed to update channel from partial announcement");
1505 let original_graph_description = $nodes[0].network_graph.to_string();
1506 assert!(original_graph_description.contains("42: features: 0000, node_one:"));
1507 assert_eq!($nodes[0].network_graph.read_only().channels().len(), 1);
1511 let log_entries = $nodes[0].logger.lines.lock().unwrap();
1512 let loop_counter = "Calling ChannelManager's timer_tick_occurred".to_string();
1513 if *log_entries.get(&("lightning_background_processor".to_string(), loop_counter))
1516 // Wait until the loop has gone around at least twice.
1521 let initialization_input = vec![
1522 76, 68, 75, 1, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247,
1523 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 97, 227, 98, 218,
1524 0, 0, 0, 4, 2, 22, 7, 207, 206, 25, 164, 197, 231, 230, 231, 56, 102, 61, 250, 251,
1525 187, 172, 38, 46, 79, 247, 108, 44, 155, 48, 219, 238, 252, 53, 192, 6, 67, 2, 36, 125,
1526 157, 176, 223, 175, 234, 116, 94, 248, 201, 225, 97, 235, 50, 47, 115, 172, 63, 136,
1527 88, 216, 115, 11, 111, 217, 114, 84, 116, 124, 231, 107, 2, 158, 1, 242, 121, 152, 106,
1528 204, 131, 186, 35, 93, 70, 216, 10, 237, 224, 183, 89, 95, 65, 3, 83, 185, 58, 138,
1529 181, 64, 187, 103, 127, 68, 50, 2, 201, 19, 17, 138, 136, 149, 185, 226, 156, 137, 175,
1530 110, 32, 237, 0, 217, 90, 31, 100, 228, 149, 46, 219, 175, 168, 77, 4, 143, 38, 128,
1531 76, 97, 0, 0, 0, 2, 0, 0, 255, 8, 153, 192, 0, 2, 27, 0, 0, 0, 1, 0, 0, 255, 2, 68,
1532 226, 0, 6, 11, 0, 1, 2, 3, 0, 0, 0, 2, 0, 40, 0, 0, 0, 0, 0, 0, 3, 232, 0, 0, 3, 232,
1533 0, 0, 0, 1, 0, 0, 0, 0, 58, 85, 116, 216, 255, 8, 153, 192, 0, 2, 27, 0, 0, 25, 0, 0,
1534 0, 1, 0, 0, 0, 125, 255, 2, 68, 226, 0, 6, 11, 0, 1, 5, 0, 0, 0, 0, 29, 129, 25, 192,
1536 $nodes[0].rapid_gossip_sync.update_network_graph_no_std(&initialization_input[..], Some(1642291930)).unwrap();
1538 // this should have added two channels and pruned the previous one.
1539 assert_eq!($nodes[0].network_graph.read_only().channels().len(), 2);
1541 $receive.expect("Network graph not pruned within deadline");
1543 // all channels should now be pruned
1544 assert_eq!($nodes[0].network_graph.read_only().channels().len(), 0);
1549 fn test_not_pruning_network_graph_until_graph_sync_completion() {
1550 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1552 let nodes = create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion".to_string());
1553 let data_dir = nodes[0].persister.get_data_dir();
1554 let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
1556 let event_handler = |_: _| {};
1557 let background_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].rapid_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1559 do_test_not_pruning_network_graph_until_graph_sync_completion!(nodes,
1560 receiver.recv_timeout(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER * 5)),
1561 std::thread::sleep(Duration::from_millis(1)));
1563 background_processor.stop().unwrap();
1567 #[cfg(feature = "futures")]
1568 async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
1569 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1571 let nodes = create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion_async".to_string());
1572 let data_dir = nodes[0].persister.get_data_dir();
1573 let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
1575 let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
1576 let bp_future = super::process_events_async(
1577 persister, |_: _| {async {}}, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1578 nodes[0].rapid_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1579 Some(nodes[0].scorer.clone()), move |dur: Duration| {
1580 let mut exit_receiver = exit_receiver.clone();
1581 Box::pin(async move {
1583 _ = tokio::time::sleep(dur) => false,
1584 _ = exit_receiver.changed() => true,
1590 let t1 = tokio::spawn(bp_future);
1591 let t2 = tokio::spawn(async move {
1592 do_test_not_pruning_network_graph_until_graph_sync_completion!(nodes, {
1595 tokio::time::sleep(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER)).await;
1596 if let Ok(()) = receiver.try_recv() { break Ok::<(), ()>(()); }
1600 }, tokio::time::sleep(Duration::from_millis(1)).await);
1601 exit_sender.send(()).unwrap();
1603 let (r1, r2) = tokio::join!(t1, t2);
1604 r1.unwrap().unwrap();
1608 macro_rules! do_test_payment_path_scoring {
1609 ($nodes: expr, $receive: expr) => {
1610 // Ensure that we update the scorer when relevant events are processed. In this case, we ensure
1611 // that we update the scorer upon a payment path succeeding (note that the channel must be
1612 // public or else we won't score it).
1613 // A background event handler for FundingGenerationReady events must be hooked up to a
1614 // running background processor.
1615 let scored_scid = 4242;
1616 let secp_ctx = Secp256k1::new();
1617 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
1618 let node_1_id = PublicKey::from_secret_key(&secp_ctx, &node_1_privkey);
1620 let path = Path { hops: vec![RouteHop {
1622 node_features: NodeFeatures::empty(),
1623 short_channel_id: scored_scid,
1624 channel_features: ChannelFeatures::empty(),
1626 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA as u32,
1627 }], blinded_tail: None };
1629 $nodes[0].scorer.lock().unwrap().expect(TestResult::PaymentFailure { path: path.clone(), short_channel_id: scored_scid });
1630 $nodes[0].node.push_pending_event(Event::PaymentPathFailed {
1632 payment_hash: PaymentHash([42; 32]),
1633 payment_failed_permanently: false,
1634 failure: PathFailure::OnPath { network_update: None },
1636 short_channel_id: Some(scored_scid),
1638 let event = $receive.expect("PaymentPathFailed not handled within deadline");
1640 Event::PaymentPathFailed { .. } => {},
1641 _ => panic!("Unexpected event"),
1644 // Ensure we'll score payments that were explicitly failed back by the destination as
1646 $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeSuccess { path: path.clone() });
1647 $nodes[0].node.push_pending_event(Event::PaymentPathFailed {
1649 payment_hash: PaymentHash([42; 32]),
1650 payment_failed_permanently: true,
1651 failure: PathFailure::OnPath { network_update: None },
1653 short_channel_id: None,
1655 let event = $receive.expect("PaymentPathFailed not handled within deadline");
1657 Event::PaymentPathFailed { .. } => {},
1658 _ => panic!("Unexpected event"),
1661 $nodes[0].scorer.lock().unwrap().expect(TestResult::PaymentSuccess { path: path.clone() });
1662 $nodes[0].node.push_pending_event(Event::PaymentPathSuccessful {
1663 payment_id: PaymentId([42; 32]),
1667 let event = $receive.expect("PaymentPathSuccessful not handled within deadline");
1669 Event::PaymentPathSuccessful { .. } => {},
1670 _ => panic!("Unexpected event"),
1673 $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeSuccess { path: path.clone() });
1674 $nodes[0].node.push_pending_event(Event::ProbeSuccessful {
1675 payment_id: PaymentId([42; 32]),
1676 payment_hash: PaymentHash([42; 32]),
1679 let event = $receive.expect("ProbeSuccessful not handled within deadline");
1681 Event::ProbeSuccessful { .. } => {},
1682 _ => panic!("Unexpected event"),
1685 $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeFailure { path: path.clone() });
1686 $nodes[0].node.push_pending_event(Event::ProbeFailed {
1687 payment_id: PaymentId([42; 32]),
1688 payment_hash: PaymentHash([42; 32]),
1690 short_channel_id: Some(scored_scid),
1692 let event = $receive.expect("ProbeFailure not handled within deadline");
1694 Event::ProbeFailed { .. } => {},
1695 _ => panic!("Unexpected event"),
1701 fn test_payment_path_scoring() {
1702 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1703 let event_handler = move |event: Event| match event {
1704 Event::PaymentPathFailed { .. } => sender.send(event).unwrap(),
1705 Event::PaymentPathSuccessful { .. } => sender.send(event).unwrap(),
1706 Event::ProbeSuccessful { .. } => sender.send(event).unwrap(),
1707 Event::ProbeFailed { .. } => sender.send(event).unwrap(),
1708 _ => panic!("Unexpected event: {:?}", event),
1711 let nodes = create_nodes(1, "test_payment_path_scoring".to_string());
1712 let data_dir = nodes[0].persister.get_data_dir();
1713 let persister = Arc::new(Persister::new(data_dir));
1714 let bg_processor = BackgroundProcessor::start(persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(), nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(), Some(nodes[0].scorer.clone()));
1716 do_test_payment_path_scoring!(nodes, receiver.recv_timeout(Duration::from_secs(EVENT_DEADLINE)));
1718 if !std::thread::panicking() {
1719 bg_processor.stop().unwrap();
1724 #[cfg(feature = "futures")]
1725 async fn test_payment_path_scoring_async() {
1726 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
1727 let event_handler = move |event: Event| {
1728 let sender_ref = sender.clone();
1731 Event::PaymentPathFailed { .. } => { sender_ref.send(event).await.unwrap() },
1732 Event::PaymentPathSuccessful { .. } => { sender_ref.send(event).await.unwrap() },
1733 Event::ProbeSuccessful { .. } => { sender_ref.send(event).await.unwrap() },
1734 Event::ProbeFailed { .. } => { sender_ref.send(event).await.unwrap() },
1735 _ => panic!("Unexpected event: {:?}", event),
1740 let nodes = create_nodes(1, "test_payment_path_scoring_async".to_string());
1741 let data_dir = nodes[0].persister.get_data_dir();
1742 let persister = Arc::new(Persister::new(data_dir));
1744 let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
1746 let bp_future = super::process_events_async(
1747 persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1748 nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1749 Some(nodes[0].scorer.clone()), move |dur: Duration| {
1750 let mut exit_receiver = exit_receiver.clone();
1751 Box::pin(async move {
1753 _ = tokio::time::sleep(dur) => false,
1754 _ = exit_receiver.changed() => true,
1759 let t1 = tokio::spawn(bp_future);
1760 let t2 = tokio::spawn(async move {
1761 do_test_payment_path_scoring!(nodes, receiver.recv().await);
1762 exit_sender.send(()).unwrap();
1765 let (r1, r2) = tokio::join!(t1, t2);
1766 r1.unwrap().unwrap();