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