_ 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 = ReadableArgs::read(&mut reader, self)?;
 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(network: Network) -> Self {
 312                 Self {
 313                         txn_broadcasted: Mutex::new(Vec::new()),
 314                         blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
 315                 }
 316         }
 317
 318         pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
 319                 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
 320         }
 321
 322         pub fn txn_broadcast(&self) -> Vec<Transaction> {
 323                 self.txn_broadcasted.lock().unwrap().split_off(0)
 324         }
 325
 326         pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
 327                 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
 328                 let mut seen = HashSet::new();
 329                 txn.retain(|tx| seen.insert(tx.txid()));
 330                 txn
 331         }
 332 }
 333
 334 impl chaininterface::BroadcasterInterface for TestBroadcaster {
 335         fn broadcast_transaction(&self, tx: &Transaction) {
 336                 let lock_time = tx.lock_time.0;
 337                 assert!(lock_time < 1_500_000_000);
 338                 if lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && lock_time < 500_000_000 {
 339                         for inp in tx.input.iter() {
 340                                 if inp.sequence != Sequence::MAX {
 341                                         panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
 342                                 }
 343                         }
 344                 }
 345                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
 346         }
 347 }
 348
 349 pub struct TestChannelMessageHandler {
 350         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 351         expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
 352         connected_peers: Mutex<HashSet<PublicKey>>,
 353 }
 354
 355 impl TestChannelMessageHandler {
 356         pub fn new() -> Self {
 357                 TestChannelMessageHandler {
 358                         pending_events: Mutex::new(Vec::new()),
 359                         expected_recv_msgs: Mutex::new(None),
 360                         connected_peers: Mutex::new(HashSet::new()),
 361                 }
 362         }
 363
 364         #[cfg(test)]
 365         pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
 366                 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
 367                 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
 368                 expected_msgs.as_mut().unwrap().push(ev);
 369         }
 370
 371         fn received_msg(&self, _ev: wire::Message<()>) {
 372                 let mut msgs = self.expected_recv_msgs.lock().unwrap();
 373                 if msgs.is_none() { return; }
 374                 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
 375                 #[cfg(test)]
 376                 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
 377                 msgs.as_mut().unwrap().remove(0);
 378         }
 379 }
 380
 381 impl Drop for TestChannelMessageHandler {
 382         fn drop(&mut self) {
 383                 #[cfg(feature = "std")]
 384                 {
 385                         let l = self.expected_recv_msgs.lock().unwrap();
 386                         if !std::thread::panicking() {
 387                                 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
 388                         }
 389                 }
 390         }
 391 }
 392
 393 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 394         fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
 395                 self.received_msg(wire::Message::OpenChannel(msg.clone()));
 396         }
 397         fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
 398                 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
 399         }
 400         fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 401                 self.received_msg(wire::Message::FundingCreated(msg.clone()));
 402         }
 403         fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 404                 self.received_msg(wire::Message::FundingSigned(msg.clone()));
 405         }
 406         fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
 407                 self.received_msg(wire::Message::ChannelReady(msg.clone()));
 408         }
 409         fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
 410                 self.received_msg(wire::Message::Shutdown(msg.clone()));
 411         }
 412         fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 413                 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
 414         }
 415         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 416                 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
 417         }
 418         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 419                 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
 420         }
 421         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 422                 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
 423         }
 424         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 425                 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
 426         }
 427         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 428                 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
 429         }
 430         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 431                 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
 432         }
 433         fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 434                 self.received_msg(wire::Message::UpdateFee(msg.clone()));
 435         }
 436         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
 437                 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
 438         }
 439         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 440                 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
 441         }
 442         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 443                 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
 444         }
 445         fn peer_disconnected(&self, their_node_id: &PublicKey) {
 446                 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
 447         }
 448         fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 449                 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
 450                 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
 451                 // bother re-generating the expected Init message in all tests.
 452                 Ok(())
 453         }
 454         fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
 455                 self.received_msg(wire::Message::Error(msg.clone()));
 456         }
 457         fn provided_node_features(&self) -> NodeFeatures {
 458                 channelmanager::provided_node_features(&UserConfig::default())
 459         }
 460         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
 461                 channelmanager::provided_init_features(&UserConfig::default())
 462         }
 463 }
 464
 465 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 466         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 467                 let mut pending_events = self.pending_events.lock().unwrap();
 468                 let mut ret = Vec::new();
 469                 mem::swap(&mut ret, &mut *pending_events);
 470                 ret
 471         }
 472 }
 473
 474 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
 475         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 476         let secp_ctx = Secp256k1::new();
 477         let network = Network::Testnet;
 478         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
 479         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
 480         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
 481         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
 482         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
 483                 features: ChannelFeatures::empty(),
 484                 chain_hash: genesis_block(network).header.block_hash(),
 485                 short_channel_id: short_chan_id,
 486                 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
 487                 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
 488                 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
 489                 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
 490                 excess_data: Vec::new(),
 491         };
 492
 493         unsafe {
 494                 msgs::ChannelAnnouncement {
 495                         node_signature_1: Signature::from(FFISignature::new()),
 496                         node_signature_2: Signature::from(FFISignature::new()),
 497                         bitcoin_signature_1: Signature::from(FFISignature::new()),
 498                         bitcoin_signature_2: Signature::from(FFISignature::new()),
 499                         contents: unsigned_ann,
 500                 }
 501         }
 502 }
 503
 504 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
 505         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 506         let network = Network::Testnet;
 507         msgs::ChannelUpdate {
 508                 signature: Signature::from(unsafe { FFISignature::new() }),
 509                 contents: msgs::UnsignedChannelUpdate {
 510                         chain_hash: genesis_block(network).header.block_hash(),
 511                         short_channel_id: short_chan_id,
 512                         timestamp: 0,
 513                         flags: 0,
 514                         cltv_expiry_delta: 0,
 515                         htlc_minimum_msat: 0,
 516                         htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
 517                         fee_base_msat: 0,
 518                         fee_proportional_millionths: 0,
 519                         excess_data: vec![],
 520                 }
 521         }
 522 }
 523
 524 pub struct TestRoutingMessageHandler {
 525         pub chan_upds_recvd: AtomicUsize,
 526         pub chan_anns_recvd: AtomicUsize,
 527         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 528         pub request_full_sync: AtomicBool,
 529 }
 530
 531 impl TestRoutingMessageHandler {
 532         pub fn new() -> Self {
 533                 TestRoutingMessageHandler {
 534                         chan_upds_recvd: AtomicUsize::new(0),
 535                         chan_anns_recvd: AtomicUsize::new(0),
 536                         pending_events: Mutex::new(vec![]),
 537                         request_full_sync: AtomicBool::new(false),
 538                 }
 539         }
 540 }
 541 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 542         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
 543                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 544         }
 545         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
 546                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
 547                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 548         }
 549         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
 550                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
 551                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 552         }
 553         fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
 554                 let chan_upd_1 = get_dummy_channel_update(starting_point);
 555                 let chan_upd_2 = get_dummy_channel_update(starting_point);
 556                 let chan_ann = get_dummy_channel_announcement(starting_point);
 557
 558                 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
 559         }
 560
 561         fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
 562                 None
 563         }
 564
 565         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 566                 if !init_msg.features.supports_gossip_queries() {
 567                         return Ok(());
 568                 }
 569
 570                 #[allow(unused_mut, unused_assignments)]
 571                 let mut gossip_start_time = 0;
 572                 #[cfg(feature = "std")]
 573                 {
 574                         gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
 575                         if self.request_full_sync.load(Ordering::Acquire) {
 576                                 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
 577                         } else {
 578                                 gossip_start_time -= 60 * 60; // an hour ago
 579                         }
 580                 }
 581
 582                 let mut pending_events = self.pending_events.lock().unwrap();
 583                 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
 584                         node_id: their_node_id.clone(),
 585                         msg: msgs::GossipTimestampFilter {
 586                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
 587                                 first_timestamp: gossip_start_time as u32,
 588                                 timestamp_range: u32::max_value(),
 589                         },
 590                 });
 591                 Ok(())
 592         }
 593
 594         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
 595                 Ok(())
 596         }
 597
 598         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
 599                 Ok(())
 600         }
 601
 602         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
 603                 Ok(())
 604         }
 605
 606         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
 607                 Ok(())
 608         }
 609
 610         fn provided_node_features(&self) -> NodeFeatures {
 611                 let mut features = NodeFeatures::empty();
 612                 features.set_gossip_queries_optional();
 613                 features
 614         }
 615
 616         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
 617                 let mut features = InitFeatures::empty();
 618                 features.set_gossip_queries_optional();
 619                 features
 620         }
 621
 622         fn processing_queue_high(&self) -> bool { false }
 623 }
 624
 625 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
 626         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 627                 let mut ret = Vec::new();
 628                 let mut pending_events = self.pending_events.lock().unwrap();
 629                 core::mem::swap(&mut ret, &mut pending_events);
 630                 ret
 631         }
 632 }
 633
 634 pub struct TestLogger {
 635         level: Level,
 636         pub(crate) id: String,
 637         pub lines: Mutex<HashMap<(String, String), usize>>,
 638 }
 639
 640 impl TestLogger {
 641         pub fn new() -> TestLogger {
 642                 Self::with_id("".to_owned())
 643         }
 644         pub fn with_id(id: String) -> TestLogger {
 645                 TestLogger {
 646                         level: Level::Trace,
 647                         id,
 648                         lines: Mutex::new(HashMap::new())
 649                 }
 650         }
 651         pub fn enable(&mut self, level: Level) {
 652                 self.level = level;
 653         }
 654         pub fn assert_log(&self, module: String, line: String, count: usize) {
 655                 let log_entries = self.lines.lock().unwrap();
 656                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
 657         }
 658
 659         /// Search for the number of occurrence of the logged lines which
 660         /// 1. belongs to the specified module and
 661         /// 2. contains `line` in it.
 662         /// And asserts if the number of occurrences is the same with the given `count`
 663         pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
 664                 let log_entries = self.lines.lock().unwrap();
 665                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 666                         m == module && l.contains(line)
 667                 }).map(|(_, c) | { c }).sum();
 668                 assert_eq!(l, count)
 669         }
 670
 671         /// Search for the number of occurrences of logged lines which
 672         /// 1. belong to the specified module and
 673         /// 2. match the given regex pattern.
 674         /// Assert that the number of occurrences equals the given `count`
 675         pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
 676                 let log_entries = self.lines.lock().unwrap();
 677                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 678                         m == module && pattern.is_match(&l)
 679                 }).map(|(_, c) | { c }).sum();
 680                 assert_eq!(l, count)
 681         }
 682 }
 683
 684 impl Logger for TestLogger {
 685         fn log(&self, record: &Record) {
 686                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 687                 if record.level >= self.level {
 688                         #[cfg(feature = "std")]
 689                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 690                 }
 691         }
 692 }
 693
 694 pub struct TestNodeSigner {
 695         node_secret: SecretKey,
 696 }
 697
 698 impl TestNodeSigner {
 699         pub fn new(node_secret: SecretKey) -> Self {
 700                 Self { node_secret }
 701         }
 702 }
 703
 704 impl NodeSigner for TestNodeSigner {
 705         fn get_inbound_payment_key_material(&self) -> crate::chain::keysinterface::KeyMaterial {
 706                 unreachable!()
 707         }
 708
 709         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
 710                 let node_secret = match recipient {
 711                         Recipient::Node => Ok(&self.node_secret),
 712                         Recipient::PhantomNode => Err(())
 713                 }?;
 714                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
 715         }
 716
 717         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
 718                 let mut node_secret = match recipient {
 719                         Recipient::Node => Ok(self.node_secret.clone()),
 720                         Recipient::PhantomNode => Err(())
 721                 }?;
 722                 if let Some(tweak) = tweak {
 723                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
 724                 }
 725                 Ok(SharedSecret::new(other_key, &node_secret))
 726         }
 727
 728         fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
 729                 unreachable!()
 730         }
 731
 732         fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
 733                 unreachable!()
 734         }
 735 }
 736
 737 pub struct TestKeysInterface {
 738         pub backing: keysinterface::PhantomKeysManager,
 739         pub override_random_bytes: Mutex<Option<[u8; 32]>>,
 740         pub disable_revocation_policy_check: bool,
 741         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
 742         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
 743 }
 744
 745 impl EntropySource for TestKeysInterface {
 746         fn get_secure_random_bytes(&self) -> [u8; 32] {
 747                 let override_random_bytes = self.override_random_bytes.lock().unwrap();
 748                 if let Some(bytes) = &*override_random_bytes {
 749                         return *bytes;
 750                 }
 751                 self.backing.get_secure_random_bytes()
 752         }
 753 }
 754
 755 impl NodeSigner for TestKeysInterface {
 756         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
 757                 self.backing.get_node_id(recipient)
 758         }
 759
 760         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
 761                 self.backing.ecdh(recipient, other_key, tweak)
 762         }
 763
 764         fn get_inbound_payment_key_material(&self) -> keysinterface::KeyMaterial {
 765                 self.backing.get_inbound_payment_key_material()
 766         }
 767
 768         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
 769                 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
 770         }
 771
 772         fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
 773                 self.backing.sign_gossip_message(msg)
 774         }
 775 }
 776
 777 impl SignerProvider for TestKeysInterface {
 778         type Signer = EnforcingSigner;
 779
 780         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
 781                 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
 782         }
 783
 784         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> EnforcingSigner {
 785                 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
 786                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 787                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 788         }
 789
 790         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
 791                 let mut reader = io::Cursor::new(buffer);
 792
 793                 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
 794                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
 795
 796                 Ok(EnforcingSigner::new_with_revoked(
 797                         inner,
 798                         state,
 799                         self.disable_revocation_policy_check
 800                 ))
 801         }
 802
 803         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 804
 805         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
 806                 match &mut *self.expectations.lock().unwrap() {
 807                         None => self.backing.get_shutdown_scriptpubkey(),
 808                         Some(expectations) => match expectations.pop_front() {
 809                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
 810                                 Some(expectation) => expectation.returns,
 811                         },
 812                 }
 813         }
 814 }
 815
 816 impl TestKeysInterface {
 817         pub fn new(seed: &[u8; 32], network: Network) -> Self {
 818                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
 819                 Self {
 820                         backing: keysinterface::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
 821                         override_random_bytes: Mutex::new(None),
 822                         disable_revocation_policy_check: false,
 823                         enforcement_states: Mutex::new(HashMap::new()),
 824                         expectations: Mutex::new(None),
 825                 }
 826         }
 827
 828         /// Sets an expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] is
 829         /// called.
 830         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
 831                 self.expectations.lock().unwrap()
 832                         .get_or_insert_with(|| VecDeque::new())
 833                         .push_back(expectation);
 834                 self
 835         }
 836
 837         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
 838                 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
 839                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 840                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 841         }
 842
 843         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
 844                 let mut states = self.enforcement_states.lock().unwrap();
 845                 if !states.contains_key(&commitment_seed) {
 846                         let state = EnforcementState::new();
 847                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
 848                 }
 849                 let cell = states.get(&commitment_seed).unwrap();
 850                 Arc::clone(cell)
 851         }
 852 }
 853
 854 pub(crate) fn panicking() -> bool {
 855         #[cfg(feature = "std")]
 856         let panicking = ::std::thread::panicking();
 857         #[cfg(not(feature = "std"))]
 858         let panicking = false;
 859         return panicking;
 860 }
 861
 862 impl Drop for TestKeysInterface {
 863         fn drop(&mut self) {
 864                 if panicking() {
 865                         return;
 866                 }
 867
 868                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 869                         if !expectations.is_empty() {
 870                                 panic!("Unsatisfied expectations: {:?}", expectations);
 871                         }
 872                 }
 873         }
 874 }
 875
 876 /// An expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] was called and
 877 /// returns a [`ShutdownScript`].
 878 pub struct OnGetShutdownScriptpubkey {
 879         /// A shutdown script used to close a channel.
 880         pub returns: ShutdownScript,
 881 }
 882
 883 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
 884         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 885                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
 886         }
 887 }
 888
 889 pub struct TestChainSource {
 890         pub genesis_hash: BlockHash,
 891         pub utxo_ret: Mutex<UtxoResult>,
 892         pub get_utxo_call_count: AtomicUsize,
 893         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
 894         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
 895 }
 896
 897 impl TestChainSource {
 898         pub fn new(network: Network) -> Self {
 899                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
 900                 Self {
 901                         genesis_hash: genesis_block(network).block_hash(),
 902                         utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
 903                         get_utxo_call_count: AtomicUsize::new(0),
 904                         watched_txn: Mutex::new(HashSet::new()),
 905                         watched_outputs: Mutex::new(HashSet::new()),
 906                 }
 907         }
 908 }
 909
 910 impl UtxoLookup for TestChainSource {
 911         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
 912                 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
 913                 if self.genesis_hash != *genesis_hash {
 914                         return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
 915                 }
 916
 917                 self.utxo_ret.lock().unwrap().clone()
 918         }
 919 }
 920
 921 impl chain::Filter for TestChainSource {
 922         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
 923                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
 924         }
 925
 926         fn register_output(&self, output: WatchedOutput) {
 927                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
 928         }
 929 }
 930
 931 impl Drop for TestChainSource {
 932         fn drop(&mut self) {
 933                 if panicking() {
 934                         return;
 935                 }
 936         }
 937 }
 938
 939 pub struct TestScorer {
 940         /// Stores a tuple of (scid, ChannelUsage)
 941         scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
 942 }
 943
 944 impl TestScorer {
 945         pub fn new() -> Self {
 946                 Self {
 947                         scorer_expectations: RefCell::new(None),
 948                 }
 949         }
 950
 951         pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
 952                 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
 953         }
 954 }
 955
 956 #[cfg(c_bindings)]
 957 impl crate::util::ser::Writeable for TestScorer {
 958         fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
 959 }
 960
 961 impl Score for TestScorer {
 962         fn channel_penalty_msat(
 963                 &self, short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage
 964         ) -> u64 {
 965                 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
 966                         match scorer_expectations.pop_front() {
 967                                 Some((scid, expectation)) => {
 968                                         assert_eq!(expectation, usage);
 969                                         assert_eq!(scid, short_channel_id);
 970                                 },
 971                                 None => {},
 972                         }
 973                 }
 974                 0
 975         }
 976
 977         fn payment_path_failed(&mut self, _actual_path: &[&RouteHop], _actual_short_channel_id: u64) {}
 978
 979         fn payment_path_successful(&mut self, _actual_path: &[&RouteHop]) {}
 980
 981         fn probe_failed(&mut self, _actual_path: &[&RouteHop], _: u64) {}
 982
 983         fn probe_successful(&mut self, _actual_path: &[&RouteHop]) {}
 984 }
 985
 986 impl Drop for TestScorer {
 987         fn drop(&mut self) {
 988                 #[cfg(feature = "std")] {
 989                         if std::thread::panicking() {
 990                                 return;
 991                         }
 992                 }
 993
 994                 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
 995                         if !scorer_expectations.is_empty() {
 996                                 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
 997                         }
 998                 }
 999         }
1000 }