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