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