_ Git - rust-lightning/blob - lightning/src/util/test_utils.rs

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 use crate::chain;
  11 use crate::chain::WatchedOutput;
  12 use crate::chain::chaininterface;
  13 use crate::chain::chaininterface::ConfirmationTarget;
  14 use crate::chain::chainmonitor;
  15 use crate::chain::chainmonitor::MonitorUpdateId;
  16 use crate::chain::channelmonitor;
  17 use crate::chain::channelmonitor::MonitorEvent;
  18 use crate::chain::transaction::OutPoint;
  19 use crate::chain::keysinterface;
  20 use crate::events;
  21 use crate::ln::channelmanager;
  22 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  23 use crate::ln::{msgs, wire};
  24 use crate::ln::msgs::LightningError;
  25 use crate::ln::script::ShutdownScript;
  26 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId};
  27 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
  28 use crate::routing::router::{find_route, InFlightHtlcs, Route, RouteHop, RouteParameters, Router, ScorerAccountingForInFlightHtlcs};
  29 use crate::routing::scoring::{ChannelUsage, Score};
  30 use crate::util::config::UserConfig;
  31 use crate::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
  32 use crate::util::logger::{Logger, Level, Record};
  33 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
  34
  35 use bitcoin::blockdata::constants::genesis_block;
  36 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  37 use bitcoin::blockdata::script::{Builder, Script};
  38 use bitcoin::blockdata::opcodes;
  39 use bitcoin::blockdata::block::Block;
  40 use bitcoin::network::constants::Network;
  41 use bitcoin::hash_types::{BlockHash, Txid};
  42
  43 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, ecdsa::Signature, Scalar};
  44 use bitcoin::secp256k1::ecdh::SharedSecret;
  45 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
  46
  47 use regex;
  48
  49 use crate::io;
  50 use crate::prelude::*;
  51 use core::cell::RefCell;
  52 use core::time::Duration;
  53 use crate::sync::{Mutex, Arc};
  54 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
  55 use core::mem;
  56 use bitcoin::bech32::u5;
  57 use crate::chain::keysinterface::{InMemorySigner, Recipient, EntropySource, NodeSigner, SignerProvider};
  58
  59 #[cfg(feature = "std")]
  60 use std::time::{SystemTime, UNIX_EPOCH};
  61 use bitcoin::Sequence;
  62
  63 pub struct TestVecWriter(pub Vec<u8>);
  64 impl Writer for TestVecWriter {
  65         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  66                 self.0.extend_from_slice(buf);
  67                 Ok(())
  68         }
  69 }
  70
  71 pub struct TestFeeEstimator {
  72         pub sat_per_kw: Mutex<u32>,
  73 }
  74 impl chaininterface::FeeEstimator for TestFeeEstimator {
  75         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
  76                 *self.sat_per_kw.lock().unwrap()
  77         }
  78 }
  79
  80 pub struct TestRouter<'a> {
  81         pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
  82         pub next_routes: Mutex<VecDeque<(RouteParameters, Result<Route, LightningError>)>>,
  83         pub scorer: &'a Mutex<TestScorer>,
  84 }
  85
  86 impl<'a> TestRouter<'a> {
  87         pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, scorer: &'a Mutex<TestScorer>) -> Self {
  88                 Self { network_graph, next_routes: Mutex::new(VecDeque::new()), scorer }
  89         }
  90
  91         pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
  92                 let mut expected_routes = self.next_routes.lock().unwrap();
  93                 expected_routes.push_back((query, result));
  94         }
  95 }
  96
  97 impl<'a> Router for TestRouter<'a> {
  98         fn find_route(
  99                 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&channelmanager::ChannelDetails]>,
 100                 inflight_htlcs: &InFlightHtlcs
 101         ) -> Result<Route, msgs::LightningError> {
 102                 if let Some((find_route_query, find_route_res)) = self.next_routes.lock().unwrap().pop_front() {
 103                         assert_eq!(find_route_query, *params);
 104                         if let Ok(ref route) = find_route_res {
 105                                 let locked_scorer = self.scorer.lock().unwrap();
 106                                 let scorer = ScorerAccountingForInFlightHtlcs::new(locked_scorer, inflight_htlcs);
 107                                 for path in &route.paths {
 108                                         let mut aggregate_msat = 0u64;
 109                                         for (idx, hop) in path.iter().rev().enumerate() {
 110                                                 aggregate_msat += hop.fee_msat;
 111                                                 let usage = ChannelUsage {
 112                                                         amount_msat: aggregate_msat,
 113                                                         inflight_htlc_msat: 0,
 114                                                         effective_capacity: EffectiveCapacity::Unknown,
 115                                                 };
 116
 117                                                 // Since the path is reversed, the last element in our iteration is the first
 118                                                 // hop.
 119                                                 if idx == path.len() - 1 {
 120                                                         scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(payer), &NodeId::from_pubkey(&hop.pubkey), usage);
 121                                                 } else {
 122                                                         let curr_hop_path_idx = path.len() - 1 - idx;
 123                                                         scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(&path[curr_hop_path_idx - 1].pubkey), &NodeId::from_pubkey(&hop.pubkey), usage);
 124                                                 }
 125                                         }
 126                                 }
 127                         }
 128                         return find_route_res;
 129                 }
 130                 let logger = TestLogger::new();
 131                 let scorer = self.scorer.lock().unwrap();
 132                 find_route(
 133                         payer, params, &self.network_graph, first_hops, &logger,
 134                         &ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs),
 135                         &[42; 32]
 136                 )
 137         }
 138 }
 139
 140 impl<'a> Drop for TestRouter<'a> {
 141         fn drop(&mut self) {
 142                 #[cfg(feature = "std")] {
 143                         if std::thread::panicking() {
 144                                 return;
 145                         }
 146                 }
 147                 assert!(self.next_routes.lock().unwrap().is_empty());
 148         }
 149 }
 150
 151 pub struct OnlyReadsKeysInterface {}
 152
 153 impl EntropySource for OnlyReadsKeysInterface {
 154         fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
 155
 156 impl SignerProvider for OnlyReadsKeysInterface {
 157         type Signer = EnforcingSigner;
 158
 159         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
 160
 161         fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer { unreachable!(); }
 162
 163         fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
 164                 let inner: InMemorySigner = Readable::read(&mut reader)?;
 165                 let state = Arc::new(Mutex::new(EnforcementState::new()));
 166
 167                 Ok(EnforcingSigner::new_with_revoked(
 168                         inner,
 169                         state,
 170                         false
 171                 ))
 172         }
 173
 174         fn get_destination_script(&self) -> Script { unreachable!(); }
 175         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); }
 176 }
 177
 178 pub struct TestChainMonitor<'a> {
 179         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
 180         pub monitor_updates: Mutex<HashMap<[u8; 32], Vec<channelmonitor::ChannelMonitorUpdate>>>,
 181         pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64, MonitorUpdateId)>>,
 182         pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<EnforcingSigner>>,
 183         pub keys_manager: &'a TestKeysInterface,
 184         /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
 185         /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
 186         /// boolean.
 187         pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
 188 }
 189 impl<'a> TestChainMonitor<'a> {
 190         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a chainmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
 191                 Self {
 192                         added_monitors: Mutex::new(Vec::new()),
 193                         monitor_updates: Mutex::new(HashMap::new()),
 194                         latest_monitor_update_id: Mutex::new(HashMap::new()),
 195                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
 196                         keys_manager,
 197                         expect_channel_force_closed: Mutex::new(None),
 198                 }
 199         }
 200
 201         pub fn complete_sole_pending_chan_update(&self, channel_id: &[u8; 32]) {
 202                 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
 203                 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
 204         }
 205 }
 206 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
 207         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
 208                 // At every point where we get a monitor update, we should be able to send a useful monitor
 209                 // to a watchtower and disk...
 210                 let mut w = TestVecWriter(Vec::new());
 211                 monitor.write(&mut w).unwrap();
 212                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 213                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
 214                 assert!(new_monitor == monitor);
 215                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 216                         (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
 217                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
 218                 self.chain_monitor.watch_channel(funding_txo, new_monitor)
 219         }
 220
 221         fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 222                 // Every monitor update should survive roundtrip
 223                 let mut w = TestVecWriter(Vec::new());
 224                 update.write(&mut w).unwrap();
 225                 assert!(channelmonitor::ChannelMonitorUpdate::read(
 226                                 &mut io::Cursor::new(&w.0)).unwrap() == *update);
 227
 228                 self.monitor_updates.lock().unwrap().entry(funding_txo.to_channel_id()).or_insert(Vec::new()).push(update.clone());
 229
 230                 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
 231                         assert_eq!(funding_txo.to_channel_id(), exp.0);
 232                         assert_eq!(update.updates.len(), 1);
 233                         if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
 234                                 assert_eq!(should_broadcast, exp.1);
 235                         } else { panic!(); }
 236                 }
 237
 238                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 239                         (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
 240                 let update_res = self.chain_monitor.update_channel(funding_txo, update);
 241                 // At every point where we get a monitor update, we should be able to send a useful monitor
 242                 // to a watchtower and disk...
 243                 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
 244                 w.0.clear();
 245                 monitor.write(&mut w).unwrap();
 246                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 247                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
 248                 assert!(new_monitor == *monitor);
 249                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
 250                 update_res
 251         }
 252
 253         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
 254                 return self.chain_monitor.release_pending_monitor_events();
 255         }
 256 }
 257
 258 pub struct TestPersister {
 259         /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
 260         /// returned.
 261         pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
 262         /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
 263         /// MonitorUpdateId here.
 264         pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
 265         /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
 266         /// MonitorUpdateId here.
 267         pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
 268 }
 269 impl TestPersister {
 270         pub fn new() -> Self {
 271                 Self {
 272                         update_rets: Mutex::new(VecDeque::new()),
 273                         chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
 274                         offchain_monitor_updates: Mutex::new(HashMap::new()),
 275                 }
 276         }
 277
 278         /// Queue an update status to return.
 279         pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
 280                 self.update_rets.lock().unwrap().push_back(next_ret);
 281         }
 282 }
 283 impl<Signer: keysinterface::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
 284         fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 285                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
 286                         return update_ret
 287                 }
 288                 chain::ChannelMonitorUpdateStatus::Completed
 289         }
 290
 291         fn update_persisted_channel(&self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
 292                 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
 293                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
 294                         ret = update_ret;
 295                 }
 296                 if update.is_none() {
 297                         self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
 298                 } else {
 299                         self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
 300                 }
 301                 ret
 302         }
 303 }
 304
 305 pub struct TestBroadcaster {
 306         pub txn_broadcasted: Mutex<Vec<Transaction>>,
 307         pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
 308 }
 309
 310 impl TestBroadcaster {
 311         pub fn new(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> TestBroadcaster {
 312                 TestBroadcaster { txn_broadcasted: Mutex::new(Vec::new()), blocks }
 313         }
 314 }
 315
 316 impl chaininterface::BroadcasterInterface for TestBroadcaster {
 317         fn broadcast_transaction(&self, tx: &Transaction) {
 318                 let lock_time = tx.lock_time.0;
 319                 assert!(lock_time < 1_500_000_000);
 320                 if lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && lock_time < 500_000_000 {
 321                         for inp in tx.input.iter() {
 322                                 if inp.sequence != Sequence::MAX {
 323                                         panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
 324                                 }
 325                         }
 326                 }
 327                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
 328         }
 329 }
 330
 331 pub struct TestChannelMessageHandler {
 332         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 333         expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
 334         connected_peers: Mutex<HashSet<PublicKey>>,
 335 }
 336
 337 impl TestChannelMessageHandler {
 338         pub fn new() -> Self {
 339                 TestChannelMessageHandler {
 340                         pending_events: Mutex::new(Vec::new()),
 341                         expected_recv_msgs: Mutex::new(None),
 342                         connected_peers: Mutex::new(HashSet::new()),
 343                 }
 344         }
 345
 346         #[cfg(test)]
 347         pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
 348                 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
 349                 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
 350                 expected_msgs.as_mut().unwrap().push(ev);
 351         }
 352
 353         fn received_msg(&self, _ev: wire::Message<()>) {
 354                 let mut msgs = self.expected_recv_msgs.lock().unwrap();
 355                 if msgs.is_none() { return; }
 356                 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
 357                 #[cfg(test)]
 358                 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
 359                 msgs.as_mut().unwrap().remove(0);
 360         }
 361 }
 362
 363 impl Drop for TestChannelMessageHandler {
 364         fn drop(&mut self) {
 365                 #[cfg(feature = "std")]
 366                 {
 367                         let l = self.expected_recv_msgs.lock().unwrap();
 368                         if !std::thread::panicking() {
 369                                 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
 370                         }
 371                 }
 372         }
 373 }
 374
 375 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 376         fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
 377                 self.received_msg(wire::Message::OpenChannel(msg.clone()));
 378         }
 379         fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
 380                 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
 381         }
 382         fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 383                 self.received_msg(wire::Message::FundingCreated(msg.clone()));
 384         }
 385         fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 386                 self.received_msg(wire::Message::FundingSigned(msg.clone()));
 387         }
 388         fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
 389                 self.received_msg(wire::Message::ChannelReady(msg.clone()));
 390         }
 391         fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
 392                 self.received_msg(wire::Message::Shutdown(msg.clone()));
 393         }
 394         fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 395                 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
 396         }
 397         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 398                 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
 399         }
 400         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 401                 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
 402         }
 403         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 404                 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
 405         }
 406         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 407                 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
 408         }
 409         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 410                 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
 411         }
 412         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 413                 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
 414         }
 415         fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 416                 self.received_msg(wire::Message::UpdateFee(msg.clone()));
 417         }
 418         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
 419                 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
 420         }
 421         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 422                 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
 423         }
 424         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 425                 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
 426         }
 427         fn peer_disconnected(&self, their_node_id: &PublicKey) {
 428                 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
 429         }
 430         fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 431                 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
 432                 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
 433                 // bother re-generating the expected Init message in all tests.
 434                 Ok(())
 435         }
 436         fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
 437                 self.received_msg(wire::Message::Error(msg.clone()));
 438         }
 439         fn provided_node_features(&self) -> NodeFeatures {
 440                 channelmanager::provided_node_features(&UserConfig::default())
 441         }
 442         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
 443                 channelmanager::provided_init_features(&UserConfig::default())
 444         }
 445 }
 446
 447 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 448         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 449                 let mut pending_events = self.pending_events.lock().unwrap();
 450                 let mut ret = Vec::new();
 451                 mem::swap(&mut ret, &mut *pending_events);
 452                 ret
 453         }
 454 }
 455
 456 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
 457         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 458         let secp_ctx = Secp256k1::new();
 459         let network = Network::Testnet;
 460         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
 461         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
 462         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
 463         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
 464         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
 465                 features: ChannelFeatures::empty(),
 466                 chain_hash: genesis_block(network).header.block_hash(),
 467                 short_channel_id: short_chan_id,
 468                 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
 469                 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
 470                 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
 471                 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
 472                 excess_data: Vec::new(),
 473         };
 474
 475         unsafe {
 476                 msgs::ChannelAnnouncement {
 477                         node_signature_1: Signature::from(FFISignature::new()),
 478                         node_signature_2: Signature::from(FFISignature::new()),
 479                         bitcoin_signature_1: Signature::from(FFISignature::new()),
 480                         bitcoin_signature_2: Signature::from(FFISignature::new()),
 481                         contents: unsigned_ann,
 482                 }
 483         }
 484 }
 485
 486 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
 487         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 488         let network = Network::Testnet;
 489         msgs::ChannelUpdate {
 490                 signature: Signature::from(unsafe { FFISignature::new() }),
 491                 contents: msgs::UnsignedChannelUpdate {
 492                         chain_hash: genesis_block(network).header.block_hash(),
 493                         short_channel_id: short_chan_id,
 494                         timestamp: 0,
 495                         flags: 0,
 496                         cltv_expiry_delta: 0,
 497                         htlc_minimum_msat: 0,
 498                         htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
 499                         fee_base_msat: 0,
 500                         fee_proportional_millionths: 0,
 501                         excess_data: vec![],
 502                 }
 503         }
 504 }
 505
 506 pub struct TestRoutingMessageHandler {
 507         pub chan_upds_recvd: AtomicUsize,
 508         pub chan_anns_recvd: AtomicUsize,
 509         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 510         pub request_full_sync: AtomicBool,
 511 }
 512
 513 impl TestRoutingMessageHandler {
 514         pub fn new() -> Self {
 515                 TestRoutingMessageHandler {
 516                         chan_upds_recvd: AtomicUsize::new(0),
 517                         chan_anns_recvd: AtomicUsize::new(0),
 518                         pending_events: Mutex::new(vec![]),
 519                         request_full_sync: AtomicBool::new(false),
 520                 }
 521         }
 522 }
 523 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 524         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
 525                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 526         }
 527         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
 528                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
 529                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 530         }
 531         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
 532                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
 533                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 534         }
 535         fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
 536                 let chan_upd_1 = get_dummy_channel_update(starting_point);
 537                 let chan_upd_2 = get_dummy_channel_update(starting_point);
 538                 let chan_ann = get_dummy_channel_announcement(starting_point);
 539
 540                 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
 541         }
 542
 543         fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
 544                 None
 545         }
 546
 547         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 548                 if !init_msg.features.supports_gossip_queries() {
 549                         return Ok(());
 550                 }
 551
 552                 #[allow(unused_mut, unused_assignments)]
 553                 let mut gossip_start_time = 0;
 554                 #[cfg(feature = "std")]
 555                 {
 556                         gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
 557                         if self.request_full_sync.load(Ordering::Acquire) {
 558                                 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
 559                         } else {
 560                                 gossip_start_time -= 60 * 60; // an hour ago
 561                         }
 562                 }
 563
 564                 let mut pending_events = self.pending_events.lock().unwrap();
 565                 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
 566                         node_id: their_node_id.clone(),
 567                         msg: msgs::GossipTimestampFilter {
 568                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
 569                                 first_timestamp: gossip_start_time as u32,
 570                                 timestamp_range: u32::max_value(),
 571                         },
 572                 });
 573                 Ok(())
 574         }
 575
 576         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
 577                 Ok(())
 578         }
 579
 580         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
 581                 Ok(())
 582         }
 583
 584         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
 585                 Ok(())
 586         }
 587
 588         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
 589                 Ok(())
 590         }
 591
 592         fn provided_node_features(&self) -> NodeFeatures {
 593                 let mut features = NodeFeatures::empty();
 594                 features.set_gossip_queries_optional();
 595                 features
 596         }
 597
 598         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
 599                 let mut features = InitFeatures::empty();
 600                 features.set_gossip_queries_optional();
 601                 features
 602         }
 603
 604         fn processing_queue_high(&self) -> bool { false }
 605 }
 606
 607 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
 608         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 609                 let mut ret = Vec::new();
 610                 let mut pending_events = self.pending_events.lock().unwrap();
 611                 core::mem::swap(&mut ret, &mut pending_events);
 612                 ret
 613         }
 614 }
 615
 616 pub struct TestLogger {
 617         level: Level,
 618         pub(crate) id: String,
 619         pub lines: Mutex<HashMap<(String, String), usize>>,
 620 }
 621
 622 impl TestLogger {
 623         pub fn new() -> TestLogger {
 624                 Self::with_id("".to_owned())
 625         }
 626         pub fn with_id(id: String) -> TestLogger {
 627                 TestLogger {
 628                         level: Level::Trace,
 629                         id,
 630                         lines: Mutex::new(HashMap::new())
 631                 }
 632         }
 633         pub fn enable(&mut self, level: Level) {
 634                 self.level = level;
 635         }
 636         pub fn assert_log(&self, module: String, line: String, count: usize) {
 637                 let log_entries = self.lines.lock().unwrap();
 638                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
 639         }
 640
 641         /// Search for the number of occurrence of the logged lines which
 642         /// 1. belongs to the specified module and
 643         /// 2. contains `line` in it.
 644         /// And asserts if the number of occurrences is the same with the given `count`
 645         pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
 646                 let log_entries = self.lines.lock().unwrap();
 647                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 648                         m == module && l.contains(line)
 649                 }).map(|(_, c) | { c }).sum();
 650                 assert_eq!(l, count)
 651         }
 652
 653         /// Search for the number of occurrences of logged lines which
 654         /// 1. belong to the specified module and
 655         /// 2. match the given regex pattern.
 656         /// Assert that the number of occurrences equals the given `count`
 657         pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
 658                 let log_entries = self.lines.lock().unwrap();
 659                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 660                         m == module && pattern.is_match(&l)
 661                 }).map(|(_, c) | { c }).sum();
 662                 assert_eq!(l, count)
 663         }
 664 }
 665
 666 impl Logger for TestLogger {
 667         fn log(&self, record: &Record) {
 668                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 669                 if record.level >= self.level {
 670                         #[cfg(feature = "std")]
 671                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 672                 }
 673         }
 674 }
 675
 676 pub struct TestNodeSigner {
 677         node_secret: SecretKey,
 678 }
 679
 680 impl TestNodeSigner {
 681         pub fn new(node_secret: SecretKey) -> Self {
 682                 Self { node_secret }
 683         }
 684 }
 685
 686 impl NodeSigner for TestNodeSigner {
 687         fn get_inbound_payment_key_material(&self) -> crate::chain::keysinterface::KeyMaterial {
 688                 unreachable!()
 689         }
 690
 691         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
 692                 let node_secret = match recipient {
 693                         Recipient::Node => Ok(&self.node_secret),
 694                         Recipient::PhantomNode => Err(())
 695                 }?;
 696                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
 697         }
 698
 699         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
 700                 let mut node_secret = match recipient {
 701                         Recipient::Node => Ok(self.node_secret.clone()),
 702                         Recipient::PhantomNode => Err(())
 703                 }?;
 704                 if let Some(tweak) = tweak {
 705                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
 706                 }
 707                 Ok(SharedSecret::new(other_key, &node_secret))
 708         }
 709
 710         fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
 711                 unreachable!()
 712         }
 713
 714         fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
 715                 unreachable!()
 716         }
 717 }
 718
 719 pub struct TestKeysInterface {
 720         pub backing: keysinterface::PhantomKeysManager,
 721         pub override_random_bytes: Mutex<Option<[u8; 32]>>,
 722         pub disable_revocation_policy_check: bool,
 723         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
 724         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
 725 }
 726
 727 impl EntropySource for TestKeysInterface {
 728         fn get_secure_random_bytes(&self) -> [u8; 32] {
 729                 let override_random_bytes = self.override_random_bytes.lock().unwrap();
 730                 if let Some(bytes) = &*override_random_bytes {
 731                         return *bytes;
 732                 }
 733                 self.backing.get_secure_random_bytes()
 734         }
 735 }
 736
 737 impl NodeSigner for TestKeysInterface {
 738         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
 739                 self.backing.get_node_id(recipient)
 740         }
 741
 742         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
 743                 self.backing.ecdh(recipient, other_key, tweak)
 744         }
 745
 746         fn get_inbound_payment_key_material(&self) -> keysinterface::KeyMaterial {
 747                 self.backing.get_inbound_payment_key_material()
 748         }
 749
 750         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
 751                 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
 752         }
 753
 754         fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
 755                 self.backing.sign_gossip_message(msg)
 756         }
 757 }
 758
 759 impl SignerProvider for TestKeysInterface {
 760         type Signer = EnforcingSigner;
 761
 762         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
 763                 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
 764         }
 765
 766         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> EnforcingSigner {
 767                 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
 768                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 769                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 770         }
 771
 772         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
 773                 let mut reader = io::Cursor::new(buffer);
 774
 775                 let inner: InMemorySigner = Readable::read(&mut reader)?;
 776                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
 777
 778                 Ok(EnforcingSigner::new_with_revoked(
 779                         inner,
 780                         state,
 781                         self.disable_revocation_policy_check
 782                 ))
 783         }
 784
 785         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 786
 787         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
 788                 match &mut *self.expectations.lock().unwrap() {
 789                         None => self.backing.get_shutdown_scriptpubkey(),
 790                         Some(expectations) => match expectations.pop_front() {
 791                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
 792                                 Some(expectation) => expectation.returns,
 793                         },
 794                 }
 795         }
 796 }
 797
 798 impl TestKeysInterface {
 799         pub fn new(seed: &[u8; 32], network: Network) -> Self {
 800                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
 801                 Self {
 802                         backing: keysinterface::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
 803                         override_random_bytes: Mutex::new(None),
 804                         disable_revocation_policy_check: false,
 805                         enforcement_states: Mutex::new(HashMap::new()),
 806                         expectations: Mutex::new(None),
 807                 }
 808         }
 809
 810         /// Sets an expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] is
 811         /// called.
 812         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
 813                 self.expectations.lock().unwrap()
 814                         .get_or_insert_with(|| VecDeque::new())
 815                         .push_back(expectation);
 816                 self
 817         }
 818
 819         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
 820                 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
 821                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 822                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 823         }
 824
 825         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
 826                 let mut states = self.enforcement_states.lock().unwrap();
 827                 if !states.contains_key(&commitment_seed) {
 828                         let state = EnforcementState::new();
 829                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
 830                 }
 831                 let cell = states.get(&commitment_seed).unwrap();
 832                 Arc::clone(cell)
 833         }
 834 }
 835
 836 pub(crate) fn panicking() -> bool {
 837         #[cfg(feature = "std")]
 838         let panicking = ::std::thread::panicking();
 839         #[cfg(not(feature = "std"))]
 840         let panicking = false;
 841         return panicking;
 842 }
 843
 844 impl Drop for TestKeysInterface {
 845         fn drop(&mut self) {
 846                 if panicking() {
 847                         return;
 848                 }
 849
 850                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 851                         if !expectations.is_empty() {
 852                                 panic!("Unsatisfied expectations: {:?}", expectations);
 853                         }
 854                 }
 855         }
 856 }
 857
 858 /// An expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] was called and
 859 /// returns a [`ShutdownScript`].
 860 pub struct OnGetShutdownScriptpubkey {
 861         /// A shutdown script used to close a channel.
 862         pub returns: ShutdownScript,
 863 }
 864
 865 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
 866         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 867                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
 868         }
 869 }
 870
 871 pub struct TestChainSource {
 872         pub genesis_hash: BlockHash,
 873         pub utxo_ret: Mutex<UtxoResult>,
 874         pub get_utxo_call_count: AtomicUsize,
 875         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
 876         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
 877 }
 878
 879 impl TestChainSource {
 880         pub fn new(network: Network) -> Self {
 881                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
 882                 Self {
 883                         genesis_hash: genesis_block(network).block_hash(),
 884                         utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
 885                         get_utxo_call_count: AtomicUsize::new(0),
 886                         watched_txn: Mutex::new(HashSet::new()),
 887                         watched_outputs: Mutex::new(HashSet::new()),
 888                 }
 889         }
 890 }
 891
 892 impl UtxoLookup for TestChainSource {
 893         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
 894                 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
 895                 if self.genesis_hash != *genesis_hash {
 896                         return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
 897                 }
 898
 899                 self.utxo_ret.lock().unwrap().clone()
 900         }
 901 }
 902
 903 impl chain::Filter for TestChainSource {
 904         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
 905                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
 906         }
 907
 908         fn register_output(&self, output: WatchedOutput) {
 909                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
 910         }
 911 }
 912
 913 impl Drop for TestChainSource {
 914         fn drop(&mut self) {
 915                 if panicking() {
 916                         return;
 917                 }
 918         }
 919 }
 920
 921 pub struct TestScorer {
 922         /// Stores a tuple of (scid, ChannelUsage)
 923         scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
 924 }
 925
 926 impl TestScorer {
 927         pub fn new() -> Self {
 928                 Self {
 929                         scorer_expectations: RefCell::new(None),
 930                 }
 931         }
 932
 933         pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
 934                 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
 935         }
 936 }
 937
 938 #[cfg(c_bindings)]
 939 impl crate::util::ser::Writeable for TestScorer {
 940         fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
 941 }
 942
 943 impl Score for TestScorer {
 944         fn channel_penalty_msat(
 945                 &self, short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage
 946         ) -> u64 {
 947                 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
 948                         match scorer_expectations.pop_front() {
 949                                 Some((scid, expectation)) => {
 950                                         assert_eq!(expectation, usage);
 951                                         assert_eq!(scid, short_channel_id);
 952                                 },
 953                                 None => {},
 954                         }
 955                 }
 956                 0
 957         }
 958
 959         fn payment_path_failed(&mut self, _actual_path: &[&RouteHop], _actual_short_channel_id: u64) {}
 960
 961         fn payment_path_successful(&mut self, _actual_path: &[&RouteHop]) {}
 962
 963         fn probe_failed(&mut self, _actual_path: &[&RouteHop], _: u64) {}
 964
 965         fn probe_successful(&mut self, _actual_path: &[&RouteHop]) {}
 966 }
 967
 968 impl Drop for TestScorer {
 969         fn drop(&mut self) {
 970                 #[cfg(feature = "std")] {
 971                         if std::thread::panicking() {
 972                                 return;
 973                         }
 974                 }
 975
 976                 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
 977                         if !scorer_expectations.is_empty() {
 978                                 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
 979                         }
 980                 }
 981         }
 982 }