_ 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::blinded_path::BlindedPath;
  11 use crate::blinded_path::payment::ReceiveTlvs;
  12 use crate::chain;
  13 use crate::chain::WatchedOutput;
  14 use crate::chain::chaininterface;
  15 use crate::chain::chaininterface::ConfirmationTarget;
  16 #[cfg(test)]
  17 use crate::chain::chaininterface::FEERATE_FLOOR_SATS_PER_KW;
  18 use crate::chain::chainmonitor;
  19 use crate::chain::channelmonitor;
  20 use crate::chain::channelmonitor::MonitorEvent;
  21 use crate::chain::transaction::OutPoint;
  22 use crate::routing::router::{CandidateRouteHop, FirstHopCandidate, PublicHopCandidate, PrivateHopCandidate};
  23 use crate::sign;
  24 use crate::events;
  25 use crate::events::bump_transaction::{WalletSource, Utxo};
  26 use crate::ln::types::ChannelId;
  27 use crate::ln::channelmanager::{ChannelDetails, self};
  28 #[cfg(test)]
  29 use crate::ln::chan_utils::CommitmentTransaction;
  30 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  31 use crate::ln::{msgs, wire};
  32 use crate::ln::msgs::LightningError;
  33 use crate::ln::script::ShutdownScript;
  34 use crate::offers::invoice::{BlindedPayInfo, UnsignedBolt12Invoice};
  35 use crate::offers::invoice_request::UnsignedInvoiceRequest;
  36 use crate::onion_message::messenger::{DefaultMessageRouter, Destination, MessageRouter, OnionMessagePath};
  37 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId, RoutingFees};
  38 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
  39 use crate::routing::router::{DefaultRouter, InFlightHtlcs, Path, Route, RouteParameters, RouteHintHop, Router, ScorerAccountingForInFlightHtlcs};
  40 use crate::routing::scoring::{ChannelUsage, ScoreUpdate, ScoreLookUp};
  41 use crate::sync::RwLock;
  42 use crate::util::config::UserConfig;
  43 use crate::util::test_channel_signer::{TestChannelSigner, EnforcementState};
  44 use crate::util::logger::{Logger, Level, Record};
  45 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
  46 use crate::util::persist::KVStore;
  47
  48 use bitcoin::blockdata::constants::ChainHash;
  49 use bitcoin::blockdata::constants::genesis_block;
  50 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  51 use bitcoin::blockdata::script::{Builder, Script, ScriptBuf};
  52 use bitcoin::blockdata::opcodes;
  53 use bitcoin::blockdata::block::Block;
  54 use bitcoin::network::constants::Network;
  55 use bitcoin::hash_types::{BlockHash, Txid};
  56 use bitcoin::sighash::{SighashCache, EcdsaSighashType};
  57
  58 use bitcoin::secp256k1::{PublicKey, Scalar, Secp256k1, SecretKey, self};
  59 use bitcoin::secp256k1::ecdh::SharedSecret;
  60 use bitcoin::secp256k1::ecdsa::{RecoverableSignature, Signature};
  61 use bitcoin::secp256k1::schnorr;
  62
  63 use crate::io;
  64 use crate::prelude::*;
  65 use core::cell::RefCell;
  66 use core::time::Duration;
  67 use crate::sync::{Mutex, Arc};
  68 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
  69 use core::mem;
  70 use bitcoin::bech32::u5;
  71 use crate::sign::{InMemorySigner, RandomBytes, Recipient, EntropySource, NodeSigner, SignerProvider};
  72
  73 #[cfg(feature = "std")]
  74 use std::time::{SystemTime, UNIX_EPOCH};
  75 use bitcoin::psbt::PartiallySignedTransaction;
  76 use bitcoin::Sequence;
  77
  78 pub fn pubkey(byte: u8) -> PublicKey {
  79         let secp_ctx = Secp256k1::new();
  80         PublicKey::from_secret_key(&secp_ctx, &privkey(byte))
  81 }
  82
  83 pub fn privkey(byte: u8) -> SecretKey {
  84         SecretKey::from_slice(&[byte; 32]).unwrap()
  85 }
  86
  87 pub struct TestVecWriter(pub Vec<u8>);
  88 impl Writer for TestVecWriter {
  89         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  90                 self.0.extend_from_slice(buf);
  91                 Ok(())
  92         }
  93 }
  94
  95 pub struct TestFeeEstimator {
  96         pub sat_per_kw: Mutex<u32>,
  97 }
  98 impl chaininterface::FeeEstimator for TestFeeEstimator {
  99         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
 100                 *self.sat_per_kw.lock().unwrap()
 101         }
 102 }
 103
 104 pub struct TestRouter<'a> {
 105         pub router: DefaultRouter<
 106                 Arc<NetworkGraph<&'a TestLogger>>,
 107                 &'a TestLogger,
 108                 Arc<RandomBytes>,
 109                 &'a RwLock<TestScorer>,
 110                 (),
 111                 TestScorer,
 112         >,
 113         //pub entropy_source: &'a RandomBytes,
 114         pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
 115         pub next_routes: Mutex<VecDeque<(RouteParameters, Result<Route, LightningError>)>>,
 116         pub scorer: &'a RwLock<TestScorer>,
 117 }
 118
 119 impl<'a> TestRouter<'a> {
 120         pub fn new(
 121                 network_graph: Arc<NetworkGraph<&'a TestLogger>>, logger: &'a TestLogger,
 122                 scorer: &'a RwLock<TestScorer>,
 123         ) -> Self {
 124                 let entropy_source = Arc::new(RandomBytes::new([42; 32]));
 125                 Self {
 126                         router: DefaultRouter::new(network_graph.clone(), logger, entropy_source, scorer, ()),
 127                         network_graph,
 128                         next_routes: Mutex::new(VecDeque::new()),
 129                         scorer,
 130                 }
 131         }
 132
 133         pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
 134                 let mut expected_routes = self.next_routes.lock().unwrap();
 135                 expected_routes.push_back((query, result));
 136         }
 137 }
 138
 139 impl<'a> Router for TestRouter<'a> {
 140         fn find_route(
 141                 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&ChannelDetails]>,
 142                 inflight_htlcs: InFlightHtlcs
 143         ) -> Result<Route, msgs::LightningError> {
 144                 let route_res;
 145                 let next_route_opt = self.next_routes.lock().unwrap().pop_front();
 146                 if let Some((find_route_query, find_route_res)) = next_route_opt {
 147                         assert_eq!(find_route_query, *params);
 148                         if let Ok(ref route) = find_route_res {
 149                                 assert_eq!(route.route_params, Some(find_route_query));
 150                                 let scorer = self.scorer.read().unwrap();
 151                                 let scorer = ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs);
 152                                 for path in &route.paths {
 153                                         let mut aggregate_msat = 0u64;
 154                                         let mut prev_hop_node = payer;
 155                                         for (idx, hop) in path.hops.iter().rev().enumerate() {
 156                                                 aggregate_msat += hop.fee_msat;
 157                                                 let usage = ChannelUsage {
 158                                                         amount_msat: aggregate_msat,
 159                                                         inflight_htlc_msat: 0,
 160                                                         effective_capacity: EffectiveCapacity::Unknown,
 161                                                 };
 162
 163                                                 if idx == path.hops.len() - 1 {
 164                                                         if let Some(first_hops) = first_hops {
 165                                                                 if let Some(idx) = first_hops.iter().position(|h| h.get_outbound_payment_scid() == Some(hop.short_channel_id)) {
 166                                                                         let node_id = NodeId::from_pubkey(payer);
 167                                                                         let candidate = CandidateRouteHop::FirstHop(FirstHopCandidate {
 168                                                                                 details: first_hops[idx],
 169                                                                                 payer_node_id: &node_id,
 170                                                                         });
 171                                                                         scorer.channel_penalty_msat(&candidate, usage, &Default::default());
 172                                                                         continue;
 173                                                                 }
 174                                                         }
 175                                                 }
 176                                                 let network_graph = self.network_graph.read_only();
 177                                                 if let Some(channel) = network_graph.channel(hop.short_channel_id) {
 178                                                         let (directed, _) = channel.as_directed_to(&NodeId::from_pubkey(&hop.pubkey)).unwrap();
 179                                                         let candidate = CandidateRouteHop::PublicHop(PublicHopCandidate {
 180                                                                 info: directed,
 181                                                                 short_channel_id: hop.short_channel_id,
 182                                                         });
 183                                                         scorer.channel_penalty_msat(&candidate, usage, &Default::default());
 184                                                 } else {
 185                                                         let target_node_id = NodeId::from_pubkey(&hop.pubkey);
 186                                                         let route_hint = RouteHintHop {
 187                                                                 src_node_id: *prev_hop_node,
 188                                                                 short_channel_id: hop.short_channel_id,
 189                                                                 fees: RoutingFees { base_msat: 0, proportional_millionths: 0 },
 190                                                                 cltv_expiry_delta: 0,
 191                                                                 htlc_minimum_msat: None,
 192                                                                 htlc_maximum_msat: None,
 193                                                         };
 194                                                         let candidate = CandidateRouteHop::PrivateHop(PrivateHopCandidate {
 195                                                                 hint: &route_hint,
 196                                                                 target_node_id: &target_node_id,
 197                                                         });
 198                                                         scorer.channel_penalty_msat(&candidate, usage, &Default::default());
 199                                                 }
 200                                                 prev_hop_node = &hop.pubkey;
 201                                         }
 202                                 }
 203                         }
 204                         route_res = find_route_res;
 205                 } else {
 206                         route_res = self.router.find_route(payer, params, first_hops, inflight_htlcs);
 207                 };
 208
 209                 if let Ok(route) = &route_res {
 210                         // Previously, `Route`s failed to round-trip through serialization due to a write/read
 211                         // mismatch. Thus, here we test all test-generated routes round-trip:
 212                         let ser = route.encode();
 213                         assert_eq!(Route::read(&mut &ser[..]).unwrap(), *route);
 214                 }
 215                 route_res
 216         }
 217
 218         fn create_blinded_payment_paths<
 219                 T: secp256k1::Signing + secp256k1::Verification
 220         >(
 221                 &self, recipient: PublicKey, first_hops: Vec<ChannelDetails>, tlvs: ReceiveTlvs,
 222                 amount_msats: u64, secp_ctx: &Secp256k1<T>,
 223         ) -> Result<Vec<(BlindedPayInfo, BlindedPath)>, ()> {
 224                 self.router.create_blinded_payment_paths(
 225                         recipient, first_hops, tlvs, amount_msats, secp_ctx
 226                 )
 227         }
 228 }
 229
 230 impl<'a> MessageRouter for TestRouter<'a> {
 231         fn find_path(
 232                 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
 233         ) -> Result<OnionMessagePath, ()> {
 234                 self.router.find_path(sender, peers, destination)
 235         }
 236
 237         fn create_blinded_paths<
 238                 T: secp256k1::Signing + secp256k1::Verification
 239         >(
 240                 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
 241         ) -> Result<Vec<BlindedPath>, ()> {
 242                 self.router.create_blinded_paths(recipient, peers, secp_ctx)
 243         }
 244 }
 245
 246 impl<'a> Drop for TestRouter<'a> {
 247         fn drop(&mut self) {
 248                 #[cfg(feature = "std")] {
 249                         if std::thread::panicking() {
 250                                 return;
 251                         }
 252                 }
 253                 assert!(self.next_routes.lock().unwrap().is_empty());
 254         }
 255 }
 256
 257 pub struct TestMessageRouter<'a> {
 258         inner: DefaultMessageRouter<Arc<NetworkGraph<&'a TestLogger>>, &'a TestLogger, &'a TestKeysInterface>,
 259 }
 260
 261 impl<'a> TestMessageRouter<'a> {
 262         pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, entropy_source: &'a TestKeysInterface) -> Self {
 263                 Self { inner: DefaultMessageRouter::new(network_graph, entropy_source) }
 264         }
 265 }
 266
 267 impl<'a> MessageRouter for TestMessageRouter<'a> {
 268         fn find_path(
 269                 &self, sender: PublicKey, peers: Vec<PublicKey>, destination: Destination
 270         ) -> Result<OnionMessagePath, ()> {
 271                 self.inner.find_path(sender, peers, destination)
 272         }
 273
 274         fn create_blinded_paths<T: secp256k1::Signing + secp256k1::Verification>(
 275                 &self, recipient: PublicKey, peers: Vec<PublicKey>, secp_ctx: &Secp256k1<T>,
 276         ) -> Result<Vec<BlindedPath>, ()> {
 277                 self.inner.create_blinded_paths(recipient, peers, secp_ctx)
 278         }
 279 }
 280
 281 pub struct OnlyReadsKeysInterface {}
 282
 283 impl EntropySource for OnlyReadsKeysInterface {
 284         fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
 285
 286 impl SignerProvider for OnlyReadsKeysInterface {
 287         type EcdsaSigner = TestChannelSigner;
 288         #[cfg(taproot)]
 289         type TaprootSigner = TestChannelSigner;
 290
 291         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
 292
 293         fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::EcdsaSigner { unreachable!(); }
 294
 295         fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
 296                 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
 297                 let state = Arc::new(Mutex::new(EnforcementState::new()));
 298
 299                 Ok(TestChannelSigner::new_with_revoked(
 300                         inner,
 301                         state,
 302                         false
 303                 ))
 304         }
 305
 306         fn get_destination_script(&self, _channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { Err(()) }
 307         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> { Err(()) }
 308 }
 309
 310 pub struct TestChainMonitor<'a> {
 311         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<TestChannelSigner>)>>,
 312         pub monitor_updates: Mutex<HashMap<ChannelId, Vec<channelmonitor::ChannelMonitorUpdate>>>,
 313         pub latest_monitor_update_id: Mutex<HashMap<ChannelId, (OutPoint, u64, u64)>>,
 314         pub chain_monitor: chainmonitor::ChainMonitor<TestChannelSigner, &'a TestChainSource, &'a dyn chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a dyn chainmonitor::Persist<TestChannelSigner>>,
 315         pub keys_manager: &'a TestKeysInterface,
 316         /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
 317         /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
 318         /// boolean.
 319         pub expect_channel_force_closed: Mutex<Option<(ChannelId, bool)>>,
 320         /// If this is set to Some(), the next round trip serialization check will not hold after an
 321         /// update_channel call (not watch_channel) for the given channel_id.
 322         pub expect_monitor_round_trip_fail: Mutex<Option<ChannelId>>,
 323 }
 324 impl<'a> TestChainMonitor<'a> {
 325         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a dyn chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a dyn chainmonitor::Persist<TestChannelSigner>, keys_manager: &'a TestKeysInterface) -> Self {
 326                 Self {
 327                         added_monitors: Mutex::new(Vec::new()),
 328                         monitor_updates: Mutex::new(new_hash_map()),
 329                         latest_monitor_update_id: Mutex::new(new_hash_map()),
 330                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
 331                         keys_manager,
 332                         expect_channel_force_closed: Mutex::new(None),
 333                         expect_monitor_round_trip_fail: Mutex::new(None),
 334                 }
 335         }
 336
 337         pub fn complete_sole_pending_chan_update(&self, channel_id: &ChannelId) {
 338                 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
 339                 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
 340         }
 341 }
 342 impl<'a> chain::Watch<TestChannelSigner> for TestChainMonitor<'a> {
 343         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<TestChannelSigner>) -> Result<chain::ChannelMonitorUpdateStatus, ()> {
 344                 // At every point where we get a monitor update, we should be able to send a useful monitor
 345                 // to a watchtower and disk...
 346                 let mut w = TestVecWriter(Vec::new());
 347                 monitor.write(&mut w).unwrap();
 348                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
 349                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
 350                 assert!(new_monitor == monitor);
 351                 self.latest_monitor_update_id.lock().unwrap().insert(monitor.channel_id(),
 352                         (funding_txo, monitor.get_latest_update_id(), monitor.get_latest_update_id()));
 353                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
 354                 self.chain_monitor.watch_channel(funding_txo, new_monitor)
 355         }
 356
 357         fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
 358                 // Every monitor update should survive roundtrip
 359                 let mut w = TestVecWriter(Vec::new());
 360                 update.write(&mut w).unwrap();
 361                 assert!(channelmonitor::ChannelMonitorUpdate::read(
 362                                 &mut io::Cursor::new(&w.0)).unwrap() == *update);
 363                 let channel_id = update.channel_id.unwrap_or(ChannelId::v1_from_funding_outpoint(funding_txo));
 364
 365                 self.monitor_updates.lock().unwrap().entry(channel_id).or_insert(Vec::new()).push(update.clone());
 366
 367                 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
 368                         assert_eq!(channel_id, exp.0);
 369                         assert_eq!(update.updates.len(), 1);
 370                         if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
 371                                 assert_eq!(should_broadcast, exp.1);
 372                         } else { panic!(); }
 373                 }
 374
 375                 self.latest_monitor_update_id.lock().unwrap().insert(channel_id,
 376                         (funding_txo, update.update_id, update.update_id));
 377                 let update_res = self.chain_monitor.update_channel(funding_txo, update);
 378                 // At every point where we get a monitor update, we should be able to send a useful monitor
 379                 // to a watchtower and disk...
 380                 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
 381                 w.0.clear();
 382                 monitor.write(&mut w).unwrap();
 383                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<TestChannelSigner>)>::read(
 384                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
 385                 if let Some(chan_id) = self.expect_monitor_round_trip_fail.lock().unwrap().take() {
 386                         assert_eq!(chan_id, channel_id);
 387                         assert!(new_monitor != *monitor);
 388                 } else {
 389                         assert!(new_monitor == *monitor);
 390                 }
 391                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
 392                 update_res
 393         }
 394
 395         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, ChannelId, Vec<MonitorEvent>, Option<PublicKey>)> {
 396                 return self.chain_monitor.release_pending_monitor_events();
 397         }
 398 }
 399
 400 #[cfg(test)]
 401 struct JusticeTxData {
 402         justice_tx: Transaction,
 403         value: u64,
 404         commitment_number: u64,
 405 }
 406
 407 #[cfg(test)]
 408 pub(crate) struct WatchtowerPersister {
 409         persister: TestPersister,
 410         /// Upon a new commitment_signed, we'll get a
 411         /// ChannelMonitorUpdateStep::LatestCounterpartyCommitmentTxInfo. We'll store the justice tx
 412         /// amount, and commitment number so we can build the justice tx after our counterparty
 413         /// revokes it.
 414         unsigned_justice_tx_data: Mutex<HashMap<OutPoint, VecDeque<JusticeTxData>>>,
 415         /// After receiving a revoke_and_ack for a commitment number, we'll form and store the justice
 416         /// tx which would be used to provide a watchtower with the data it needs.
 417         watchtower_state: Mutex<HashMap<OutPoint, HashMap<Txid, Transaction>>>,
 418         destination_script: ScriptBuf,
 419 }
 420
 421 #[cfg(test)]
 422 impl WatchtowerPersister {
 423         #[cfg(test)]
 424         pub(crate) fn new(destination_script: ScriptBuf) -> Self {
 425                 WatchtowerPersister {
 426                         persister: TestPersister::new(),
 427                         unsigned_justice_tx_data: Mutex::new(new_hash_map()),
 428                         watchtower_state: Mutex::new(new_hash_map()),
 429                         destination_script,
 430                 }
 431         }
 432
 433         #[cfg(test)]
 434         pub(crate) fn justice_tx(&self, funding_txo: OutPoint, commitment_txid: &Txid)
 435         -> Option<Transaction> {
 436                 self.watchtower_state.lock().unwrap().get(&funding_txo).unwrap().get(commitment_txid).cloned()
 437         }
 438
 439         fn form_justice_data_from_commitment(&self, counterparty_commitment_tx: &CommitmentTransaction)
 440         -> Option<JusticeTxData> {
 441                 let trusted_tx = counterparty_commitment_tx.trust();
 442                 let output_idx = trusted_tx.revokeable_output_index()?;
 443                 let built_tx = trusted_tx.built_transaction();
 444                 let value = built_tx.transaction.output[output_idx as usize].value;
 445                 let justice_tx = trusted_tx.build_to_local_justice_tx(
 446                         FEERATE_FLOOR_SATS_PER_KW as u64, self.destination_script.clone()).ok()?;
 447                 let commitment_number = counterparty_commitment_tx.commitment_number();
 448                 Some(JusticeTxData { justice_tx, value, commitment_number })
 449         }
 450 }
 451
 452 #[cfg(test)]
 453 impl<Signer: sign::ecdsa::EcdsaChannelSigner> chainmonitor::Persist<Signer> for WatchtowerPersister {
 454         fn persist_new_channel(&self, funding_txo: OutPoint,
 455                 data: &channelmonitor::ChannelMonitor<Signer>
 456         ) -> chain::ChannelMonitorUpdateStatus {
 457                 let res = self.persister.persist_new_channel(funding_txo, data);
 458
 459                 assert!(self.unsigned_justice_tx_data.lock().unwrap()
 460                         .insert(funding_txo, VecDeque::new()).is_none());
 461                 assert!(self.watchtower_state.lock().unwrap()
 462                         .insert(funding_txo, new_hash_map()).is_none());
 463
 464                 let initial_counterparty_commitment_tx = data.initial_counterparty_commitment_tx()
 465                         .expect("First and only call expects Some");
 466                 if let Some(justice_data)
 467                         = self.form_justice_data_from_commitment(&initial_counterparty_commitment_tx) {
 468                         self.unsigned_justice_tx_data.lock().unwrap()
 469                                 .get_mut(&funding_txo).unwrap()
 470                                 .push_back(justice_data);
 471                 }
 472                 res
 473         }
 474
 475         fn update_persisted_channel(
 476                 &self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>,
 477                 data: &channelmonitor::ChannelMonitor<Signer>
 478         ) -> chain::ChannelMonitorUpdateStatus {
 479                 let res = self.persister.update_persisted_channel(funding_txo, update, data);
 480
 481                 if let Some(update) = update {
 482                         let commitment_txs = data.counterparty_commitment_txs_from_update(update);
 483                         let justice_datas = commitment_txs.into_iter()
 484                                 .filter_map(|commitment_tx| self.form_justice_data_from_commitment(&commitment_tx));
 485                         let mut channels_justice_txs = self.unsigned_justice_tx_data.lock().unwrap();
 486                         let channel_state = channels_justice_txs.get_mut(&funding_txo).unwrap();
 487                         channel_state.extend(justice_datas);
 488
 489                         while let Some(JusticeTxData { justice_tx, value, commitment_number }) = channel_state.front() {
 490                                 let input_idx = 0;
 491                                 let commitment_txid = justice_tx.input[input_idx].previous_output.txid;
 492                                 match data.sign_to_local_justice_tx(justice_tx.clone(), input_idx, *value, *commitment_number) {
 493                                         Ok(signed_justice_tx) => {
 494                                                 let dup = self.watchtower_state.lock().unwrap()
 495                                                         .get_mut(&funding_txo).unwrap()
 496                                                         .insert(commitment_txid, signed_justice_tx);
 497                                                 assert!(dup.is_none());
 498                                                 channel_state.pop_front();
 499                                         },
 500                                         Err(_) => break,
 501                                 }
 502                         }
 503                 }
 504                 res
 505         }
 506
 507         fn archive_persisted_channel(&self, funding_txo: OutPoint) {
 508                 <TestPersister as chainmonitor::Persist<TestChannelSigner>>::archive_persisted_channel(&self.persister, funding_txo);
 509         }
 510 }
 511
 512 pub struct TestPersister {
 513         /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
 514         /// returned.
 515         pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
 516         /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
 517         /// [`ChannelMonitor::get_latest_update_id`] here.
 518         ///
 519         /// [`ChannelMonitor`]: channelmonitor::ChannelMonitor
 520         pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<u64>>>,
 521 }
 522 impl TestPersister {
 523         pub fn new() -> Self {
 524                 Self {
 525                         update_rets: Mutex::new(VecDeque::new()),
 526                         offchain_monitor_updates: Mutex::new(new_hash_map()),
 527                 }
 528         }
 529
 530         /// Queue an update status to return.
 531         pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
 532                 self.update_rets.lock().unwrap().push_back(next_ret);
 533         }
 534 }
 535 impl<Signer: sign::ecdsa::EcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
 536         fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>) -> chain::ChannelMonitorUpdateStatus {
 537                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
 538                         return update_ret
 539                 }
 540                 chain::ChannelMonitorUpdateStatus::Completed
 541         }
 542
 543         fn update_persisted_channel(&self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>) -> chain::ChannelMonitorUpdateStatus {
 544                 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
 545                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
 546                         ret = update_ret;
 547                 }
 548
 549                 if let Some(update) = update  {
 550                         self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(new_hash_set()).insert(update.update_id);
 551                 }
 552                 ret
 553         }
 554
 555         fn archive_persisted_channel(&self, funding_txo: OutPoint) {
 556                 // remove the channel from the offchain_monitor_updates map
 557                 self.offchain_monitor_updates.lock().unwrap().remove(&funding_txo);
 558         }
 559 }
 560
 561 pub struct TestStore {
 562         persisted_bytes: Mutex<HashMap<String, HashMap<String, Vec<u8>>>>,
 563         read_only: bool,
 564 }
 565
 566 impl TestStore {
 567         pub fn new(read_only: bool) -> Self {
 568                 let persisted_bytes = Mutex::new(new_hash_map());
 569                 Self { persisted_bytes, read_only }
 570         }
 571 }
 572
 573 impl KVStore for TestStore {
 574         fn read(&self, primary_namespace: &str, secondary_namespace: &str, key: &str) -> io::Result<Vec<u8>> {
 575                 let persisted_lock = self.persisted_bytes.lock().unwrap();
 576                 let prefixed = if secondary_namespace.is_empty() {
 577                         primary_namespace.to_string()
 578                 } else {
 579                         format!("{}/{}", primary_namespace, secondary_namespace)
 580                 };
 581
 582                 if let Some(outer_ref) = persisted_lock.get(&prefixed) {
 583                         if let Some(inner_ref) = outer_ref.get(key) {
 584                                 let bytes = inner_ref.clone();
 585                                 Ok(bytes)
 586                         } else {
 587                                 Err(io::Error::new(io::ErrorKind::NotFound, "Key not found"))
 588                         }
 589                 } else {
 590                         Err(io::Error::new(io::ErrorKind::NotFound, "Namespace not found"))
 591                 }
 592         }
 593
 594         fn write(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, buf: &[u8]) -> io::Result<()> {
 595                 if self.read_only {
 596                         return Err(io::Error::new(
 597                                 io::ErrorKind::PermissionDenied,
 598                                 "Cannot modify read-only store",
 599                         ));
 600                 }
 601                 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
 602
 603                 let prefixed = if secondary_namespace.is_empty() {
 604                         primary_namespace.to_string()
 605                 } else {
 606                         format!("{}/{}", primary_namespace, secondary_namespace)
 607                 };
 608                 let outer_e = persisted_lock.entry(prefixed).or_insert(new_hash_map());
 609                 let mut bytes = Vec::new();
 610                 bytes.write_all(buf)?;
 611                 outer_e.insert(key.to_string(), bytes);
 612                 Ok(())
 613         }
 614
 615         fn remove(&self, primary_namespace: &str, secondary_namespace: &str, key: &str, _lazy: bool) -> io::Result<()> {
 616                 if self.read_only {
 617                         return Err(io::Error::new(
 618                                 io::ErrorKind::PermissionDenied,
 619                                 "Cannot modify read-only store",
 620                         ));
 621                 }
 622
 623                 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
 624
 625                 let prefixed = if secondary_namespace.is_empty() {
 626                         primary_namespace.to_string()
 627                 } else {
 628                         format!("{}/{}", primary_namespace, secondary_namespace)
 629                 };
 630                 if let Some(outer_ref) = persisted_lock.get_mut(&prefixed) {
 631                                 outer_ref.remove(&key.to_string());
 632                 }
 633
 634                 Ok(())
 635         }
 636
 637         fn list(&self, primary_namespace: &str, secondary_namespace: &str) -> io::Result<Vec<String>> {
 638                 let mut persisted_lock = self.persisted_bytes.lock().unwrap();
 639
 640                 let prefixed = if secondary_namespace.is_empty() {
 641                         primary_namespace.to_string()
 642                 } else {
 643                         format!("{}/{}", primary_namespace, secondary_namespace)
 644                 };
 645                 match persisted_lock.entry(prefixed) {
 646                         hash_map::Entry::Occupied(e) => Ok(e.get().keys().cloned().collect()),
 647                         hash_map::Entry::Vacant(_) => Ok(Vec::new()),
 648                 }
 649         }
 650 }
 651
 652 unsafe impl Sync for TestStore {}
 653 unsafe impl Send for TestStore {}
 654
 655 pub struct TestBroadcaster {
 656         pub txn_broadcasted: Mutex<Vec<Transaction>>,
 657         pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
 658 }
 659
 660 impl TestBroadcaster {
 661         pub fn new(network: Network) -> Self {
 662                 Self {
 663                         txn_broadcasted: Mutex::new(Vec::new()),
 664                         blocks: Arc::new(Mutex::new(vec![(genesis_block(network), 0)])),
 665                 }
 666         }
 667
 668         pub fn with_blocks(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> Self {
 669                 Self { txn_broadcasted: Mutex::new(Vec::new()), blocks }
 670         }
 671
 672         pub fn txn_broadcast(&self) -> Vec<Transaction> {
 673                 self.txn_broadcasted.lock().unwrap().split_off(0)
 674         }
 675
 676         pub fn unique_txn_broadcast(&self) -> Vec<Transaction> {
 677                 let mut txn = self.txn_broadcasted.lock().unwrap().split_off(0);
 678                 let mut seen = new_hash_set();
 679                 txn.retain(|tx| seen.insert(tx.txid()));
 680                 txn
 681         }
 682 }
 683
 684 impl chaininterface::BroadcasterInterface for TestBroadcaster {
 685         fn broadcast_transactions(&self, txs: &[&Transaction]) {
 686                 for tx in txs {
 687                         let lock_time = tx.lock_time.to_consensus_u32();
 688                         assert!(lock_time < 1_500_000_000);
 689                         if tx.lock_time.is_block_height() && lock_time > self.blocks.lock().unwrap().last().unwrap().1 {
 690                                 for inp in tx.input.iter() {
 691                                         if inp.sequence != Sequence::MAX {
 692                                                 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
 693                                         }
 694                                 }
 695                         }
 696                 }
 697                 let owned_txs: Vec<Transaction> = txs.iter().map(|tx| (*tx).clone()).collect();
 698                 self.txn_broadcasted.lock().unwrap().extend(owned_txs);
 699         }
 700 }
 701
 702 pub struct TestChannelMessageHandler {
 703         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 704         expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
 705         connected_peers: Mutex<HashSet<PublicKey>>,
 706         pub message_fetch_counter: AtomicUsize,
 707         chain_hash: ChainHash,
 708 }
 709
 710 impl TestChannelMessageHandler {
 711         pub fn new(chain_hash: ChainHash) -> Self {
 712                 TestChannelMessageHandler {
 713                         pending_events: Mutex::new(Vec::new()),
 714                         expected_recv_msgs: Mutex::new(None),
 715                         connected_peers: Mutex::new(new_hash_set()),
 716                         message_fetch_counter: AtomicUsize::new(0),
 717                         chain_hash,
 718                 }
 719         }
 720
 721         #[cfg(test)]
 722         pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
 723                 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
 724                 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
 725                 expected_msgs.as_mut().unwrap().push(ev);
 726         }
 727
 728         fn received_msg(&self, _ev: wire::Message<()>) {
 729                 let mut msgs = self.expected_recv_msgs.lock().unwrap();
 730                 if msgs.is_none() { return; }
 731                 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
 732                 #[cfg(test)]
 733                 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
 734                 msgs.as_mut().unwrap().remove(0);
 735         }
 736 }
 737
 738 impl Drop for TestChannelMessageHandler {
 739         fn drop(&mut self) {
 740                 #[cfg(feature = "std")]
 741                 {
 742                         let l = self.expected_recv_msgs.lock().unwrap();
 743                         if !std::thread::panicking() {
 744                                 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
 745                         }
 746                 }
 747         }
 748 }
 749
 750 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 751         fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
 752                 self.received_msg(wire::Message::OpenChannel(msg.clone()));
 753         }
 754         fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
 755                 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
 756         }
 757         fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
 758                 self.received_msg(wire::Message::FundingCreated(msg.clone()));
 759         }
 760         fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
 761                 self.received_msg(wire::Message::FundingSigned(msg.clone()));
 762         }
 763         fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
 764                 self.received_msg(wire::Message::ChannelReady(msg.clone()));
 765         }
 766         fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
 767                 self.received_msg(wire::Message::Shutdown(msg.clone()));
 768         }
 769         fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
 770                 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
 771         }
 772         fn handle_stfu(&self, _their_node_id: &PublicKey, msg: &msgs::Stfu) {
 773                 self.received_msg(wire::Message::Stfu(msg.clone()));
 774         }
 775         #[cfg(splicing)]
 776         fn handle_splice(&self, _their_node_id: &PublicKey, msg: &msgs::Splice) {
 777                 self.received_msg(wire::Message::Splice(msg.clone()));
 778         }
 779         #[cfg(splicing)]
 780         fn handle_splice_ack(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceAck) {
 781                 self.received_msg(wire::Message::SpliceAck(msg.clone()));
 782         }
 783         #[cfg(splicing)]
 784         fn handle_splice_locked(&self, _their_node_id: &PublicKey, msg: &msgs::SpliceLocked) {
 785                 self.received_msg(wire::Message::SpliceLocked(msg.clone()));
 786         }
 787         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
 788                 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
 789         }
 790         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
 791                 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
 792         }
 793         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
 794                 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
 795         }
 796         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
 797                 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
 798         }
 799         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
 800                 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
 801         }
 802         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
 803                 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
 804         }
 805         fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
 806                 self.received_msg(wire::Message::UpdateFee(msg.clone()));
 807         }
 808         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
 809                 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
 810         }
 811         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
 812                 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
 813         }
 814         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
 815                 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
 816         }
 817         fn peer_disconnected(&self, their_node_id: &PublicKey) {
 818                 assert!(self.connected_peers.lock().unwrap().remove(their_node_id));
 819         }
 820         fn peer_connected(&self, their_node_id: &PublicKey, _msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 821                 assert!(self.connected_peers.lock().unwrap().insert(their_node_id.clone()));
 822                 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
 823                 // bother re-generating the expected Init message in all tests.
 824                 Ok(())
 825         }
 826         fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
 827                 self.received_msg(wire::Message::Error(msg.clone()));
 828         }
 829         fn provided_node_features(&self) -> NodeFeatures {
 830                 channelmanager::provided_node_features(&UserConfig::default())
 831         }
 832         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
 833                 channelmanager::provided_init_features(&UserConfig::default())
 834         }
 835
 836         fn get_chain_hashes(&self) -> Option<Vec<ChainHash>> {
 837                 Some(vec![self.chain_hash])
 838         }
 839
 840         fn handle_open_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannelV2) {
 841                 self.received_msg(wire::Message::OpenChannelV2(msg.clone()));
 842         }
 843
 844         fn handle_accept_channel_v2(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannelV2) {
 845                 self.received_msg(wire::Message::AcceptChannelV2(msg.clone()));
 846         }
 847
 848         fn handle_tx_add_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddInput) {
 849                 self.received_msg(wire::Message::TxAddInput(msg.clone()));
 850         }
 851
 852         fn handle_tx_add_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxAddOutput) {
 853                 self.received_msg(wire::Message::TxAddOutput(msg.clone()));
 854         }
 855
 856         fn handle_tx_remove_input(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveInput) {
 857                 self.received_msg(wire::Message::TxRemoveInput(msg.clone()));
 858         }
 859
 860         fn handle_tx_remove_output(&self, _their_node_id: &PublicKey, msg: &msgs::TxRemoveOutput) {
 861                 self.received_msg(wire::Message::TxRemoveOutput(msg.clone()));
 862         }
 863
 864         fn handle_tx_complete(&self, _their_node_id: &PublicKey, msg: &msgs::TxComplete) {
 865                 self.received_msg(wire::Message::TxComplete(msg.clone()));
 866         }
 867
 868         fn handle_tx_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::TxSignatures) {
 869                 self.received_msg(wire::Message::TxSignatures(msg.clone()));
 870         }
 871
 872         fn handle_tx_init_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxInitRbf) {
 873                 self.received_msg(wire::Message::TxInitRbf(msg.clone()));
 874         }
 875
 876         fn handle_tx_ack_rbf(&self, _their_node_id: &PublicKey, msg: &msgs::TxAckRbf) {
 877                 self.received_msg(wire::Message::TxAckRbf(msg.clone()));
 878         }
 879
 880         fn handle_tx_abort(&self, _their_node_id: &PublicKey, msg: &msgs::TxAbort) {
 881                 self.received_msg(wire::Message::TxAbort(msg.clone()));
 882         }
 883 }
 884
 885 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 886         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 887                 self.message_fetch_counter.fetch_add(1, Ordering::AcqRel);
 888                 let mut pending_events = self.pending_events.lock().unwrap();
 889                 let mut ret = Vec::new();
 890                 mem::swap(&mut ret, &mut *pending_events);
 891                 ret
 892         }
 893 }
 894
 895 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
 896         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 897         let secp_ctx = Secp256k1::new();
 898         let network = Network::Testnet;
 899         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
 900         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
 901         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
 902         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
 903         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
 904                 features: ChannelFeatures::empty(),
 905                 chain_hash: ChainHash::using_genesis_block(network),
 906                 short_channel_id: short_chan_id,
 907                 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
 908                 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
 909                 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
 910                 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
 911                 excess_data: Vec::new(),
 912         };
 913
 914         unsafe {
 915                 msgs::ChannelAnnouncement {
 916                         node_signature_1: Signature::from(FFISignature::new()),
 917                         node_signature_2: Signature::from(FFISignature::new()),
 918                         bitcoin_signature_1: Signature::from(FFISignature::new()),
 919                         bitcoin_signature_2: Signature::from(FFISignature::new()),
 920                         contents: unsigned_ann,
 921                 }
 922         }
 923 }
 924
 925 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
 926         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 927         let network = Network::Testnet;
 928         msgs::ChannelUpdate {
 929                 signature: Signature::from(unsafe { FFISignature::new() }),
 930                 contents: msgs::UnsignedChannelUpdate {
 931                         chain_hash: ChainHash::using_genesis_block(network),
 932                         short_channel_id: short_chan_id,
 933                         timestamp: 0,
 934                         flags: 0,
 935                         cltv_expiry_delta: 0,
 936                         htlc_minimum_msat: 0,
 937                         htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
 938                         fee_base_msat: 0,
 939                         fee_proportional_millionths: 0,
 940                         excess_data: vec![],
 941                 }
 942         }
 943 }
 944
 945 pub struct TestRoutingMessageHandler {
 946         pub chan_upds_recvd: AtomicUsize,
 947         pub chan_anns_recvd: AtomicUsize,
 948         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 949         pub request_full_sync: AtomicBool,
 950 }
 951
 952 impl TestRoutingMessageHandler {
 953         pub fn new() -> Self {
 954                 TestRoutingMessageHandler {
 955                         chan_upds_recvd: AtomicUsize::new(0),
 956                         chan_anns_recvd: AtomicUsize::new(0),
 957                         pending_events: Mutex::new(vec![]),
 958                         request_full_sync: AtomicBool::new(false),
 959                 }
 960         }
 961 }
 962 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 963         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
 964                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 965         }
 966         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
 967                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
 968                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 969         }
 970         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
 971                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
 972                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 973         }
 974         fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
 975                 let chan_upd_1 = get_dummy_channel_update(starting_point);
 976                 let chan_upd_2 = get_dummy_channel_update(starting_point);
 977                 let chan_ann = get_dummy_channel_announcement(starting_point);
 978
 979                 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
 980         }
 981
 982         fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
 983                 None
 984         }
 985
 986         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init, _inbound: bool) -> Result<(), ()> {
 987                 if !init_msg.features.supports_gossip_queries() {
 988                         return Ok(());
 989                 }
 990
 991                 #[allow(unused_mut, unused_assignments)]
 992                 let mut gossip_start_time = 0;
 993                 #[cfg(feature = "std")]
 994                 {
 995                         gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
 996                         if self.request_full_sync.load(Ordering::Acquire) {
 997                                 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
 998                         } else {
 999                                 gossip_start_time -= 60 * 60; // an hour ago
1000                         }
1001                 }
1002
1003                 let mut pending_events = self.pending_events.lock().unwrap();
1004                 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
1005                         node_id: their_node_id.clone(),
1006                         msg: msgs::GossipTimestampFilter {
1007                                 chain_hash: ChainHash::using_genesis_block(Network::Testnet),
1008                                 first_timestamp: gossip_start_time as u32,
1009                                 timestamp_range: u32::max_value(),
1010                         },
1011                 });
1012                 Ok(())
1013         }
1014
1015         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
1016                 Ok(())
1017         }
1018
1019         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
1020                 Ok(())
1021         }
1022
1023         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
1024                 Ok(())
1025         }
1026
1027         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
1028                 Ok(())
1029         }
1030
1031         fn provided_node_features(&self) -> NodeFeatures {
1032                 let mut features = NodeFeatures::empty();
1033                 features.set_gossip_queries_optional();
1034                 features
1035         }
1036
1037         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
1038                 let mut features = InitFeatures::empty();
1039                 features.set_gossip_queries_optional();
1040                 features
1041         }
1042
1043         fn processing_queue_high(&self) -> bool { false }
1044 }
1045
1046 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
1047         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
1048                 let mut ret = Vec::new();
1049                 let mut pending_events = self.pending_events.lock().unwrap();
1050                 core::mem::swap(&mut ret, &mut pending_events);
1051                 ret
1052         }
1053 }
1054
1055 pub struct TestLogger {
1056         level: Level,
1057         pub(crate) id: String,
1058         pub lines: Mutex<HashMap<(&'static str, String), usize>>,
1059         pub context: Mutex<HashMap<(&'static str, Option<PublicKey>, Option<ChannelId>), usize>>,
1060 }
1061
1062 impl TestLogger {
1063         pub fn new() -> TestLogger {
1064                 Self::with_id("".to_owned())
1065         }
1066         pub fn with_id(id: String) -> TestLogger {
1067                 TestLogger {
1068                         level: Level::Trace,
1069                         id,
1070                         lines: Mutex::new(new_hash_map()),
1071                         context: Mutex::new(new_hash_map()),
1072                 }
1073         }
1074         pub fn enable(&mut self, level: Level) {
1075                 self.level = level;
1076         }
1077         pub fn assert_log(&self, module: &str, line: String, count: usize) {
1078                 let log_entries = self.lines.lock().unwrap();
1079                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
1080         }
1081
1082         /// Search for the number of occurrence of the logged lines which
1083         /// 1. belongs to the specified module and
1084         /// 2. contains `line` in it.
1085         /// And asserts if the number of occurrences is the same with the given `count`
1086         pub fn assert_log_contains(&self, module: &str, line: &str, count: usize) {
1087                 let log_entries = self.lines.lock().unwrap();
1088                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1089                         *m == module && l.contains(line)
1090                 }).map(|(_, c) | { c }).sum();
1091                 assert_eq!(l, count)
1092         }
1093
1094         /// Search for the number of occurrences of logged lines which
1095         /// 1. belong to the specified module and
1096         /// 2. match the given regex pattern.
1097         /// Assert that the number of occurrences equals the given `count`
1098         #[cfg(any(test, feature = "_test_utils"))]
1099         pub fn assert_log_regex(&self, module: &str, pattern: regex::Regex, count: usize) {
1100                 let log_entries = self.lines.lock().unwrap();
1101                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
1102                         *m == module && pattern.is_match(&l)
1103                 }).map(|(_, c) | { c }).sum();
1104                 assert_eq!(l, count)
1105         }
1106
1107         pub fn assert_log_context_contains(
1108                 &self, module: &str, peer_id: Option<PublicKey>, channel_id: Option<ChannelId>, count: usize
1109         ) {
1110                 let context_entries = self.context.lock().unwrap();
1111                 let l = context_entries.get(&(module, peer_id, channel_id)).unwrap();
1112                 assert_eq!(*l, count)
1113         }
1114 }
1115
1116 impl Logger for TestLogger {
1117         fn log(&self, record: Record) {
1118                 *self.lines.lock().unwrap().entry((record.module_path, format!("{}", record.args))).or_insert(0) += 1;
1119                 *self.context.lock().unwrap().entry((record.module_path, record.peer_id, record.channel_id)).or_insert(0) += 1;
1120                 if record.level >= self.level {
1121                         #[cfg(all(not(ldk_bench), feature = "std"))] {
1122                                 let pfx = format!("{} {} [{}:{}]", self.id, record.level.to_string(), record.module_path, record.line);
1123                                 println!("{:<55}{}", pfx, record.args);
1124                         }
1125                 }
1126         }
1127 }
1128
1129 pub struct TestNodeSigner {
1130         node_secret: SecretKey,
1131 }
1132
1133 impl TestNodeSigner {
1134         pub fn new(node_secret: SecretKey) -> Self {
1135                 Self { node_secret }
1136         }
1137 }
1138
1139 impl NodeSigner for TestNodeSigner {
1140         fn get_inbound_payment_key_material(&self) -> crate::sign::KeyMaterial {
1141                 unreachable!()
1142         }
1143
1144         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1145                 let node_secret = match recipient {
1146                         Recipient::Node => Ok(&self.node_secret),
1147                         Recipient::PhantomNode => Err(())
1148                 }?;
1149                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
1150         }
1151
1152         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
1153                 let mut node_secret = match recipient {
1154                         Recipient::Node => Ok(self.node_secret.clone()),
1155                         Recipient::PhantomNode => Err(())
1156                 }?;
1157                 if let Some(tweak) = tweak {
1158                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
1159                 }
1160                 Ok(SharedSecret::new(other_key, &node_secret))
1161         }
1162
1163         fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
1164                 unreachable!()
1165         }
1166
1167         fn sign_bolt12_invoice_request(
1168                 &self, _invoice_request: &UnsignedInvoiceRequest
1169         ) -> Result<schnorr::Signature, ()> {
1170                 unreachable!()
1171         }
1172
1173         fn sign_bolt12_invoice(
1174                 &self, _invoice: &UnsignedBolt12Invoice,
1175         ) -> Result<schnorr::Signature, ()> {
1176                 unreachable!()
1177         }
1178
1179         fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1180                 unreachable!()
1181         }
1182 }
1183
1184 pub struct TestKeysInterface {
1185         pub backing: sign::PhantomKeysManager,
1186         pub override_random_bytes: Mutex<Option<[u8; 32]>>,
1187         pub disable_revocation_policy_check: bool,
1188         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
1189         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
1190         pub unavailable_signers: Mutex<HashSet<[u8; 32]>>,
1191 }
1192
1193 impl EntropySource for TestKeysInterface {
1194         fn get_secure_random_bytes(&self) -> [u8; 32] {
1195                 let override_random_bytes = self.override_random_bytes.lock().unwrap();
1196                 if let Some(bytes) = &*override_random_bytes {
1197                         return *bytes;
1198                 }
1199                 self.backing.get_secure_random_bytes()
1200         }
1201 }
1202
1203 impl NodeSigner for TestKeysInterface {
1204         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
1205                 self.backing.get_node_id(recipient)
1206         }
1207
1208         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
1209                 self.backing.ecdh(recipient, other_key, tweak)
1210         }
1211
1212         fn get_inbound_payment_key_material(&self) -> sign::KeyMaterial {
1213                 self.backing.get_inbound_payment_key_material()
1214         }
1215
1216         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
1217                 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
1218         }
1219
1220         fn sign_bolt12_invoice_request(
1221                 &self, invoice_request: &UnsignedInvoiceRequest
1222         ) -> Result<schnorr::Signature, ()> {
1223                 self.backing.sign_bolt12_invoice_request(invoice_request)
1224         }
1225
1226         fn sign_bolt12_invoice(
1227                 &self, invoice: &UnsignedBolt12Invoice,
1228         ) -> Result<schnorr::Signature, ()> {
1229                 self.backing.sign_bolt12_invoice(invoice)
1230         }
1231
1232         fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
1233                 self.backing.sign_gossip_message(msg)
1234         }
1235 }
1236
1237 impl SignerProvider for TestKeysInterface {
1238         type EcdsaSigner = TestChannelSigner;
1239         #[cfg(taproot)]
1240         type TaprootSigner = TestChannelSigner;
1241
1242         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
1243                 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
1244         }
1245
1246         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> TestChannelSigner {
1247                 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
1248                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
1249                 let signer = TestChannelSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check);
1250                 if self.unavailable_signers.lock().unwrap().contains(&channel_keys_id) {
1251                         signer.set_available(false);
1252                 }
1253                 signer
1254         }
1255
1256         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::EcdsaSigner, msgs::DecodeError> {
1257                 let mut reader = io::Cursor::new(buffer);
1258
1259                 let inner: InMemorySigner = ReadableArgs::read(&mut reader, self)?;
1260                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
1261
1262                 Ok(TestChannelSigner::new_with_revoked(
1263                         inner,
1264                         state,
1265                         self.disable_revocation_policy_check
1266                 ))
1267         }
1268
1269         fn get_destination_script(&self, channel_keys_id: [u8; 32]) -> Result<ScriptBuf, ()> { self.backing.get_destination_script(channel_keys_id) }
1270
1271         fn get_shutdown_scriptpubkey(&self) -> Result<ShutdownScript, ()> {
1272                 match &mut *self.expectations.lock().unwrap() {
1273                         None => self.backing.get_shutdown_scriptpubkey(),
1274                         Some(expectations) => match expectations.pop_front() {
1275                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
1276                                 Some(expectation) => Ok(expectation.returns),
1277                         },
1278                 }
1279         }
1280 }
1281
1282 impl TestKeysInterface {
1283         pub fn new(seed: &[u8; 32], network: Network) -> Self {
1284                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
1285                 Self {
1286                         backing: sign::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
1287                         override_random_bytes: Mutex::new(None),
1288                         disable_revocation_policy_check: false,
1289                         enforcement_states: Mutex::new(new_hash_map()),
1290                         expectations: Mutex::new(None),
1291                         unavailable_signers: Mutex::new(new_hash_set()),
1292                 }
1293         }
1294
1295         /// Sets an expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] is
1296         /// called.
1297         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
1298                 self.expectations.lock().unwrap()
1299                         .get_or_insert_with(|| VecDeque::new())
1300                         .push_back(expectation);
1301                 self
1302         }
1303
1304         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> TestChannelSigner {
1305                 self.derive_channel_signer(channel_value_satoshis, *id)
1306         }
1307
1308         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
1309                 let mut states = self.enforcement_states.lock().unwrap();
1310                 if !states.contains_key(&commitment_seed) {
1311                         let state = EnforcementState::new();
1312                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
1313                 }
1314                 let cell = states.get(&commitment_seed).unwrap();
1315                 Arc::clone(cell)
1316         }
1317 }
1318
1319 pub(crate) fn panicking() -> bool {
1320         #[cfg(feature = "std")]
1321         let panicking = ::std::thread::panicking();
1322         #[cfg(not(feature = "std"))]
1323         let panicking = false;
1324         return panicking;
1325 }
1326
1327 impl Drop for TestKeysInterface {
1328         fn drop(&mut self) {
1329                 if panicking() {
1330                         return;
1331                 }
1332
1333                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
1334                         if !expectations.is_empty() {
1335                                 panic!("Unsatisfied expectations: {:?}", expectations);
1336                         }
1337                 }
1338         }
1339 }
1340
1341 /// An expectation that [`sign::SignerProvider::get_shutdown_scriptpubkey`] was called and
1342 /// returns a [`ShutdownScript`].
1343 pub struct OnGetShutdownScriptpubkey {
1344         /// A shutdown script used to close a channel.
1345         pub returns: ShutdownScript,
1346 }
1347
1348 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
1349         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
1350                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
1351         }
1352 }
1353
1354 pub struct TestChainSource {
1355         pub chain_hash: ChainHash,
1356         pub utxo_ret: Mutex<UtxoResult>,
1357         pub get_utxo_call_count: AtomicUsize,
1358         pub watched_txn: Mutex<HashSet<(Txid, ScriptBuf)>>,
1359         pub watched_outputs: Mutex<HashSet<(OutPoint, ScriptBuf)>>,
1360 }
1361
1362 impl TestChainSource {
1363         pub fn new(network: Network) -> Self {
1364                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
1365                 Self {
1366                         chain_hash: ChainHash::using_genesis_block(network),
1367                         utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
1368                         get_utxo_call_count: AtomicUsize::new(0),
1369                         watched_txn: Mutex::new(new_hash_set()),
1370                         watched_outputs: Mutex::new(new_hash_set()),
1371                 }
1372         }
1373         pub fn remove_watched_txn_and_outputs(&self, outpoint: OutPoint, script_pubkey: ScriptBuf) {
1374                 self.watched_outputs.lock().unwrap().remove(&(outpoint, script_pubkey.clone()));
1375                 self.watched_txn.lock().unwrap().remove(&(outpoint.txid, script_pubkey));
1376         }
1377 }
1378
1379 impl UtxoLookup for TestChainSource {
1380         fn get_utxo(&self, chain_hash: &ChainHash, _short_channel_id: u64) -> UtxoResult {
1381                 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
1382                 if self.chain_hash != *chain_hash {
1383                         return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
1384                 }
1385
1386                 self.utxo_ret.lock().unwrap().clone()
1387         }
1388 }
1389
1390 impl chain::Filter for TestChainSource {
1391         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
1392                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.into()));
1393         }
1394
1395         fn register_output(&self, output: WatchedOutput) {
1396                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
1397         }
1398 }
1399
1400 impl Drop for TestChainSource {
1401         fn drop(&mut self) {
1402                 if panicking() {
1403                         return;
1404                 }
1405         }
1406 }
1407
1408 pub struct TestScorer {
1409         /// Stores a tuple of (scid, ChannelUsage)
1410         scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
1411 }
1412
1413 impl TestScorer {
1414         pub fn new() -> Self {
1415                 Self {
1416                         scorer_expectations: RefCell::new(None),
1417                 }
1418         }
1419
1420         pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
1421                 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
1422         }
1423 }
1424
1425 #[cfg(c_bindings)]
1426 impl crate::util::ser::Writeable for TestScorer {
1427         fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
1428 }
1429
1430 impl ScoreLookUp for TestScorer {
1431         type ScoreParams = ();
1432         fn channel_penalty_msat(
1433                 &self, candidate: &CandidateRouteHop, usage: ChannelUsage, _score_params: &Self::ScoreParams
1434         ) -> u64 {
1435                 let short_channel_id = match candidate.globally_unique_short_channel_id() {
1436                         Some(scid) => scid,
1437                         None => return 0,
1438                 };
1439                 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
1440                         match scorer_expectations.pop_front() {
1441                                 Some((scid, expectation)) => {
1442                                         assert_eq!(expectation, usage);
1443                                         assert_eq!(scid, short_channel_id);
1444                                 },
1445                                 None => {},
1446                         }
1447                 }
1448                 0
1449         }
1450 }
1451
1452 impl ScoreUpdate for TestScorer {
1453         fn payment_path_failed(&mut self, _actual_path: &Path, _actual_short_channel_id: u64, _duration_since_epoch: Duration) {}
1454
1455         fn payment_path_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1456
1457         fn probe_failed(&mut self, _actual_path: &Path, _: u64, _duration_since_epoch: Duration) {}
1458
1459         fn probe_successful(&mut self, _actual_path: &Path, _duration_since_epoch: Duration) {}
1460
1461         fn time_passed(&mut self, _duration_since_epoch: Duration) {}
1462 }
1463
1464 #[cfg(c_bindings)]
1465 impl crate::routing::scoring::Score for TestScorer {}
1466
1467 impl Drop for TestScorer {
1468         fn drop(&mut self) {
1469                 #[cfg(feature = "std")] {
1470                         if std::thread::panicking() {
1471                                 return;
1472                         }
1473                 }
1474
1475                 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
1476                         if !scorer_expectations.is_empty() {
1477                                 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
1478                         }
1479                 }
1480         }
1481 }
1482
1483 pub struct TestWalletSource {
1484         secret_key: SecretKey,
1485         utxos: RefCell<Vec<Utxo>>,
1486         secp: Secp256k1<bitcoin::secp256k1::All>,
1487 }
1488
1489 impl TestWalletSource {
1490         pub fn new(secret_key: SecretKey) -> Self {
1491                 Self {
1492                         secret_key,
1493                         utxos: RefCell::new(Vec::new()),
1494                         secp: Secp256k1::new(),
1495                 }
1496         }
1497
1498         pub fn add_utxo(&self, outpoint: bitcoin::OutPoint, value: u64) -> TxOut {
1499                 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1500                 let utxo = Utxo::new_p2pkh(outpoint, value, &public_key.pubkey_hash());
1501                 self.utxos.borrow_mut().push(utxo.clone());
1502                 utxo.output
1503         }
1504
1505         pub fn add_custom_utxo(&self, utxo: Utxo) -> TxOut {
1506                 let output = utxo.output.clone();
1507                 self.utxos.borrow_mut().push(utxo);
1508                 output
1509         }
1510
1511         pub fn remove_utxo(&self, outpoint: bitcoin::OutPoint) {
1512                 self.utxos.borrow_mut().retain(|utxo| utxo.outpoint != outpoint);
1513         }
1514 }
1515
1516 impl WalletSource for TestWalletSource {
1517         fn list_confirmed_utxos(&self) -> Result<Vec<Utxo>, ()> {
1518                 Ok(self.utxos.borrow().clone())
1519         }
1520
1521         fn get_change_script(&self) -> Result<ScriptBuf, ()> {
1522                 let public_key = bitcoin::PublicKey::new(self.secret_key.public_key(&self.secp));
1523                 Ok(ScriptBuf::new_p2pkh(&public_key.pubkey_hash()))
1524         }
1525
1526         fn sign_psbt(&self, psbt: PartiallySignedTransaction) -> Result<Transaction, ()> {
1527                 let mut tx = psbt.extract_tx();
1528                 let utxos = self.utxos.borrow();
1529                 for i in 0..tx.input.len() {
1530                         if let Some(utxo) = utxos.iter().find(|utxo| utxo.outpoint == tx.input[i].previous_output) {
1531                                 let sighash = SighashCache::new(&tx)
1532                                         .legacy_signature_hash(i, &utxo.output.script_pubkey, EcdsaSighashType::All as u32)
1533                                         .map_err(|_| ())?;
1534                                 let sig = self.secp.sign_ecdsa(&(*sighash.as_raw_hash()).into(), &self.secret_key);
1535                                 let bitcoin_sig = bitcoin::ecdsa::Signature { sig, hash_ty: EcdsaSighashType::All };
1536                                 tx.input[i].script_sig = Builder::new()
1537                                         .push_slice(&bitcoin_sig.serialize())
1538                                         .push_slice(&self.secret_key.public_key(&self.secp).serialize())
1539                                         .into_script();
1540                         }
1541                 }
1542                 Ok(tx)
1543         }
1544 }