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