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

   1 //! Utilities that take care of tasks that (1) need to happen periodically to keep Rust-Lightning
   2 //! running properly, and (2) either can or should be run in the background. See docs for
   3 //! [`BackgroundProcessor`] for more details on the nitty-gritty.
   4
   5 // 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)]
   8
   9 #![deny(missing_docs)]
  10 #![cfg_attr(not(feature = "futures"), deny(unsafe_code))]
  11
  12 #![cfg_attr(docsrs, feature(doc_auto_cfg))]
  13
  14 #![cfg_attr(all(not(feature = "std"), not(test)), no_std)]
  15
  16 #[cfg(any(test, feature = "std"))]
  17 extern crate core;
  18
  19 #[cfg(not(feature = "std"))]
  20 extern crate alloc;
  21
  22 #[macro_use] extern crate lightning;
  23 extern crate lightning_rapid_gossip_sync;
  24
  25 use lightning::chain;
  26 use lightning::chain::chaininterface::{BroadcasterInterface, FeeEstimator};
  27 use lightning::chain::chainmonitor::{ChainMonitor, Persist};
  28 use lightning::sign::{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::peer_handler::APeerManager;
  34 use lightning::routing::gossip::{NetworkGraph, P2PGossipSync};
  35 use lightning::routing::utxo::UtxoLookup;
  36 use lightning::routing::router::Router;
  37 use lightning::routing::scoring::{Score, WriteableScore};
  38 use lightning::util::logger::Logger;
  39 use lightning::util::persist::Persister;
  40 #[cfg(feature = "std")]
  41 use lightning::util::wakers::Sleeper;
  42 use lightning_rapid_gossip_sync::RapidGossipSync;
  43
  44 use core::ops::Deref;
  45 use core::time::Duration;
  46
  47 #[cfg(feature = "std")]
  48 use std::sync::Arc;
  49 #[cfg(feature = "std")]
  50 use core::sync::atomic::{AtomicBool, Ordering};
  51 #[cfg(feature = "std")]
  52 use std::thread::{self, JoinHandle};
  53 #[cfg(feature = "std")]
  54 use std::time::Instant;
  55
  56 #[cfg(not(feature = "std"))]
  57 use alloc::vec::Vec;
  58
  59 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
  60 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
  61 /// responsibilities are:
  62 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
  63 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
  64 ///   writing it to disk/backups by invoking the callback given to it at startup.
  65 ///   [`ChannelManager`] persistence should be done in the background.
  66 /// * Calling [`ChannelManager::timer_tick_occurred`], [`ChainMonitor::rebroadcast_pending_claims`]
  67 ///   and [`PeerManager::timer_tick_occurred`] at the appropriate intervals.
  68 /// * Calling [`NetworkGraph::remove_stale_channels_and_tracking`] (if a [`GossipSync`] with a
  69 ///   [`NetworkGraph`] is provided to [`BackgroundProcessor::start`]).
  70 ///
  71 /// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
  72 /// upon as doing so may result in high latency.
  73 ///
  74 /// # Note
  75 ///
  76 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
  77 /// there is a risk of channels force-closing on startup when the manager realizes it's outdated.
  78 /// However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
  79 /// unilateral chain closure fees are at risk.
  80 ///
  81 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
  82 /// [`Event`]: lightning::events::Event
  83 /// [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
  84 /// [`PeerManager::process_events`]: lightning::ln::peer_handler::PeerManager::process_events
  85 #[cfg(feature = "std")]
  86 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
  87 pub struct BackgroundProcessor {
  88         stop_thread: Arc<AtomicBool>,
  89         thread_handle: Option<JoinHandle<Result<(), std::io::Error>>>,
  90 }
  91
  92 #[cfg(not(test))]
  93 const FRESHNESS_TIMER: u64 = 60;
  94 #[cfg(test)]
  95 const FRESHNESS_TIMER: u64 = 1;
  96
  97 #[cfg(all(not(test), not(debug_assertions)))]
  98 const PING_TIMER: u64 = 10;
  99 /// Signature operations take a lot longer without compiler optimisations.
 100 /// Increasing the ping timer allows for this but slower devices will be disconnected if the
 101 /// timeout is reached.
 102 #[cfg(all(not(test), debug_assertions))]
 103 const PING_TIMER: u64 = 30;
 104 #[cfg(test)]
 105 const PING_TIMER: u64 = 1;
 106
 107 /// Prune the network graph of stale entries hourly.
 108 const NETWORK_PRUNE_TIMER: u64 = 60 * 60;
 109
 110 #[cfg(not(test))]
 111 const SCORER_PERSIST_TIMER: u64 = 60 * 60;
 112 #[cfg(test)]
 113 const SCORER_PERSIST_TIMER: u64 = 1;
 114
 115 #[cfg(not(test))]
 116 const FIRST_NETWORK_PRUNE_TIMER: u64 = 60;
 117 #[cfg(test)]
 118 const FIRST_NETWORK_PRUNE_TIMER: u64 = 1;
 119
 120 #[cfg(not(test))]
 121 const REBROADCAST_TIMER: u64 = 30;
 122 #[cfg(test)]
 123 const REBROADCAST_TIMER: u64 = 1;
 124
 125 #[cfg(feature = "futures")]
 126 /// core::cmp::min is not currently const, so we define a trivial (and equivalent) replacement
 127 const fn min_u64(a: u64, b: u64) -> u64 { if a < b { a } else { b } }
 128 #[cfg(feature = "futures")]
 129 const FASTEST_TIMER: u64 = min_u64(min_u64(FRESHNESS_TIMER, PING_TIMER),
 130         min_u64(SCORER_PERSIST_TIMER, min_u64(FIRST_NETWORK_PRUNE_TIMER, REBROADCAST_TIMER)));
 131
 132 /// Either [`P2PGossipSync`] or [`RapidGossipSync`].
 133 pub enum GossipSync<
 134         P: Deref<Target = P2PGossipSync<G, U, L>>,
 135         R: Deref<Target = RapidGossipSync<G, L>>,
 136         G: Deref<Target = NetworkGraph<L>>,
 137         U: Deref,
 138         L: Deref,
 139 >
 140 where U::Target: UtxoLookup, L::Target: Logger {
 141         /// Gossip sync via the lightning peer-to-peer network as defined by BOLT 7.
 142         P2P(P),
 143         /// Rapid gossip sync from a trusted server.
 144         Rapid(R),
 145         /// No gossip sync.
 146         None,
 147 }
 148
 149 impl<
 150         P: Deref<Target = P2PGossipSync<G, U, L>>,
 151         R: Deref<Target = RapidGossipSync<G, L>>,
 152         G: Deref<Target = NetworkGraph<L>>,
 153         U: Deref,
 154         L: Deref,
 155 > GossipSync<P, R, G, U, L>
 156 where U::Target: UtxoLookup, L::Target: Logger {
 157         fn network_graph(&self) -> Option<&G> {
 158                 match self {
 159                         GossipSync::P2P(gossip_sync) => Some(gossip_sync.network_graph()),
 160                         GossipSync::Rapid(gossip_sync) => Some(gossip_sync.network_graph()),
 161                         GossipSync::None => None,
 162                 }
 163         }
 164
 165         fn prunable_network_graph(&self) -> Option<&G> {
 166                 match self {
 167                         GossipSync::P2P(gossip_sync) => Some(gossip_sync.network_graph()),
 168                         GossipSync::Rapid(gossip_sync) => {
 169                                 if gossip_sync.is_initial_sync_complete() {
 170                                         Some(gossip_sync.network_graph())
 171                                 } else {
 172                                         None
 173                                 }
 174                         },
 175                         GossipSync::None => None,
 176                 }
 177         }
 178 }
 179
 180 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
 181 impl<P: Deref<Target = P2PGossipSync<G, U, L>>, G: Deref<Target = NetworkGraph<L>>, U: Deref, L: Deref>
 182         GossipSync<P, &RapidGossipSync<G, L>, G, U, L>
 183 where
 184         U::Target: UtxoLookup,
 185         L::Target: Logger,
 186 {
 187         /// Initializes a new [`GossipSync::P2P`] variant.
 188         pub fn p2p(gossip_sync: P) -> Self {
 189                 GossipSync::P2P(gossip_sync)
 190         }
 191 }
 192
 193 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
 194 impl<'a, R: Deref<Target = RapidGossipSync<G, L>>, G: Deref<Target = NetworkGraph<L>>, L: Deref>
 195         GossipSync<
 196                 &P2PGossipSync<G, &'a (dyn UtxoLookup + Send + Sync), L>,
 197                 R,
 198                 G,
 199                 &'a (dyn UtxoLookup + Send + Sync),
 200                 L,
 201         >
 202 where
 203         L::Target: Logger,
 204 {
 205         /// Initializes a new [`GossipSync::Rapid`] variant.
 206         pub fn rapid(gossip_sync: R) -> Self {
 207                 GossipSync::Rapid(gossip_sync)
 208         }
 209 }
 210
 211 /// This is not exported to bindings users as the bindings concretize everything and have constructors for us
 212 impl<'a, L: Deref>
 213         GossipSync<
 214                 &P2PGossipSync<&'a NetworkGraph<L>, &'a (dyn UtxoLookup + Send + Sync), L>,
 215                 &RapidGossipSync<&'a NetworkGraph<L>, L>,
 216                 &'a NetworkGraph<L>,
 217                 &'a (dyn UtxoLookup + Send + Sync),
 218                 L,
 219         >
 220 where
 221         L::Target: Logger,
 222 {
 223         /// Initializes a new [`GossipSync::None`] variant.
 224         pub fn none() -> Self {
 225                 GossipSync::None
 226         }
 227 }
 228
 229 fn handle_network_graph_update<L: Deref>(
 230         network_graph: &NetworkGraph<L>, event: &Event
 231 ) where L::Target: Logger {
 232         if let Event::PaymentPathFailed {
 233                 failure: PathFailure::OnPath { network_update: Some(ref upd) }, .. } = event
 234         {
 235                 network_graph.handle_network_update(upd);
 236         }
 237 }
 238
 239 /// Updates scorer based on event and returns whether an update occurred so we can decide whether
 240 /// to persist.
 241 fn update_scorer<'a, S: 'static + Deref<Target = SC> + Send + Sync, SC: 'a + WriteableScore<'a>>(
 242         scorer: &'a S, event: &Event
 243 ) -> bool {
 244         let mut score = scorer.lock();
 245         match event {
 246                 Event::PaymentPathFailed { ref path, short_channel_id: Some(scid), .. } => {
 247                         score.payment_path_failed(path, *scid);
 248                 },
 249                 Event::PaymentPathFailed { ref path, payment_failed_permanently: true, .. } => {
 250                         // Reached if the destination explicitly failed it back. We treat this as a successful probe
 251                         // because the payment made it all the way to the destination with sufficient liquidity.
 252                         score.probe_successful(path);
 253                 },
 254                 Event::PaymentPathSuccessful { path, .. } => {
 255                         score.payment_path_successful(path);
 256                 },
 257                 Event::ProbeSuccessful { path, .. } => {
 258                         score.probe_successful(path);
 259                 },
 260                 Event::ProbeFailed { path, short_channel_id: Some(scid), .. } => {
 261                         score.probe_failed(path, *scid);
 262                 },
 263                 _ => return false,
 264         }
 265         true
 266 }
 267
 268 macro_rules! define_run_body {
 269         ($persister: ident, $chain_monitor: ident, $process_chain_monitor_events: expr,
 270          $channel_manager: ident, $process_channel_manager_events: expr,
 271          $gossip_sync: ident, $peer_manager: ident, $logger: ident, $scorer: ident,
 272          $loop_exit_check: expr, $await: expr, $get_timer: expr, $timer_elapsed: expr,
 273          $check_slow_await: expr)
 274         => { {
 275                 log_trace!($logger, "Calling ChannelManager's timer_tick_occurred on startup");
 276                 $channel_manager.timer_tick_occurred();
 277                 log_trace!($logger, "Rebroadcasting monitor's pending claims on startup");
 278                 $chain_monitor.rebroadcast_pending_claims();
 279
 280                 let mut last_freshness_call = $get_timer(FRESHNESS_TIMER);
 281                 let mut last_ping_call = $get_timer(PING_TIMER);
 282                 let mut last_prune_call = $get_timer(FIRST_NETWORK_PRUNE_TIMER);
 283                 let mut last_scorer_persist_call = $get_timer(SCORER_PERSIST_TIMER);
 284                 let mut last_rebroadcast_call = $get_timer(REBROADCAST_TIMER);
 285                 let mut have_pruned = false;
 286
 287                 loop {
 288                         $process_channel_manager_events;
 289                         $process_chain_monitor_events;
 290
 291                         // Note that the PeerManager::process_events may block on ChannelManager's locks,
 292                         // hence it comes last here. When the ChannelManager finishes whatever it's doing,
 293                         // we want to ensure we get into `persist_manager` as quickly as we can, especially
 294                         // without running the normal event processing above and handing events to users.
 295                         //
 296                         // Specifically, on an *extremely* slow machine, we may see ChannelManager start
 297                         // processing a message effectively at any point during this loop. In order to
 298                         // minimize the time between such processing completing and persisting the updated
 299                         // ChannelManager, we want to minimize methods blocking on a ChannelManager
 300                         // generally, and as a fallback place such blocking only immediately before
 301                         // persistence.
 302                         $peer_manager.as_ref().process_events();
 303
 304                         // Exit the loop if the background processor was requested to stop.
 305                         if $loop_exit_check {
 306                                 log_trace!($logger, "Terminating background processor.");
 307                                 break;
 308                         }
 309
 310                         // We wait up to 100ms, but track how long it takes to detect being put to sleep,
 311                         // see `await_start`'s use below.
 312                         let mut await_start = None;
 313                         if $check_slow_await { await_start = Some($get_timer(1)); }
 314                         let updates_available = $await;
 315                         let await_slow = if $check_slow_await { $timer_elapsed(&mut await_start.unwrap(), 1) } else { false };
 316
 317                         // Exit the loop if the background processor was requested to stop.
 318                         if $loop_exit_check {
 319                                 log_trace!($logger, "Terminating background processor.");
 320                                 break;
 321                         }
 322
 323                         if updates_available {
 324                                 log_trace!($logger, "Persisting ChannelManager...");
 325                                 $persister.persist_manager(&*$channel_manager)?;
 326                                 log_trace!($logger, "Done persisting ChannelManager.");
 327                         }
 328                         if $timer_elapsed(&mut last_freshness_call, FRESHNESS_TIMER) {
 329                                 log_trace!($logger, "Calling ChannelManager's timer_tick_occurred");
 330                                 $channel_manager.timer_tick_occurred();
 331                                 last_freshness_call = $get_timer(FRESHNESS_TIMER);
 332                         }
 333                         if await_slow {
 334                                 // On various platforms, we may be starved of CPU cycles for several reasons.
 335                                 // E.g. on iOS, if we've been in the background, we will be entirely paused.
 336                                 // Similarly, if we're on a desktop platform and the device has been asleep, we
 337                                 // may not get any cycles.
 338                                 // We detect this by checking if our max-100ms-sleep, above, ran longer than a
 339                                 // full second, at which point we assume sockets may have been killed (they
 340                                 // appear to be at least on some platforms, even if it has only been a second).
 341                                 // Note that we have to take care to not get here just because user event
 342                                 // processing was slow at the top of the loop. For example, the sample client
 343                                 // may call Bitcoin Core RPCs during event handling, which very often takes
 344                                 // more than a handful of seconds to complete, and shouldn't disconnect all our
 345                                 // peers.
 346                                 log_trace!($logger, "100ms sleep took more than a second, disconnecting peers.");
 347                                 $peer_manager.as_ref().disconnect_all_peers();
 348                                 last_ping_call = $get_timer(PING_TIMER);
 349                         } else if $timer_elapsed(&mut last_ping_call, PING_TIMER) {
 350                                 log_trace!($logger, "Calling PeerManager's timer_tick_occurred");
 351                                 $peer_manager.as_ref().timer_tick_occurred();
 352                                 last_ping_call = $get_timer(PING_TIMER);
 353                         }
 354
 355                         // Note that we want to run a graph prune once not long after startup before
 356                         // falling back to our usual hourly prunes. This avoids short-lived clients never
 357                         // pruning their network graph. We run once 60 seconds after startup before
 358                         // continuing our normal cadence. For RGS, since 60 seconds is likely too long,
 359                         // we prune after an initial sync completes.
 360                         let prune_timer = if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER };
 361                         let prune_timer_elapsed = $timer_elapsed(&mut last_prune_call, prune_timer);
 362                         let should_prune = match $gossip_sync {
 363                                 GossipSync::Rapid(_) => !have_pruned || prune_timer_elapsed,
 364                                 _ => prune_timer_elapsed,
 365                         };
 366                         if should_prune {
 367                                 // The network graph must not be pruned while rapid sync completion is pending
 368                                 if let Some(network_graph) = $gossip_sync.prunable_network_graph() {
 369                                         #[cfg(feature = "std")] {
 370                                                 log_trace!($logger, "Pruning and persisting network graph.");
 371                                                 network_graph.remove_stale_channels_and_tracking();
 372                                         }
 373                                         #[cfg(not(feature = "std"))] {
 374                                                 log_warn!($logger, "Not pruning network graph, consider enabling `std` or doing so manually with remove_stale_channels_and_tracking_with_time.");
 375                                                 log_trace!($logger, "Persisting network graph.");
 376                                         }
 377
 378                                         if let Err(e) = $persister.persist_graph(network_graph) {
 379                                                 log_error!($logger, "Error: Failed to persist network graph, check your disk and permissions {}", e)
 380                                         }
 381
 382                                         have_pruned = true;
 383                                 }
 384                                 let prune_timer = if have_pruned { NETWORK_PRUNE_TIMER } else { FIRST_NETWORK_PRUNE_TIMER };
 385                                 last_prune_call = $get_timer(prune_timer);
 386                         }
 387
 388                         if $timer_elapsed(&mut last_scorer_persist_call, SCORER_PERSIST_TIMER) {
 389                                 if let Some(ref scorer) = $scorer {
 390                                         log_trace!($logger, "Persisting scorer");
 391                                         if let Err(e) = $persister.persist_scorer(&scorer) {
 392                                                 log_error!($logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 393                                         }
 394                                 }
 395                                 last_scorer_persist_call = $get_timer(SCORER_PERSIST_TIMER);
 396                         }
 397
 398                         if $timer_elapsed(&mut last_rebroadcast_call, REBROADCAST_TIMER) {
 399                                 log_trace!($logger, "Rebroadcasting monitor's pending claims");
 400                                 $chain_monitor.rebroadcast_pending_claims();
 401                                 last_rebroadcast_call = $get_timer(REBROADCAST_TIMER);
 402                         }
 403                 }
 404
 405                 // After we exit, ensure we persist the ChannelManager one final time - this avoids
 406                 // some races where users quit while channel updates were in-flight, with
 407                 // ChannelMonitor update(s) persisted without a corresponding ChannelManager update.
 408                 $persister.persist_manager(&*$channel_manager)?;
 409
 410                 // Persist Scorer on exit
 411                 if let Some(ref scorer) = $scorer {
 412                         $persister.persist_scorer(&scorer)?;
 413                 }
 414
 415                 // Persist NetworkGraph on exit
 416                 if let Some(network_graph) = $gossip_sync.network_graph() {
 417                         $persister.persist_graph(network_graph)?;
 418                 }
 419
 420                 Ok(())
 421         } }
 422 }
 423
 424 #[cfg(feature = "futures")]
 425 pub(crate) mod futures_util {
 426         use core::future::Future;
 427         use core::task::{Poll, Waker, RawWaker, RawWakerVTable};
 428         use core::pin::Pin;
 429         use core::marker::Unpin;
 430         pub(crate) struct Selector<
 431                 A: Future<Output=()> + Unpin, B: Future<Output=()> + Unpin, C: Future<Output=bool> + Unpin
 432         > {
 433                 pub a: A,
 434                 pub b: B,
 435                 pub c: C,
 436         }
 437         pub(crate) enum SelectorOutput {
 438                 A, B, C(bool),
 439         }
 440
 441         impl<
 442                 A: Future<Output=()> + Unpin, B: Future<Output=()> + Unpin, C: Future<Output=bool> + Unpin
 443         > Future for Selector<A, B, C> {
 444                 type Output = SelectorOutput;
 445                 fn poll(mut self: Pin<&mut Self>, ctx: &mut core::task::Context<'_>) -> Poll<SelectorOutput> {
 446                         match Pin::new(&mut self.a).poll(ctx) {
 447                                 Poll::Ready(()) => { return Poll::Ready(SelectorOutput::A); },
 448                                 Poll::Pending => {},
 449                         }
 450                         match Pin::new(&mut self.b).poll(ctx) {
 451                                 Poll::Ready(()) => { return Poll::Ready(SelectorOutput::B); },
 452                                 Poll::Pending => {},
 453                         }
 454                         match Pin::new(&mut self.c).poll(ctx) {
 455                                 Poll::Ready(res) => { return Poll::Ready(SelectorOutput::C(res)); },
 456                                 Poll::Pending => {},
 457                         }
 458                         Poll::Pending
 459                 }
 460         }
 461
 462         // If we want to poll a future without an async context to figure out if it has completed or
 463         // not without awaiting, we need a Waker, which needs a vtable...we fill it with dummy values
 464         // but sadly there's a good bit of boilerplate here.
 465         fn dummy_waker_clone(_: *const ()) -> RawWaker { RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE) }
 466         fn dummy_waker_action(_: *const ()) { }
 467
 468         const DUMMY_WAKER_VTABLE: RawWakerVTable = RawWakerVTable::new(
 469                 dummy_waker_clone, dummy_waker_action, dummy_waker_action, dummy_waker_action);
 470         pub(crate) fn dummy_waker() -> Waker { unsafe { Waker::from_raw(RawWaker::new(core::ptr::null(), &DUMMY_WAKER_VTABLE)) } }
 471 }
 472 #[cfg(feature = "futures")]
 473 use futures_util::{Selector, SelectorOutput, dummy_waker};
 474 #[cfg(feature = "futures")]
 475 use core::task;
 476
 477 /// Processes background events in a future.
 478 ///
 479 /// `sleeper` should return a future which completes in the given amount of time and returns a
 480 /// boolean indicating whether the background processing should exit. Once `sleeper` returns a
 481 /// future which outputs `true`, the loop will exit and this function's future will complete.
 482 /// The `sleeper` future is free to return early after it has triggered the exit condition.
 483 ///
 484 /// See [`BackgroundProcessor::start`] for information on which actions this handles.
 485 ///
 486 /// Requires the `futures` feature. Note that while this method is available without the `std`
 487 /// feature, doing so will skip calling [`NetworkGraph::remove_stale_channels_and_tracking`],
 488 /// you should call [`NetworkGraph::remove_stale_channels_and_tracking_with_time`] regularly
 489 /// manually instead.
 490 ///
 491 /// The `mobile_interruptable_platform` flag should be set if we're currently running on a
 492 /// mobile device, where we may need to check for interruption of the application regularly. If you
 493 /// are unsure, you should set the flag, as the performance impact of it is minimal unless there
 494 /// are hundreds or thousands of simultaneous process calls running.
 495 ///
 496 /// For example, in order to process background events in a [Tokio](https://tokio.rs/) task, you
 497 /// could setup `process_events_async` like this:
 498 /// ```
 499 /// # struct MyPersister {}
 500 /// # impl lightning::util::persist::KVStorePersister for MyPersister {
 501 /// #     fn persist<W: lightning::util::ser::Writeable>(&self, key: &str, object: &W) -> lightning::io::Result<()> { Ok(()) }
 502 /// # }
 503 /// # struct MyEventHandler {}
 504 /// # impl MyEventHandler {
 505 /// #     async fn handle_event(&self, _: lightning::events::Event) {}
 506 /// # }
 507 /// # #[derive(Eq, PartialEq, Clone, Hash)]
 508 /// # struct MySocketDescriptor {}
 509 /// # impl lightning::ln::peer_handler::SocketDescriptor for MySocketDescriptor {
 510 /// #     fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize { 0 }
 511 /// #     fn disconnect_socket(&mut self) {}
 512 /// # }
 513 /// # use std::sync::{Arc, Mutex};
 514 /// # use std::sync::atomic::{AtomicBool, Ordering};
 515 /// # use lightning_background_processor::{process_events_async, GossipSync};
 516 /// # type MyBroadcaster = dyn lightning::chain::chaininterface::BroadcasterInterface + Send + Sync;
 517 /// # type MyFeeEstimator = dyn lightning::chain::chaininterface::FeeEstimator + Send + Sync;
 518 /// # type MyNodeSigner = dyn lightning::sign::NodeSigner + Send + Sync;
 519 /// # type MyUtxoLookup = dyn lightning::routing::utxo::UtxoLookup + Send + Sync;
 520 /// # type MyFilter = dyn lightning::chain::Filter + Send + Sync;
 521 /// # type MyLogger = dyn lightning::util::logger::Logger + Send + Sync;
 522 /// # type MyChainMonitor = lightning::chain::chainmonitor::ChainMonitor<lightning::sign::InMemorySigner, Arc<MyFilter>, Arc<MyBroadcaster>, Arc<MyFeeEstimator>, Arc<MyLogger>, Arc<MyPersister>>;
 523 /// # type MyPeerManager = lightning::ln::peer_handler::SimpleArcPeerManager<MySocketDescriptor, MyChainMonitor, MyBroadcaster, MyFeeEstimator, MyUtxoLookup, MyLogger>;
 524 /// # type MyNetworkGraph = lightning::routing::gossip::NetworkGraph<Arc<MyLogger>>;
 525 /// # type MyGossipSync = lightning::routing::gossip::P2PGossipSync<Arc<MyNetworkGraph>, Arc<MyUtxoLookup>, Arc<MyLogger>>;
 526 /// # type MyChannelManager = lightning::ln::channelmanager::SimpleArcChannelManager<MyChainMonitor, MyBroadcaster, MyFeeEstimator, MyLogger>;
 527 /// # type MyScorer = Mutex<lightning::routing::scoring::ProbabilisticScorer<Arc<MyNetworkGraph>, Arc<MyLogger>>>;
 528 ///
 529 /// # 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>) {
 530 ///     let background_persister = Arc::clone(&my_persister);
 531 ///     let background_event_handler = Arc::clone(&my_event_handler);
 532 ///     let background_chain_mon = Arc::clone(&my_chain_monitor);
 533 ///     let background_chan_man = Arc::clone(&my_channel_manager);
 534 ///     let background_gossip_sync = GossipSync::p2p(Arc::clone(&my_gossip_sync));
 535 ///     let background_peer_man = Arc::clone(&my_peer_manager);
 536 ///     let background_logger = Arc::clone(&my_logger);
 537 ///     let background_scorer = Arc::clone(&my_scorer);
 538 ///
 539 ///     // Setup the sleeper.
 540 ///     let (stop_sender, stop_receiver) = tokio::sync::watch::channel(());
 541 ///
 542 ///     let sleeper = move |d| {
 543 ///             let mut receiver = stop_receiver.clone();
 544 ///             Box::pin(async move {
 545 ///                     tokio::select!{
 546 ///                             _ = tokio::time::sleep(d) => false,
 547 ///                             _ = receiver.changed() => true,
 548 ///                     }
 549 ///             })
 550 ///     };
 551 ///
 552 ///     let mobile_interruptable_platform = false;
 553 ///
 554 ///     let handle = tokio::spawn(async move {
 555 ///             process_events_async(
 556 ///                     background_persister,
 557 ///                     |e| background_event_handler.handle_event(e),
 558 ///                     background_chain_mon,
 559 ///                     background_chan_man,
 560 ///                     background_gossip_sync,
 561 ///                     background_peer_man,
 562 ///                     background_logger,
 563 ///                     Some(background_scorer),
 564 ///                     sleeper,
 565 ///                     mobile_interruptable_platform,
 566 ///                     )
 567 ///                     .await
 568 ///                     .expect("Failed to process events");
 569 ///     });
 570 ///
 571 ///     // Stop the background processing.
 572 ///     stop_sender.send(()).unwrap();
 573 ///     handle.await.unwrap();
 574 ///     # }
 575 ///```
 576 #[cfg(feature = "futures")]
 577 pub async fn process_events_async<
 578         'a,
 579         UL: 'static + Deref + Send + Sync,
 580         CF: 'static + Deref + Send + Sync,
 581         CW: 'static + Deref + Send + Sync,
 582         T: 'static + Deref + Send + Sync,
 583         ES: 'static + Deref + Send + Sync,
 584         NS: 'static + Deref + Send + Sync,
 585         SP: 'static + Deref + Send + Sync,
 586         F: 'static + Deref + Send + Sync,
 587         R: 'static + Deref + Send + Sync,
 588         G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
 589         L: 'static + Deref + Send + Sync,
 590         P: 'static + Deref + Send + Sync,
 591         EventHandlerFuture: core::future::Future<Output = ()>,
 592         EventHandler: Fn(Event) -> EventHandlerFuture,
 593         PS: 'static + Deref + Send,
 594         M: 'static + Deref<Target = ChainMonitor<<SP::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
 595         CM: 'static + Deref<Target = ChannelManager<CW, T, ES, NS, SP, F, R, L>> + Send + Sync,
 596         PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send + Sync,
 597         RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
 598         APM: APeerManager + Send + Sync,
 599         PM: 'static + Deref<Target = APM> + Send + Sync,
 600         S: 'static + Deref<Target = SC> + Send + Sync,
 601         SC: for<'b> WriteableScore<'b>,
 602         SleepFuture: core::future::Future<Output = bool> + core::marker::Unpin,
 603         Sleeper: Fn(Duration) -> SleepFuture
 604 >(
 605         persister: PS, event_handler: EventHandler, chain_monitor: M, channel_manager: CM,
 606         gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM, logger: L, scorer: Option<S>,
 607         sleeper: Sleeper, mobile_interruptable_platform: bool,
 608 ) -> Result<(), lightning::io::Error>
 609 where
 610         UL::Target: 'static + UtxoLookup,
 611         CF::Target: 'static + chain::Filter,
 612         CW::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
 613         T::Target: 'static + BroadcasterInterface,
 614         ES::Target: 'static + EntropySource,
 615         NS::Target: 'static + NodeSigner,
 616         SP::Target: 'static + SignerProvider,
 617         F::Target: 'static + FeeEstimator,
 618         R::Target: 'static + Router,
 619         L::Target: 'static + Logger,
 620         P::Target: 'static + Persist<<SP::Target as SignerProvider>::Signer>,
 621         PS::Target: 'static + Persister<'a, CW, T, ES, NS, SP, F, R, L, SC>,
 622 {
 623         let mut should_break = false;
 624         let async_event_handler = |event| {
 625                 let network_graph = gossip_sync.network_graph();
 626                 let event_handler = &event_handler;
 627                 let scorer = &scorer;
 628                 let logger = &logger;
 629                 let persister = &persister;
 630                 async move {
 631                         if let Some(network_graph) = network_graph {
 632                                 handle_network_graph_update(network_graph, &event)
 633                         }
 634                         if let Some(ref scorer) = scorer {
 635                                 if update_scorer(scorer, &event) {
 636                                         log_trace!(logger, "Persisting scorer after update");
 637                                         if let Err(e) = persister.persist_scorer(&scorer) {
 638                                                 log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 639                                         }
 640                                 }
 641                         }
 642                         event_handler(event).await;
 643                 }
 644         };
 645         define_run_body!(persister,
 646                 chain_monitor, chain_monitor.process_pending_events_async(async_event_handler).await,
 647                 channel_manager, channel_manager.process_pending_events_async(async_event_handler).await,
 648                 gossip_sync, peer_manager, logger, scorer, should_break, {
 649                         let fut = Selector {
 650                                 a: channel_manager.get_persistable_update_future(),
 651                                 b: chain_monitor.get_update_future(),
 652                                 c: sleeper(if mobile_interruptable_platform { Duration::from_millis(100) } else { Duration::from_secs(FASTEST_TIMER) }),
 653                         };
 654                         match fut.await {
 655                                 SelectorOutput::A => true,
 656                                 SelectorOutput::B => false,
 657                                 SelectorOutput::C(exit) => {
 658                                         should_break = exit;
 659                                         false
 660                                 }
 661                         }
 662                 }, |t| sleeper(Duration::from_secs(t)),
 663                 |fut: &mut SleepFuture, _| {
 664                         let mut waker = dummy_waker();
 665                         let mut ctx = task::Context::from_waker(&mut waker);
 666                         match core::pin::Pin::new(fut).poll(&mut ctx) {
 667                                 task::Poll::Ready(exit) => { should_break = exit; true },
 668                                 task::Poll::Pending => false,
 669                         }
 670                 }, mobile_interruptable_platform)
 671 }
 672
 673 #[cfg(feature = "std")]
 674 impl BackgroundProcessor {
 675         /// Start a background thread that takes care of responsibilities enumerated in the [top-level
 676         /// documentation].
 677         ///
 678         /// The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
 679         /// [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
 680         /// either [`join`] or [`stop`].
 681         ///
 682         /// # Data Persistence
 683         ///
 684         /// [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
 685         /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
 686         /// [`ChannelManager`]. See the `lightning-persister` crate for LDK's
 687         /// provided implementation.
 688         ///
 689         /// [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if
 690         /// [`GossipSync`] is supplied. See [`NetworkGraph::write`] for writing out a [`NetworkGraph`].
 691         /// See the `lightning-persister` crate for LDK's provided implementation.
 692         ///
 693         /// Typically, users should either implement [`Persister::persist_manager`] to never return an
 694         /// error or call [`join`] and handle any error that may arise. For the latter case,
 695         /// `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
 696         ///
 697         /// # Event Handling
 698         ///
 699         /// `event_handler` is responsible for handling events that users should be notified of (e.g.,
 700         /// payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
 701         /// functionality implemented by other handlers.
 702         /// * [`P2PGossipSync`] if given will update the [`NetworkGraph`] based on payment failures.
 703         ///
 704         /// # Rapid Gossip Sync
 705         ///
 706         /// If rapid gossip sync is meant to run at startup, pass [`RapidGossipSync`] via `gossip_sync`
 707         /// to indicate that the [`BackgroundProcessor`] should not prune the [`NetworkGraph`] instance
 708         /// until the [`RapidGossipSync`] instance completes its first sync.
 709         ///
 710         /// [top-level documentation]: BackgroundProcessor
 711         /// [`join`]: Self::join
 712         /// [`stop`]: Self::stop
 713         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 714         /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
 715         /// [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
 716         /// [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
 717         /// [`NetworkGraph`]: lightning::routing::gossip::NetworkGraph
 718         /// [`NetworkGraph::write`]: lightning::routing::gossip::NetworkGraph#impl-Writeable
 719         pub fn start<
 720                 'a,
 721                 UL: 'static + Deref + Send + Sync,
 722                 CF: 'static + Deref + Send + Sync,
 723                 CW: 'static + Deref + Send + Sync,
 724                 T: 'static + Deref + Send + Sync,
 725                 ES: 'static + Deref + Send + Sync,
 726                 NS: 'static + Deref + Send + Sync,
 727                 SP: 'static + Deref + Send + Sync,
 728                 F: 'static + Deref + Send + Sync,
 729                 R: 'static + Deref + Send + Sync,
 730                 G: 'static + Deref<Target = NetworkGraph<L>> + Send + Sync,
 731                 L: 'static + Deref + Send + Sync,
 732                 P: 'static + Deref + Send + Sync,
 733                 EH: 'static + EventHandler + Send,
 734                 PS: 'static + Deref + Send,
 735                 M: 'static + Deref<Target = ChainMonitor<<SP::Target as SignerProvider>::Signer, CF, T, F, L, P>> + Send + Sync,
 736                 CM: 'static + Deref<Target = ChannelManager<CW, T, ES, NS, SP, F, R, L>> + Send + Sync,
 737                 PGS: 'static + Deref<Target = P2PGossipSync<G, UL, L>> + Send + Sync,
 738                 RGS: 'static + Deref<Target = RapidGossipSync<G, L>> + Send,
 739                 APM: APeerManager + Send + Sync,
 740                 PM: 'static + Deref<Target = APM> + Send + Sync,
 741                 S: 'static + Deref<Target = SC> + Send + Sync,
 742                 SC: for <'b> WriteableScore<'b>,
 743         >(
 744                 persister: PS, event_handler: EH, chain_monitor: M, channel_manager: CM,
 745                 gossip_sync: GossipSync<PGS, RGS, G, UL, L>, peer_manager: PM, logger: L, scorer: Option<S>,
 746         ) -> Self
 747         where
 748                 UL::Target: 'static + UtxoLookup,
 749                 CF::Target: 'static + chain::Filter,
 750                 CW::Target: 'static + chain::Watch<<SP::Target as SignerProvider>::Signer>,
 751                 T::Target: 'static + BroadcasterInterface,
 752                 ES::Target: 'static + EntropySource,
 753                 NS::Target: 'static + NodeSigner,
 754                 SP::Target: 'static + SignerProvider,
 755                 F::Target: 'static + FeeEstimator,
 756                 R::Target: 'static + Router,
 757                 L::Target: 'static + Logger,
 758                 P::Target: 'static + Persist<<SP::Target as SignerProvider>::Signer>,
 759                 PS::Target: 'static + Persister<'a, CW, T, ES, NS, SP, F, R, L, SC>,
 760         {
 761                 let stop_thread = Arc::new(AtomicBool::new(false));
 762                 let stop_thread_clone = stop_thread.clone();
 763                 let handle = thread::spawn(move || -> Result<(), std::io::Error> {
 764                         let event_handler = |event| {
 765                                 let network_graph = gossip_sync.network_graph();
 766                                 if let Some(network_graph) = network_graph {
 767                                         handle_network_graph_update(network_graph, &event)
 768                                 }
 769                                 if let Some(ref scorer) = scorer {
 770                                         if update_scorer(scorer, &event) {
 771                                                 log_trace!(logger, "Persisting scorer after update");
 772                                                 if let Err(e) = persister.persist_scorer(&scorer) {
 773                                                         log_error!(logger, "Error: Failed to persist scorer, check your disk and permissions {}", e)
 774                                                 }
 775                                         }
 776                                 }
 777                                 event_handler.handle_event(event);
 778                         };
 779                         define_run_body!(persister, chain_monitor, chain_monitor.process_pending_events(&event_handler),
 780                                 channel_manager, channel_manager.process_pending_events(&event_handler),
 781                                 gossip_sync, peer_manager, logger, scorer, stop_thread.load(Ordering::Acquire),
 782                                 Sleeper::from_two_futures(
 783                                         channel_manager.get_persistable_update_future(),
 784                                         chain_monitor.get_update_future()
 785                                 ).wait_timeout(Duration::from_millis(100)),
 786                                 |_| Instant::now(), |time: &Instant, dur| time.elapsed().as_secs() > dur, false)
 787                 });
 788                 Self { stop_thread: stop_thread_clone, thread_handle: Some(handle) }
 789         }
 790
 791         /// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 792         /// [`ChannelManager`].
 793         ///
 794         /// # Panics
 795         ///
 796         /// This function panics if the background thread has panicked such as while persisting or
 797         /// handling events.
 798         ///
 799         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 800         pub fn join(mut self) -> Result<(), std::io::Error> {
 801                 assert!(self.thread_handle.is_some());
 802                 self.join_thread()
 803         }
 804
 805         /// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 806         /// [`ChannelManager`].
 807         ///
 808         /// # Panics
 809         ///
 810         /// This function panics if the background thread has panicked such as while persisting or
 811         /// handling events.
 812         ///
 813         /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 814         pub fn stop(mut self) -> Result<(), std::io::Error> {
 815                 assert!(self.thread_handle.is_some());
 816                 self.stop_and_join_thread()
 817         }
 818
 819         fn stop_and_join_thread(&mut self) -> Result<(), std::io::Error> {
 820                 self.stop_thread.store(true, Ordering::Release);
 821                 self.join_thread()
 822         }
 823
 824         fn join_thread(&mut self) -> Result<(), std::io::Error> {
 825                 match self.thread_handle.take() {
 826                         Some(handle) => handle.join().unwrap(),
 827                         None => Ok(()),
 828                 }
 829         }
 830 }
 831
 832 #[cfg(feature = "std")]
 833 impl Drop for BackgroundProcessor {
 834         fn drop(&mut self) {
 835                 self.stop_and_join_thread().unwrap();
 836         }
 837 }
 838
 839 #[cfg(all(feature = "std", test))]
 840 mod tests {
 841         use bitcoin::blockdata::constants::{genesis_block, ChainHash};
 842         use bitcoin::blockdata::locktime::PackedLockTime;
 843         use bitcoin::blockdata::transaction::{Transaction, TxOut};
 844         use bitcoin::network::constants::Network;
 845         use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1};
 846         use lightning::chain::{BestBlock, Confirm, chainmonitor};
 847         use lightning::chain::channelmonitor::ANTI_REORG_DELAY;
 848         use lightning::sign::{InMemorySigner, KeysManager};
 849         use lightning::chain::transaction::OutPoint;
 850         use lightning::events::{Event, PathFailure, MessageSendEventsProvider, MessageSendEvent};
 851         use lightning::{get_event_msg, get_event};
 852         use lightning::ln::PaymentHash;
 853         use lightning::ln::channelmanager;
 854         use lightning::ln::channelmanager::{BREAKDOWN_TIMEOUT, ChainParameters, MIN_CLTV_EXPIRY_DELTA, PaymentId};
 855         use lightning::ln::features::{ChannelFeatures, NodeFeatures};
 856         use lightning::ln::functional_test_utils::*;
 857         use lightning::ln::msgs::{ChannelMessageHandler, Init};
 858         use lightning::ln::peer_handler::{PeerManager, MessageHandler, SocketDescriptor, IgnoringMessageHandler};
 859         use lightning::routing::gossip::{NetworkGraph, NodeId, P2PGossipSync};
 860         use lightning::routing::router::{DefaultRouter, Path, RouteHop};
 861         use lightning::routing::scoring::{ChannelUsage, Score};
 862         use lightning::util::config::UserConfig;
 863         use lightning::util::ser::Writeable;
 864         use lightning::util::test_utils;
 865         use lightning::util::persist::KVStorePersister;
 866         use lightning_persister::FilesystemPersister;
 867         use std::collections::VecDeque;
 868         use std::{fs, env};
 869         use std::path::PathBuf;
 870         use std::sync::{Arc, Mutex};
 871         use std::sync::mpsc::SyncSender;
 872         use std::time::Duration;
 873         use lightning_rapid_gossip_sync::RapidGossipSync;
 874         use super::{BackgroundProcessor, GossipSync, FRESHNESS_TIMER};
 875
 876         const EVENT_DEADLINE: u64 = 5 * FRESHNESS_TIMER;
 877
 878         #[derive(Clone, Hash, PartialEq, Eq)]
 879         struct TestDescriptor{}
 880         impl SocketDescriptor for TestDescriptor {
 881                 fn send_data(&mut self, _data: &[u8], _resume_read: bool) -> usize {
 882                         0
 883                 }
 884
 885                 fn disconnect_socket(&mut self) {}
 886         }
 887
 888         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>>, (), TestScorer>>, Arc<test_utils::TestLogger>>;
 889
 890         type ChainMonitor = chainmonitor::ChainMonitor<InMemorySigner, Arc<test_utils::TestChainSource>, Arc<test_utils::TestBroadcaster>, Arc<test_utils::TestFeeEstimator>, Arc<test_utils::TestLogger>, Arc<FilesystemPersister>>;
 891
 892         type PGS = Arc<P2PGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>>>;
 893         type RGS = Arc<RapidGossipSync<Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestLogger>>>;
 894
 895         struct Node {
 896                 node: Arc<ChannelManager>,
 897                 p2p_gossip_sync: PGS,
 898                 rapid_gossip_sync: RGS,
 899                 peer_manager: Arc<PeerManager<TestDescriptor, Arc<test_utils::TestChannelMessageHandler>, Arc<test_utils::TestRoutingMessageHandler>, IgnoringMessageHandler, Arc<test_utils::TestLogger>, IgnoringMessageHandler, Arc<KeysManager>>>,
 900                 chain_monitor: Arc<ChainMonitor>,
 901                 persister: Arc<FilesystemPersister>,
 902                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
 903                 network_graph: Arc<NetworkGraph<Arc<test_utils::TestLogger>>>,
 904                 logger: Arc<test_utils::TestLogger>,
 905                 best_block: BestBlock,
 906                 scorer: Arc<Mutex<TestScorer>>,
 907         }
 908
 909         impl Node {
 910                 fn p2p_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
 911                         GossipSync::P2P(self.p2p_gossip_sync.clone())
 912                 }
 913
 914                 fn rapid_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
 915                         GossipSync::Rapid(self.rapid_gossip_sync.clone())
 916                 }
 917
 918                 fn no_gossip_sync(&self) -> GossipSync<PGS, RGS, Arc<NetworkGraph<Arc<test_utils::TestLogger>>>, Arc<test_utils::TestChainSource>, Arc<test_utils::TestLogger>> {
 919                         GossipSync::None
 920                 }
 921         }
 922
 923         impl Drop for Node {
 924                 fn drop(&mut self) {
 925                         let data_dir = self.persister.get_data_dir();
 926                         match fs::remove_dir_all(data_dir.clone()) {
 927                                 Err(e) => println!("Failed to remove test persister directory {}: {}", data_dir, e),
 928                                 _ => {}
 929                         }
 930                 }
 931         }
 932
 933         struct Persister {
 934                 graph_error: Option<(std::io::ErrorKind, &'static str)>,
 935                 graph_persistence_notifier: Option<SyncSender<()>>,
 936                 manager_error: Option<(std::io::ErrorKind, &'static str)>,
 937                 scorer_error: Option<(std::io::ErrorKind, &'static str)>,
 938                 filesystem_persister: FilesystemPersister,
 939         }
 940
 941         impl Persister {
 942                 fn new(data_dir: String) -> Self {
 943                         let filesystem_persister = FilesystemPersister::new(data_dir);
 944                         Self { graph_error: None, graph_persistence_notifier: None, manager_error: None, scorer_error: None, filesystem_persister }
 945                 }
 946
 947                 fn with_graph_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
 948                         Self { graph_error: Some((error, message)), ..self }
 949                 }
 950
 951                 fn with_graph_persistence_notifier(self, sender: SyncSender<()>) -> Self {
 952                         Self { graph_persistence_notifier: Some(sender), ..self }
 953                 }
 954
 955                 fn with_manager_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
 956                         Self { manager_error: Some((error, message)), ..self }
 957                 }
 958
 959                 fn with_scorer_error(self, error: std::io::ErrorKind, message: &'static str) -> Self {
 960                         Self { scorer_error: Some((error, message)), ..self }
 961                 }
 962         }
 963
 964         impl KVStorePersister for Persister {
 965                 fn persist<W: Writeable>(&self, key: &str, object: &W) -> std::io::Result<()> {
 966                         if key == "manager" {
 967                                 if let Some((error, message)) = self.manager_error {
 968                                         return Err(std::io::Error::new(error, message))
 969                                 }
 970                         }
 971
 972                         if key == "network_graph" {
 973                                 if let Some(sender) = &self.graph_persistence_notifier {
 974                                         match sender.send(()) {
 975                                                 Ok(()) => {},
 976                                                 Err(std::sync::mpsc::SendError(())) => println!("Persister failed to notify as receiver went away."),
 977                                         }
 978                                 };
 979
 980                                 if let Some((error, message)) = self.graph_error {
 981                                         return Err(std::io::Error::new(error, message))
 982                                 }
 983                         }
 984
 985                         if key == "scorer" {
 986                                 if let Some((error, message)) = self.scorer_error {
 987                                         return Err(std::io::Error::new(error, message))
 988                                 }
 989                         }
 990
 991                         self.filesystem_persister.persist(key, object)
 992                 }
 993         }
 994
 995         struct TestScorer {
 996                 event_expectations: Option<VecDeque<TestResult>>,
 997         }
 998
 999         #[derive(Debug)]
1000         enum TestResult {
1001                 PaymentFailure { path: Path, short_channel_id: u64 },
1002                 PaymentSuccess { path: Path },
1003                 ProbeFailure { path: Path },
1004                 ProbeSuccess { path: Path },
1005         }
1006
1007         impl TestScorer {
1008                 fn new() -> Self {
1009                         Self { event_expectations: None }
1010                 }
1011
1012                 fn expect(&mut self, expectation: TestResult) {
1013                         self.event_expectations.get_or_insert_with(VecDeque::new).push_back(expectation);
1014                 }
1015         }
1016
1017         impl lightning::util::ser::Writeable for TestScorer {
1018                 fn write<W: lightning::util::ser::Writer>(&self, _: &mut W) -> Result<(), lightning::io::Error> { Ok(()) }
1019         }
1020
1021         impl Score for TestScorer {
1022                 type ScoreParams = ();
1023                 fn channel_penalty_msat(
1024                         &self, _short_channel_id: u64, _source: &NodeId, _target: &NodeId, _usage: ChannelUsage, _score_params: &Self::ScoreParams
1025                 ) -> u64 { unimplemented!(); }
1026
1027                 fn payment_path_failed(&mut self, actual_path: &Path, actual_short_channel_id: u64) {
1028                         if let Some(expectations) = &mut self.event_expectations {
1029                                 match expectations.pop_front().unwrap() {
1030                                         TestResult::PaymentFailure { path, short_channel_id } => {
1031                                                 assert_eq!(actual_path, &path);
1032                                                 assert_eq!(actual_short_channel_id, short_channel_id);
1033                                         },
1034                                         TestResult::PaymentSuccess { path } => {
1035                                                 panic!("Unexpected successful payment path: {:?}", path)
1036                                         },
1037                                         TestResult::ProbeFailure { path } => {
1038                                                 panic!("Unexpected probe failure: {:?}", path)
1039                                         },
1040                                         TestResult::ProbeSuccess { path } => {
1041                                                 panic!("Unexpected probe success: {:?}", path)
1042                                         }
1043                                 }
1044                         }
1045                 }
1046
1047                 fn payment_path_successful(&mut self, actual_path: &Path) {
1048                         if let Some(expectations) = &mut self.event_expectations {
1049                                 match expectations.pop_front().unwrap() {
1050                                         TestResult::PaymentFailure { path, .. } => {
1051                                                 panic!("Unexpected payment path failure: {:?}", path)
1052                                         },
1053                                         TestResult::PaymentSuccess { path } => {
1054                                                 assert_eq!(actual_path, &path);
1055                                         },
1056                                         TestResult::ProbeFailure { path } => {
1057                                                 panic!("Unexpected probe failure: {:?}", path)
1058                                         },
1059                                         TestResult::ProbeSuccess { path } => {
1060                                                 panic!("Unexpected probe success: {:?}", path)
1061                                         }
1062                                 }
1063                         }
1064                 }
1065
1066                 fn probe_failed(&mut self, actual_path: &Path, _: u64) {
1067                         if let Some(expectations) = &mut self.event_expectations {
1068                                 match expectations.pop_front().unwrap() {
1069                                         TestResult::PaymentFailure { path, .. } => {
1070                                                 panic!("Unexpected payment path failure: {:?}", path)
1071                                         },
1072                                         TestResult::PaymentSuccess { path } => {
1073                                                 panic!("Unexpected payment path success: {:?}", path)
1074                                         },
1075                                         TestResult::ProbeFailure { path } => {
1076                                                 assert_eq!(actual_path, &path);
1077                                         },
1078                                         TestResult::ProbeSuccess { path } => {
1079                                                 panic!("Unexpected probe success: {:?}", path)
1080                                         }
1081                                 }
1082                         }
1083                 }
1084                 fn probe_successful(&mut self, actual_path: &Path) {
1085                         if let Some(expectations) = &mut self.event_expectations {
1086                                 match expectations.pop_front().unwrap() {
1087                                         TestResult::PaymentFailure { path, .. } => {
1088                                                 panic!("Unexpected payment path failure: {:?}", path)
1089                                         },
1090                                         TestResult::PaymentSuccess { path } => {
1091                                                 panic!("Unexpected payment path success: {:?}", path)
1092                                         },
1093                                         TestResult::ProbeFailure { path } => {
1094                                                 panic!("Unexpected probe failure: {:?}", path)
1095                                         },
1096                                         TestResult::ProbeSuccess { path } => {
1097                                                 assert_eq!(actual_path, &path);
1098                                         }
1099                                 }
1100                         }
1101                 }
1102         }
1103
1104         impl Drop for TestScorer {
1105                 fn drop(&mut self) {
1106                         if std::thread::panicking() {
1107                                 return;
1108                         }
1109
1110                         if let Some(event_expectations) = &self.event_expectations {
1111                                 if !event_expectations.is_empty() {
1112                                         panic!("Unsatisfied event expectations: {:?}", event_expectations);
1113                                 }
1114                         }
1115                 }
1116         }
1117
1118         fn get_full_filepath(filepath: String, filename: String) -> String {
1119                 let mut path = PathBuf::from(filepath);
1120                 path.push(filename);
1121                 path.to_str().unwrap().to_string()
1122         }
1123
1124         fn create_nodes(num_nodes: usize, persist_dir: &str) -> (String, Vec<Node>) {
1125                 let persist_temp_path = env::temp_dir().join(persist_dir);
1126                 let persist_dir = persist_temp_path.to_string_lossy().to_string();
1127                 let network = Network::Bitcoin;
1128                 let mut nodes = Vec::new();
1129                 for i in 0..num_nodes {
1130                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster::new(network));
1131                         let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) });
1132                         let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
1133                         let genesis_block = genesis_block(network);
1134                         let network_graph = Arc::new(NetworkGraph::new(network, logger.clone()));
1135                         let scorer = Arc::new(Mutex::new(TestScorer::new()));
1136                         let seed = [i as u8; 32];
1137                         let router = Arc::new(DefaultRouter::new(network_graph.clone(), logger.clone(), seed, scorer.clone(), ()));
1138                         let chain_source = Arc::new(test_utils::TestChainSource::new(Network::Bitcoin));
1139                         let persister = Arc::new(FilesystemPersister::new(format!("{}_persister_{}", &persist_dir, i)));
1140                         let now = Duration::from_secs(genesis_block.header.time as u64);
1141                         let keys_manager = Arc::new(KeysManager::new(&seed, now.as_secs(), now.subsec_nanos()));
1142                         let chain_monitor = Arc::new(chainmonitor::ChainMonitor::new(Some(chain_source.clone()), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone(), persister.clone()));
1143                         let best_block = BestBlock::from_network(network);
1144                         let params = ChainParameters { network, best_block };
1145                         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, genesis_block.header.time));
1146                         let p2p_gossip_sync = Arc::new(P2PGossipSync::new(network_graph.clone(), Some(chain_source.clone()), logger.clone()));
1147                         let rapid_gossip_sync = Arc::new(RapidGossipSync::new(network_graph.clone(), logger.clone()));
1148                         let msg_handler = MessageHandler {
1149                                 chan_handler: Arc::new(test_utils::TestChannelMessageHandler::new(ChainHash::using_genesis_block(Network::Testnet))),
1150                                 route_handler: Arc::new(test_utils::TestRoutingMessageHandler::new()),
1151                                 onion_message_handler: IgnoringMessageHandler{}, custom_message_handler: IgnoringMessageHandler{}
1152                         };
1153                         let peer_manager = Arc::new(PeerManager::new(msg_handler, 0, &seed, logger.clone(), keys_manager.clone()));
1154                         let node = Node { node: manager, p2p_gossip_sync, rapid_gossip_sync, peer_manager, chain_monitor, persister, tx_broadcaster, network_graph, logger, best_block, scorer };
1155                         nodes.push(node);
1156                 }
1157
1158                 for i in 0..num_nodes {
1159                         for j in (i+1)..num_nodes {
1160                                 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &Init {
1161                                         features: nodes[j].node.init_features(), networks: None, remote_network_address: None
1162                                 }, true).unwrap();
1163                                 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &Init {
1164                                         features: nodes[i].node.init_features(), networks: None, remote_network_address: None
1165                                 }, false).unwrap();
1166                         }
1167                 }
1168
1169                 (persist_dir, nodes)
1170         }
1171
1172         macro_rules! open_channel {
1173                 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
1174                         begin_open_channel!($node_a, $node_b, $channel_value);
1175                         let events = $node_a.node.get_and_clear_pending_events();
1176                         assert_eq!(events.len(), 1);
1177                         let (temporary_channel_id, tx) = handle_funding_generation_ready!(events[0], $channel_value);
1178                         $node_a.node.funding_transaction_generated(&temporary_channel_id, &$node_b.node.get_our_node_id(), tx.clone()).unwrap();
1179                         $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()));
1180                         get_event!($node_b, Event::ChannelPending);
1181                         $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()));
1182                         get_event!($node_a, Event::ChannelPending);
1183                         tx
1184                 }}
1185         }
1186
1187         macro_rules! begin_open_channel {
1188                 ($node_a: expr, $node_b: expr, $channel_value: expr) => {{
1189                         $node_a.node.create_channel($node_b.node.get_our_node_id(), $channel_value, 100, 42, None).unwrap();
1190                         $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()));
1191                         $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()));
1192                 }}
1193         }
1194
1195         macro_rules! handle_funding_generation_ready {
1196                 ($event: expr, $channel_value: expr) => {{
1197                         match $event {
1198                                 Event::FundingGenerationReady { temporary_channel_id, channel_value_satoshis, ref output_script, user_channel_id, .. } => {
1199                                         assert_eq!(channel_value_satoshis, $channel_value);
1200                                         assert_eq!(user_channel_id, 42);
1201
1202                                         let tx = Transaction { version: 1 as i32, lock_time: PackedLockTime(0), input: Vec::new(), output: vec![TxOut {
1203                                                 value: channel_value_satoshis, script_pubkey: output_script.clone(),
1204                                         }]};
1205                                         (temporary_channel_id, tx)
1206                                 },
1207                                 _ => panic!("Unexpected event"),
1208                         }
1209                 }}
1210         }
1211
1212         fn confirm_transaction_depth(node: &mut Node, tx: &Transaction, depth: u32) {
1213                 for i in 1..=depth {
1214                         let prev_blockhash = node.best_block.block_hash();
1215                         let height = node.best_block.height() + 1;
1216                         let header = create_dummy_header(prev_blockhash, height);
1217                         let txdata = vec![(0, tx)];
1218                         node.best_block = BestBlock::new(header.block_hash(), height);
1219                         match i {
1220                                 1 => {
1221                                         node.node.transactions_confirmed(&header, &txdata, height);
1222                                         node.chain_monitor.transactions_confirmed(&header, &txdata, height);
1223                                 },
1224                                 x if x == depth => {
1225                                         node.node.best_block_updated(&header, height);
1226                                         node.chain_monitor.best_block_updated(&header, height);
1227                                 },
1228                                 _ => {},
1229                         }
1230                 }
1231         }
1232         fn confirm_transaction(node: &mut Node, tx: &Transaction) {
1233                 confirm_transaction_depth(node, tx, ANTI_REORG_DELAY);
1234         }
1235
1236         #[test]
1237         fn test_background_processor() {
1238                 // Test that when a new channel is created, the ChannelManager needs to be re-persisted with
1239                 // updates. Also test that when new updates are available, the manager signals that it needs
1240                 // re-persistence and is successfully re-persisted.
1241                 let (persist_dir, nodes) = create_nodes(2, "test_background_processor");
1242
1243                 // Go through the channel creation process so that each node has something to persist. Since
1244                 // open_channel consumes events, it must complete before starting BackgroundProcessor to
1245                 // avoid a race with processing events.
1246                 let tx = open_channel!(nodes[0], nodes[1], 100000);
1247
1248                 // Initiate the background processors to watch each node.
1249                 let data_dir = nodes[0].persister.get_data_dir();
1250                 let persister = Arc::new(Persister::new(data_dir));
1251                 let event_handler = |_: _| {};
1252                 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()));
1253
1254                 macro_rules! check_persisted_data {
1255                         ($node: expr, $filepath: expr) => {
1256                                 let mut expected_bytes = Vec::new();
1257                                 loop {
1258                                         expected_bytes.clear();
1259                                         match $node.write(&mut expected_bytes) {
1260                                                 Ok(()) => {
1261                                                         match std::fs::read($filepath) {
1262                                                                 Ok(bytes) => {
1263                                                                         if bytes == expected_bytes {
1264                                                                                 break
1265                                                                         } else {
1266                                                                                 continue
1267                                                                         }
1268                                                                 },
1269                                                                 Err(_) => continue
1270                                                         }
1271                                                 },
1272                                                 Err(e) => panic!("Unexpected error: {}", e)
1273                                         }
1274                                 }
1275                         }
1276                 }
1277
1278                 // Check that the initial channel manager data is persisted as expected.
1279                 let filepath = get_full_filepath(format!("{}_persister_0", &persist_dir), "manager".to_string());
1280                 check_persisted_data!(nodes[0].node, filepath.clone());
1281
1282                 loop {
1283                         if !nodes[0].node.get_persistence_condvar_value() { break }
1284                 }
1285
1286                 // Force-close the channel.
1287                 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();
1288
1289                 // Check that the force-close updates are persisted.
1290                 check_persisted_data!(nodes[0].node, filepath.clone());
1291                 loop {
1292                         if !nodes[0].node.get_persistence_condvar_value() { break }
1293                 }
1294
1295                 // Check network graph is persisted
1296                 let filepath = get_full_filepath(format!("{}_persister_0", &persist_dir), "network_graph".to_string());
1297                 check_persisted_data!(nodes[0].network_graph, filepath.clone());
1298
1299                 // Check scorer is persisted
1300                 let filepath = get_full_filepath(format!("{}_persister_0", &persist_dir), "scorer".to_string());
1301                 check_persisted_data!(nodes[0].scorer, filepath.clone());
1302
1303                 if !std::thread::panicking() {
1304                         bg_processor.stop().unwrap();
1305                 }
1306         }
1307
1308         #[test]
1309         fn test_timer_tick_called() {
1310                 // Test that `ChannelManager::timer_tick_occurred` is called every `FRESHNESS_TIMER`,
1311                 // `ChainMonitor::rebroadcast_pending_claims` is called every `REBROADCAST_TIMER`, and
1312                 // `PeerManager::timer_tick_occurred` every `PING_TIMER`.
1313                 let (_, nodes) = create_nodes(1, "test_timer_tick_called");
1314                 let data_dir = nodes[0].persister.get_data_dir();
1315                 let persister = Arc::new(Persister::new(data_dir));
1316                 let event_handler = |_: _| {};
1317                 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()));
1318                 loop {
1319                         let log_entries = nodes[0].logger.lines.lock().unwrap();
1320                         let desired_log_1 = "Calling ChannelManager's timer_tick_occurred".to_string();
1321                         let desired_log_2 = "Calling PeerManager's timer_tick_occurred".to_string();
1322                         let desired_log_3 = "Rebroadcasting monitor's pending claims".to_string();
1323                         if log_entries.get(&("lightning_background_processor".to_string(), desired_log_1)).is_some() &&
1324                                 log_entries.get(&("lightning_background_processor".to_string(), desired_log_2)).is_some() &&
1325                                 log_entries.get(&("lightning_background_processor".to_string(), desired_log_3)).is_some() {
1326                                 break
1327                         }
1328                 }
1329
1330                 if !std::thread::panicking() {
1331                         bg_processor.stop().unwrap();
1332                 }
1333         }
1334
1335         #[test]
1336         fn test_channel_manager_persist_error() {
1337                 // Test that if we encounter an error during manager persistence, the thread panics.
1338                 let (_, nodes) = create_nodes(2, "test_persist_error");
1339                 open_channel!(nodes[0], nodes[1], 100000);
1340
1341                 let data_dir = nodes[0].persister.get_data_dir();
1342                 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
1343                 let event_handler = |_: _| {};
1344                 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()));
1345                 match bg_processor.join() {
1346                         Ok(_) => panic!("Expected error persisting manager"),
1347                         Err(e) => {
1348                                 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1349                                 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1350                         },
1351                 }
1352         }
1353
1354         #[tokio::test]
1355         #[cfg(feature = "futures")]
1356         async fn test_channel_manager_persist_error_async() {
1357                 // Test that if we encounter an error during manager persistence, the thread panics.
1358                 let (_, nodes) = create_nodes(2, "test_persist_error_sync");
1359                 open_channel!(nodes[0], nodes[1], 100000);
1360
1361                 let data_dir = nodes[0].persister.get_data_dir();
1362                 let persister = Arc::new(Persister::new(data_dir).with_manager_error(std::io::ErrorKind::Other, "test"));
1363
1364                 let bp_future = super::process_events_async(
1365                         persister, |_: _| {async {}}, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1366                         nodes[0].rapid_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1367                         Some(nodes[0].scorer.clone()), move |dur: Duration| {
1368                                 Box::pin(async move {
1369                                         tokio::time::sleep(dur).await;
1370                                         false // Never exit
1371                                 })
1372                         }, false,
1373                 );
1374                 match bp_future.await {
1375                         Ok(_) => panic!("Expected error persisting manager"),
1376                         Err(e) => {
1377                                 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1378                                 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1379                         },
1380                 }
1381         }
1382
1383         #[test]
1384         fn test_network_graph_persist_error() {
1385                 // Test that if we encounter an error during network graph persistence, an error gets returned.
1386                 let (_, nodes) = create_nodes(2, "test_persist_network_graph_error");
1387                 let data_dir = nodes[0].persister.get_data_dir();
1388                 let persister = Arc::new(Persister::new(data_dir).with_graph_error(std::io::ErrorKind::Other, "test"));
1389                 let event_handler = |_: _| {};
1390                 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()));
1391
1392                 match bg_processor.stop() {
1393                         Ok(_) => panic!("Expected error persisting network graph"),
1394                         Err(e) => {
1395                                 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1396                                 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1397                         },
1398                 }
1399         }
1400
1401         #[test]
1402         fn test_scorer_persist_error() {
1403                 // Test that if we encounter an error during scorer persistence, an error gets returned.
1404                 let (_, nodes) = create_nodes(2, "test_persist_scorer_error");
1405                 let data_dir = nodes[0].persister.get_data_dir();
1406                 let persister = Arc::new(Persister::new(data_dir).with_scorer_error(std::io::ErrorKind::Other, "test"));
1407                 let event_handler = |_: _| {};
1408                 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()));
1409
1410                 match bg_processor.stop() {
1411                         Ok(_) => panic!("Expected error persisting scorer"),
1412                         Err(e) => {
1413                                 assert_eq!(e.kind(), std::io::ErrorKind::Other);
1414                                 assert_eq!(e.get_ref().unwrap().to_string(), "test");
1415                         },
1416                 }
1417         }
1418
1419         #[test]
1420         fn test_background_event_handling() {
1421                 let (_, mut nodes) = create_nodes(2, "test_background_event_handling");
1422                 let channel_value = 100000;
1423                 let data_dir = nodes[0].persister.get_data_dir();
1424                 let persister = Arc::new(Persister::new(data_dir.clone()));
1425
1426                 // Set up a background event handler for FundingGenerationReady events.
1427                 let (funding_generation_send, funding_generation_recv) = std::sync::mpsc::sync_channel(1);
1428                 let (channel_pending_send, channel_pending_recv) = std::sync::mpsc::sync_channel(1);
1429                 let event_handler = move |event: Event| match event {
1430                         Event::FundingGenerationReady { .. } => funding_generation_send.send(handle_funding_generation_ready!(event, channel_value)).unwrap(),
1431                         Event::ChannelPending { .. } => channel_pending_send.send(()).unwrap(),
1432                         Event::ChannelReady { .. } => {},
1433                         _ => panic!("Unexpected event: {:?}", event),
1434                 };
1435
1436                 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()));
1437
1438                 // Open a channel and check that the FundingGenerationReady event was handled.
1439                 begin_open_channel!(nodes[0], nodes[1], channel_value);
1440                 let (temporary_channel_id, funding_tx) = funding_generation_recv
1441                         .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1442                         .expect("FundingGenerationReady not handled within deadline");
1443                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, &nodes[1].node.get_our_node_id(), funding_tx.clone()).unwrap();
1444                 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()));
1445                 get_event!(nodes[1], Event::ChannelPending);
1446                 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()));
1447                 let _ = channel_pending_recv.recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1448                         .expect("ChannelPending not handled within deadline");
1449
1450                 // Confirm the funding transaction.
1451                 confirm_transaction(&mut nodes[0], &funding_tx);
1452                 let as_funding = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReady, nodes[1].node.get_our_node_id());
1453                 confirm_transaction(&mut nodes[1], &funding_tx);
1454                 let bs_funding = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReady, nodes[0].node.get_our_node_id());
1455                 nodes[0].node.handle_channel_ready(&nodes[1].node.get_our_node_id(), &bs_funding);
1456                 let _as_channel_update = get_event_msg!(nodes[0], MessageSendEvent::SendChannelUpdate, nodes[1].node.get_our_node_id());
1457                 nodes[1].node.handle_channel_ready(&nodes[0].node.get_our_node_id(), &as_funding);
1458                 let _bs_channel_update = get_event_msg!(nodes[1], MessageSendEvent::SendChannelUpdate, nodes[0].node.get_our_node_id());
1459
1460                 if !std::thread::panicking() {
1461                         bg_processor.stop().unwrap();
1462                 }
1463
1464                 // Set up a background event handler for SpendableOutputs events.
1465                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1466                 let event_handler = move |event: Event| match event {
1467                         Event::SpendableOutputs { .. } => sender.send(event).unwrap(),
1468                         Event::ChannelReady { .. } => {},
1469                         Event::ChannelClosed { .. } => {},
1470                         _ => panic!("Unexpected event: {:?}", event),
1471                 };
1472                 let persister = Arc::new(Persister::new(data_dir));
1473                 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()));
1474
1475                 // Force close the channel and check that the SpendableOutputs event was handled.
1476                 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
1477                 let commitment_tx = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().pop().unwrap();
1478                 confirm_transaction_depth(&mut nodes[0], &commitment_tx, BREAKDOWN_TIMEOUT as u32);
1479
1480                 let event = receiver
1481                         .recv_timeout(Duration::from_secs(EVENT_DEADLINE))
1482                         .expect("Events not handled within deadline");
1483                 match event {
1484                         Event::SpendableOutputs { .. } => {},
1485                         _ => panic!("Unexpected event: {:?}", event),
1486                 }
1487
1488                 if !std::thread::panicking() {
1489                         bg_processor.stop().unwrap();
1490                 }
1491         }
1492
1493         #[test]
1494         fn test_scorer_persistence() {
1495                 let (_, nodes) = create_nodes(2, "test_scorer_persistence");
1496                 let data_dir = nodes[0].persister.get_data_dir();
1497                 let persister = Arc::new(Persister::new(data_dir));
1498                 let event_handler = |_: _| {};
1499                 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()));
1500
1501                 loop {
1502                         let log_entries = nodes[0].logger.lines.lock().unwrap();
1503                         let expected_log = "Persisting scorer".to_string();
1504                         if log_entries.get(&("lightning_background_processor".to_string(), expected_log)).is_some() {
1505                                 break
1506                         }
1507                 }
1508
1509                 if !std::thread::panicking() {
1510                         bg_processor.stop().unwrap();
1511                 }
1512         }
1513
1514         macro_rules! do_test_not_pruning_network_graph_until_graph_sync_completion {
1515                 ($nodes: expr, $receive: expr, $sleep: expr) => {
1516                         let features = ChannelFeatures::empty();
1517                         $nodes[0].network_graph.add_channel_from_partial_announcement(
1518                                 42, 53, features, $nodes[0].node.get_our_node_id(), $nodes[1].node.get_our_node_id()
1519                         ).expect("Failed to update channel from partial announcement");
1520                         let original_graph_description = $nodes[0].network_graph.to_string();
1521                         assert!(original_graph_description.contains("42: features: 0000, node_one:"));
1522                         assert_eq!($nodes[0].network_graph.read_only().channels().len(), 1);
1523
1524                         loop {
1525                                 $sleep;
1526                                 let log_entries = $nodes[0].logger.lines.lock().unwrap();
1527                                 let loop_counter = "Calling ChannelManager's timer_tick_occurred".to_string();
1528                                 if *log_entries.get(&("lightning_background_processor".to_string(), loop_counter))
1529                                         .unwrap_or(&0) > 1
1530                                 {
1531                                         // Wait until the loop has gone around at least twice.
1532                                         break
1533                                 }
1534                         }
1535
1536                         let initialization_input = vec![
1537                                 76, 68, 75, 1, 111, 226, 140, 10, 182, 241, 179, 114, 193, 166, 162, 70, 174, 99, 247,
1538                                 79, 147, 30, 131, 101, 225, 90, 8, 156, 104, 214, 25, 0, 0, 0, 0, 0, 97, 227, 98, 218,
1539                                 0, 0, 0, 4, 2, 22, 7, 207, 206, 25, 164, 197, 231, 230, 231, 56, 102, 61, 250, 251,
1540                                 187, 172, 38, 46, 79, 247, 108, 44, 155, 48, 219, 238, 252, 53, 192, 6, 67, 2, 36, 125,
1541                                 157, 176, 223, 175, 234, 116, 94, 248, 201, 225, 97, 235, 50, 47, 115, 172, 63, 136,
1542                                 88, 216, 115, 11, 111, 217, 114, 84, 116, 124, 231, 107, 2, 158, 1, 242, 121, 152, 106,
1543                                 204, 131, 186, 35, 93, 70, 216, 10, 237, 224, 183, 89, 95, 65, 3, 83, 185, 58, 138,
1544                                 181, 64, 187, 103, 127, 68, 50, 2, 201, 19, 17, 138, 136, 149, 185, 226, 156, 137, 175,
1545                                 110, 32, 237, 0, 217, 90, 31, 100, 228, 149, 46, 219, 175, 168, 77, 4, 143, 38, 128,
1546                                 76, 97, 0, 0, 0, 2, 0, 0, 255, 8, 153, 192, 0, 2, 27, 0, 0, 0, 1, 0, 0, 255, 2, 68,
1547                                 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,
1548                                 0, 0, 0, 1, 0, 0, 0, 0, 58, 85, 116, 216, 255, 8, 153, 192, 0, 2, 27, 0, 0, 25, 0, 0,
1549                                 0, 1, 0, 0, 0, 125, 255, 2, 68, 226, 0, 6, 11, 0, 1, 5, 0, 0, 0, 0, 29, 129, 25, 192,
1550                         ];
1551                         $nodes[0].rapid_gossip_sync.update_network_graph_no_std(&initialization_input[..], Some(1642291930)).unwrap();
1552
1553                         // this should have added two channels and pruned the previous one.
1554                         assert_eq!($nodes[0].network_graph.read_only().channels().len(), 2);
1555
1556                         $receive.expect("Network graph not pruned within deadline");
1557
1558                         // all channels should now be pruned
1559                         assert_eq!($nodes[0].network_graph.read_only().channels().len(), 0);
1560                 }
1561         }
1562
1563         #[test]
1564         fn test_not_pruning_network_graph_until_graph_sync_completion() {
1565                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1566
1567                 let (_, nodes) = create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion");
1568                 let data_dir = nodes[0].persister.get_data_dir();
1569                 let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
1570
1571                 let event_handler = |_: _| {};
1572                 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()));
1573
1574                 do_test_not_pruning_network_graph_until_graph_sync_completion!(nodes,
1575                         receiver.recv_timeout(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER * 5)),
1576                         std::thread::sleep(Duration::from_millis(1)));
1577
1578                 background_processor.stop().unwrap();
1579         }
1580
1581         #[tokio::test]
1582         #[cfg(feature = "futures")]
1583         async fn test_not_pruning_network_graph_until_graph_sync_completion_async() {
1584                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1585
1586                 let (_, nodes) = create_nodes(2, "test_not_pruning_network_graph_until_graph_sync_completion_async");
1587                 let data_dir = nodes[0].persister.get_data_dir();
1588                 let persister = Arc::new(Persister::new(data_dir).with_graph_persistence_notifier(sender));
1589
1590                 let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
1591                 let bp_future = super::process_events_async(
1592                         persister, |_: _| {async {}}, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1593                         nodes[0].rapid_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1594                         Some(nodes[0].scorer.clone()), move |dur: Duration| {
1595                                 let mut exit_receiver = exit_receiver.clone();
1596                                 Box::pin(async move {
1597                                         tokio::select! {
1598                                                 _ = tokio::time::sleep(dur) => false,
1599                                                 _ = exit_receiver.changed() => true,
1600                                         }
1601                                 })
1602                         }, false,
1603                 );
1604
1605                 let t1 = tokio::spawn(bp_future);
1606                 let t2 = tokio::spawn(async move {
1607                         do_test_not_pruning_network_graph_until_graph_sync_completion!(nodes, {
1608                                 let mut i = 0;
1609                                 loop {
1610                                         tokio::time::sleep(Duration::from_secs(super::FIRST_NETWORK_PRUNE_TIMER)).await;
1611                                         if let Ok(()) = receiver.try_recv() { break Ok::<(), ()>(()); }
1612                                         assert!(i < 5);
1613                                         i += 1;
1614                                 }
1615                         }, tokio::time::sleep(Duration::from_millis(1)).await);
1616                         exit_sender.send(()).unwrap();
1617                 });
1618                 let (r1, r2) = tokio::join!(t1, t2);
1619                 r1.unwrap().unwrap();
1620                 r2.unwrap()
1621         }
1622
1623         macro_rules! do_test_payment_path_scoring {
1624                 ($nodes: expr, $receive: expr) => {
1625                         // Ensure that we update the scorer when relevant events are processed. In this case, we ensure
1626                         // that we update the scorer upon a payment path succeeding (note that the channel must be
1627                         // public or else we won't score it).
1628                         // A background event handler for FundingGenerationReady events must be hooked up to a
1629                         // running background processor.
1630                         let scored_scid = 4242;
1631                         let secp_ctx = Secp256k1::new();
1632                         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
1633                         let node_1_id = PublicKey::from_secret_key(&secp_ctx, &node_1_privkey);
1634
1635                         let path = Path { hops: vec![RouteHop {
1636                                 pubkey: node_1_id,
1637                                 node_features: NodeFeatures::empty(),
1638                                 short_channel_id: scored_scid,
1639                                 channel_features: ChannelFeatures::empty(),
1640                                 fee_msat: 0,
1641                                 cltv_expiry_delta: MIN_CLTV_EXPIRY_DELTA as u32,
1642                         }], blinded_tail: None };
1643
1644                         $nodes[0].scorer.lock().unwrap().expect(TestResult::PaymentFailure { path: path.clone(), short_channel_id: scored_scid });
1645                         $nodes[0].node.push_pending_event(Event::PaymentPathFailed {
1646                                 payment_id: None,
1647                                 payment_hash: PaymentHash([42; 32]),
1648                                 payment_failed_permanently: false,
1649                                 failure: PathFailure::OnPath { network_update: None },
1650                                 path: path.clone(),
1651                                 short_channel_id: Some(scored_scid),
1652                         });
1653                         let event = $receive.expect("PaymentPathFailed not handled within deadline");
1654                         match event {
1655                                 Event::PaymentPathFailed { .. } => {},
1656                                 _ => panic!("Unexpected event"),
1657                         }
1658
1659                         // Ensure we'll score payments that were explicitly failed back by the destination as
1660                         // ProbeSuccess.
1661                         $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeSuccess { path: path.clone() });
1662                         $nodes[0].node.push_pending_event(Event::PaymentPathFailed {
1663                                 payment_id: None,
1664                                 payment_hash: PaymentHash([42; 32]),
1665                                 payment_failed_permanently: true,
1666                                 failure: PathFailure::OnPath { network_update: None },
1667                                 path: path.clone(),
1668                                 short_channel_id: None,
1669                         });
1670                         let event = $receive.expect("PaymentPathFailed not handled within deadline");
1671                         match event {
1672                                 Event::PaymentPathFailed { .. } => {},
1673                                 _ => panic!("Unexpected event"),
1674                         }
1675
1676                         $nodes[0].scorer.lock().unwrap().expect(TestResult::PaymentSuccess { path: path.clone() });
1677                         $nodes[0].node.push_pending_event(Event::PaymentPathSuccessful {
1678                                 payment_id: PaymentId([42; 32]),
1679                                 payment_hash: None,
1680                                 path: path.clone(),
1681                         });
1682                         let event = $receive.expect("PaymentPathSuccessful not handled within deadline");
1683                         match event {
1684                                 Event::PaymentPathSuccessful { .. } => {},
1685                                 _ => panic!("Unexpected event"),
1686                         }
1687
1688                         $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeSuccess { path: path.clone() });
1689                         $nodes[0].node.push_pending_event(Event::ProbeSuccessful {
1690                                 payment_id: PaymentId([42; 32]),
1691                                 payment_hash: PaymentHash([42; 32]),
1692                                 path: path.clone(),
1693                         });
1694                         let event = $receive.expect("ProbeSuccessful not handled within deadline");
1695                         match event {
1696                                 Event::ProbeSuccessful  { .. } => {},
1697                                 _ => panic!("Unexpected event"),
1698                         }
1699
1700                         $nodes[0].scorer.lock().unwrap().expect(TestResult::ProbeFailure { path: path.clone() });
1701                         $nodes[0].node.push_pending_event(Event::ProbeFailed {
1702                                 payment_id: PaymentId([42; 32]),
1703                                 payment_hash: PaymentHash([42; 32]),
1704                                 path,
1705                                 short_channel_id: Some(scored_scid),
1706                         });
1707                         let event = $receive.expect("ProbeFailure not handled within deadline");
1708                         match event {
1709                                 Event::ProbeFailed { .. } => {},
1710                                 _ => panic!("Unexpected event"),
1711                         }
1712                 }
1713         }
1714
1715         #[test]
1716         fn test_payment_path_scoring() {
1717                 let (sender, receiver) = std::sync::mpsc::sync_channel(1);
1718                 let event_handler = move |event: Event| match event {
1719                         Event::PaymentPathFailed { .. } => sender.send(event).unwrap(),
1720                         Event::PaymentPathSuccessful { .. } => sender.send(event).unwrap(),
1721                         Event::ProbeSuccessful { .. } => sender.send(event).unwrap(),
1722                         Event::ProbeFailed { .. } => sender.send(event).unwrap(),
1723                         _ => panic!("Unexpected event: {:?}", event),
1724                 };
1725
1726                 let (_, nodes) = create_nodes(1, "test_payment_path_scoring");
1727                 let data_dir = nodes[0].persister.get_data_dir();
1728                 let persister = Arc::new(Persister::new(data_dir));
1729                 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()));
1730
1731                 do_test_payment_path_scoring!(nodes, receiver.recv_timeout(Duration::from_secs(EVENT_DEADLINE)));
1732
1733                 if !std::thread::panicking() {
1734                         bg_processor.stop().unwrap();
1735                 }
1736
1737                 let log_entries = nodes[0].logger.lines.lock().unwrap();
1738                 let expected_log = "Persisting scorer after update".to_string();
1739                 assert_eq!(*log_entries.get(&("lightning_background_processor".to_string(), expected_log)).unwrap(), 5);
1740         }
1741
1742         #[tokio::test]
1743         #[cfg(feature = "futures")]
1744         async fn test_payment_path_scoring_async() {
1745                 let (sender, mut receiver) = tokio::sync::mpsc::channel(1);
1746                 let event_handler = move |event: Event| {
1747                         let sender_ref = sender.clone();
1748                         async move {
1749                                 match event {
1750                                         Event::PaymentPathFailed { .. } => { sender_ref.send(event).await.unwrap() },
1751                                         Event::PaymentPathSuccessful { .. } => { sender_ref.send(event).await.unwrap() },
1752                                         Event::ProbeSuccessful { .. } => { sender_ref.send(event).await.unwrap() },
1753                                         Event::ProbeFailed { .. } => { sender_ref.send(event).await.unwrap() },
1754                                         _ => panic!("Unexpected event: {:?}", event),
1755                                 }
1756                         }
1757                 };
1758
1759                 let (_, nodes) = create_nodes(1, "test_payment_path_scoring_async");
1760                 let data_dir = nodes[0].persister.get_data_dir();
1761                 let persister = Arc::new(Persister::new(data_dir));
1762
1763                 let (exit_sender, exit_receiver) = tokio::sync::watch::channel(());
1764
1765                 let bp_future = super::process_events_async(
1766                         persister, event_handler, nodes[0].chain_monitor.clone(), nodes[0].node.clone(),
1767                         nodes[0].no_gossip_sync(), nodes[0].peer_manager.clone(), nodes[0].logger.clone(),
1768                         Some(nodes[0].scorer.clone()), move |dur: Duration| {
1769                                 let mut exit_receiver = exit_receiver.clone();
1770                                 Box::pin(async move {
1771                                         tokio::select! {
1772                                                 _ = tokio::time::sleep(dur) => false,
1773                                                 _ = exit_receiver.changed() => true,
1774                                         }
1775                                 })
1776                         }, false,
1777                 );
1778                 let t1 = tokio::spawn(bp_future);
1779                 let t2 = tokio::spawn(async move {
1780                         do_test_payment_path_scoring!(nodes, receiver.recv().await);
1781                         exit_sender.send(()).unwrap();
1782
1783                         let log_entries = nodes[0].logger.lines.lock().unwrap();
1784                         let expected_log = "Persisting scorer after update".to_string();
1785                         assert_eq!(*log_entries.get(&("lightning_background_processor".to_string(), expected_log)).unwrap(), 5);
1786                 });
1787
1788                 let (r1, r2) = tokio::join!(t1, t2);
1789                 r1.unwrap().unwrap();
1790                 r2.unwrap()
1791         }
1792 }