_ 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 chain;
  11 use chain::WatchedOutput;
  12 use chain::chaininterface;
  13 use chain::chaininterface::ConfirmationTarget;
  14 use chain::chainmonitor;
  15 use chain::chainmonitor::MonitorUpdateId;
  16 use chain::channelmonitor;
  17 use chain::channelmonitor::MonitorEvent;
  18 use chain::transaction::OutPoint;
  19 use chain::keysinterface;
  20 use ln::features::{ChannelFeatures, InitFeatures};
  21 use ln::msgs;
  22 use ln::msgs::OptionalField;
  23 use ln::script::ShutdownScript;
  24 use routing::scoring::ScorerUsingTime;
  25 use routing::scoring::time::Eternity;
  26 use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
  27 use util::events;
  28 use util::logger::{Logger, Level, Record};
  29 use util::ser::{Readable, ReadableArgs, Writer, Writeable};
  30
  31 use bitcoin::blockdata::constants::genesis_block;
  32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  33 use bitcoin::blockdata::script::{Builder, Script};
  34 use bitcoin::blockdata::opcodes;
  35 use bitcoin::blockdata::block::BlockHeader;
  36 use bitcoin::network::constants::Network;
  37 use bitcoin::hash_types::{BlockHash, Txid};
  38
  39 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
  40 use bitcoin::secp256k1::recovery::RecoverableSignature;
  41
  42 use regex;
  43
  44 use io;
  45 use prelude::*;
  46 use core::time::Duration;
  47 use sync::{Mutex, Arc};
  48 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
  49 use core::{cmp, mem};
  50 use chain::keysinterface::InMemorySigner;
  51
  52 pub struct TestVecWriter(pub Vec<u8>);
  53 impl Writer for TestVecWriter {
  54         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
  55                 self.0.extend_from_slice(buf);
  56                 Ok(())
  57         }
  58 }
  59
  60 pub struct TestFeeEstimator {
  61         pub sat_per_kw: Mutex<u32>,
  62 }
  63 impl chaininterface::FeeEstimator for TestFeeEstimator {
  64         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
  65                 *self.sat_per_kw.lock().unwrap()
  66         }
  67 }
  68
  69 pub struct OnlyReadsKeysInterface {}
  70 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
  71         type Signer = EnforcingSigner;
  72
  73         fn get_node_secret(&self) -> SecretKey { unreachable!(); }
  74         fn get_destination_script(&self) -> Script { unreachable!(); }
  75         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); }
  76         fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> EnforcingSigner { unreachable!(); }
  77         fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
  78
  79         fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
  80                 let inner: InMemorySigner = Readable::read(&mut reader)?;
  81                 let state = Arc::new(Mutex::new(EnforcementState::new()));
  82
  83                 Ok(EnforcingSigner::new_with_revoked(
  84                         inner,
  85                         state,
  86                         false
  87                 ))
  88         }
  89         fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { unreachable!(); }
  90 }
  91
  92 pub struct TestChainMonitor<'a> {
  93         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
  94         pub monitor_updates: Mutex<HashMap<[u8; 32], Vec<channelmonitor::ChannelMonitorUpdate>>>,
  95         pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64, MonitorUpdateId)>>,
  96         pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<EnforcingSigner>>,
  97         pub keys_manager: &'a TestKeysInterface,
  98         /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
  99         /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
 100         /// boolean.
 101         pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
 102 }
 103 impl<'a> TestChainMonitor<'a> {
 104         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a chainmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
 105                 Self {
 106                         added_monitors: Mutex::new(Vec::new()),
 107                         monitor_updates: Mutex::new(HashMap::new()),
 108                         latest_monitor_update_id: Mutex::new(HashMap::new()),
 109                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
 110                         keys_manager,
 111                         expect_channel_force_closed: Mutex::new(None),
 112                 }
 113         }
 114 }
 115 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
 116         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::ChannelMonitorUpdateErr> {
 117                 // At every point where we get a monitor update, we should be able to send a useful monitor
 118                 // to a watchtower and disk...
 119                 let mut w = TestVecWriter(Vec::new());
 120                 monitor.write(&mut w).unwrap();
 121                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 122                         &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
 123                 assert!(new_monitor == monitor);
 124                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 125                         (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
 126                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
 127                 self.chain_monitor.watch_channel(funding_txo, new_monitor)
 128         }
 129
 130         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
 131                 // Every monitor update should survive roundtrip
 132                 let mut w = TestVecWriter(Vec::new());
 133                 update.write(&mut w).unwrap();
 134                 assert!(channelmonitor::ChannelMonitorUpdate::read(
 135                                 &mut io::Cursor::new(&w.0)).unwrap() == update);
 136
 137                 self.monitor_updates.lock().unwrap().entry(funding_txo.to_channel_id()).or_insert(Vec::new()).push(update.clone());
 138
 139                 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
 140                         assert_eq!(funding_txo.to_channel_id(), exp.0);
 141                         assert_eq!(update.updates.len(), 1);
 142                         if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
 143                                 assert_eq!(should_broadcast, exp.1);
 144                         } else { panic!(); }
 145                 }
 146
 147                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
 148                         (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(&update)));
 149                 let update_res = self.chain_monitor.update_channel(funding_txo, update);
 150                 // At every point where we get a monitor update, we should be able to send a useful monitor
 151                 // to a watchtower and disk...
 152                 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
 153                 w.0.clear();
 154                 monitor.write(&mut w).unwrap();
 155                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
 156                         &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
 157                 assert!(new_monitor == *monitor);
 158                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
 159                 update_res
 160         }
 161
 162         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
 163                 return self.chain_monitor.release_pending_monitor_events();
 164         }
 165 }
 166
 167 pub struct TestPersister {
 168         pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
 169         /// If this is set to Some(), after the next return, we'll always return this until update_ret
 170         /// is changed:
 171         pub next_update_ret: Mutex<Option<Result<(), chain::ChannelMonitorUpdateErr>>>,
 172         /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
 173         /// MonitorUpdateId here.
 174         pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
 175 }
 176 impl TestPersister {
 177         pub fn new() -> Self {
 178                 Self {
 179                         update_ret: Mutex::new(Ok(())),
 180                         next_update_ret: Mutex::new(None),
 181                         chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
 182                 }
 183         }
 184
 185         pub fn set_update_ret(&self, ret: Result<(), chain::ChannelMonitorUpdateErr>) {
 186                 *self.update_ret.lock().unwrap() = ret;
 187         }
 188
 189         pub fn set_next_update_ret(&self, next_ret: Option<Result<(), chain::ChannelMonitorUpdateErr>>) {
 190                 *self.next_update_ret.lock().unwrap() = next_ret;
 191         }
 192 }
 193 impl<Signer: keysinterface::Sign> chainmonitor::Persist<Signer> for TestPersister {
 194         fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 195                 let ret = self.update_ret.lock().unwrap().clone();
 196                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
 197                         *self.update_ret.lock().unwrap() = next_ret;
 198                 }
 199                 ret
 200         }
 201
 202         fn update_persisted_channel(&self, funding_txo: OutPoint, update: &Option<channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
 203                 let ret = self.update_ret.lock().unwrap().clone();
 204                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
 205                         *self.update_ret.lock().unwrap() = next_ret;
 206                 }
 207                 if update.is_none() {
 208                         self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
 209                 }
 210                 ret
 211         }
 212 }
 213
 214 pub struct TestBroadcaster {
 215         pub txn_broadcasted: Mutex<Vec<Transaction>>,
 216         pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
 217 }
 218
 219 impl TestBroadcaster {
 220         pub fn new(blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>) -> TestBroadcaster {
 221                 TestBroadcaster { txn_broadcasted: Mutex::new(Vec::new()), blocks }
 222         }
 223 }
 224
 225 impl chaininterface::BroadcasterInterface for TestBroadcaster {
 226         fn broadcast_transaction(&self, tx: &Transaction) {
 227                 assert!(tx.lock_time < 1_500_000_000);
 228                 if tx.lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && tx.lock_time < 500_000_000 {
 229                         for inp in tx.input.iter() {
 230                                 if inp.sequence != 0xffffffff {
 231                                         panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
 232                                 }
 233                         }
 234                 }
 235                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
 236         }
 237 }
 238
 239 pub struct TestChannelMessageHandler {
 240         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
 241 }
 242
 243 impl TestChannelMessageHandler {
 244         pub fn new() -> Self {
 245                 TestChannelMessageHandler {
 246                         pending_events: Mutex::new(Vec::new()),
 247                 }
 248         }
 249 }
 250
 251 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
 252         fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
 253         fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
 254         fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
 255         fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
 256         fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
 257         fn handle_shutdown(&self, _their_node_id: &PublicKey, _their_features: &InitFeatures, _msg: &msgs::Shutdown) {}
 258         fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
 259         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
 260         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
 261         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
 262         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
 263         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
 264         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
 265         fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
 266         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
 267         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
 268         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
 269         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
 270         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
 271         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
 272 }
 273
 274 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
 275         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 276                 let mut pending_events = self.pending_events.lock().unwrap();
 277                 let mut ret = Vec::new();
 278                 mem::swap(&mut ret, &mut *pending_events);
 279                 ret
 280         }
 281 }
 282
 283 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
 284         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 285         let secp_ctx = Secp256k1::new();
 286         let network = Network::Testnet;
 287         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
 288         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
 289         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
 290         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
 291         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
 292                 features: ChannelFeatures::known(),
 293                 chain_hash: genesis_block(network).header.block_hash(),
 294                 short_channel_id: short_chan_id,
 295                 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
 296                 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
 297                 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
 298                 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
 299                 excess_data: Vec::new(),
 300         };
 301
 302         unsafe {
 303                 msgs::ChannelAnnouncement {
 304                         node_signature_1: Signature::from(FFISignature::new()),
 305                         node_signature_2: Signature::from(FFISignature::new()),
 306                         bitcoin_signature_1: Signature::from(FFISignature::new()),
 307                         bitcoin_signature_2: Signature::from(FFISignature::new()),
 308                         contents: unsigned_ann,
 309                 }
 310         }
 311 }
 312
 313 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
 314         use bitcoin::secp256k1::ffi::Signature as FFISignature;
 315         let network = Network::Testnet;
 316         msgs::ChannelUpdate {
 317                 signature: Signature::from(unsafe { FFISignature::new() }),
 318                 contents: msgs::UnsignedChannelUpdate {
 319                         chain_hash: genesis_block(network).header.block_hash(),
 320                         short_channel_id: short_chan_id,
 321                         timestamp: 0,
 322                         flags: 0,
 323                         cltv_expiry_delta: 0,
 324                         htlc_minimum_msat: 0,
 325                         htlc_maximum_msat: OptionalField::Absent,
 326                         fee_base_msat: 0,
 327                         fee_proportional_millionths: 0,
 328                         excess_data: vec![],
 329                 }
 330         }
 331 }
 332
 333 pub struct TestRoutingMessageHandler {
 334         pub chan_upds_recvd: AtomicUsize,
 335         pub chan_anns_recvd: AtomicUsize,
 336         pub request_full_sync: AtomicBool,
 337 }
 338
 339 impl TestRoutingMessageHandler {
 340         pub fn new() -> Self {
 341                 TestRoutingMessageHandler {
 342                         chan_upds_recvd: AtomicUsize::new(0),
 343                         chan_anns_recvd: AtomicUsize::new(0),
 344                         request_full_sync: AtomicBool::new(false),
 345                 }
 346         }
 347 }
 348 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
 349         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
 350                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 351         }
 352         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
 353                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
 354                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 355         }
 356         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
 357                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
 358                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
 359         }
 360         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
 361                 let mut chan_anns = Vec::new();
 362                 const TOTAL_UPDS: u64 = 50;
 363                 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS);
 364                 for i in starting_point..end {
 365                         let chan_upd_1 = get_dummy_channel_update(i);
 366                         let chan_upd_2 = get_dummy_channel_update(i);
 367                         let chan_ann = get_dummy_channel_announcement(i);
 368
 369                         chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
 370                 }
 371
 372                 chan_anns
 373         }
 374
 375         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
 376                 Vec::new()
 377         }
 378
 379         fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
 380
 381         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
 382                 Ok(())
 383         }
 384
 385         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
 386                 Ok(())
 387         }
 388
 389         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
 390                 Ok(())
 391         }
 392
 393         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
 394                 Ok(())
 395         }
 396 }
 397
 398 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
 399         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
 400                 vec![]
 401         }
 402 }
 403
 404 pub struct TestLogger {
 405         level: Level,
 406         id: String,
 407         pub lines: Mutex<HashMap<(String, String), usize>>,
 408 }
 409
 410 impl TestLogger {
 411         pub fn new() -> TestLogger {
 412                 Self::with_id("".to_owned())
 413         }
 414         pub fn with_id(id: String) -> TestLogger {
 415                 TestLogger {
 416                         level: Level::Trace,
 417                         id,
 418                         lines: Mutex::new(HashMap::new())
 419                 }
 420         }
 421         pub fn enable(&mut self, level: Level) {
 422                 self.level = level;
 423         }
 424         pub fn assert_log(&self, module: String, line: String, count: usize) {
 425                 let log_entries = self.lines.lock().unwrap();
 426                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
 427         }
 428
 429         /// Search for the number of occurrence of the logged lines which
 430         /// 1. belongs to the specified module and
 431         /// 2. contains `line` in it.
 432         /// And asserts if the number of occurrences is the same with the given `count`
 433         pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
 434                 let log_entries = self.lines.lock().unwrap();
 435                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 436                         m == &module && l.contains(line.as_str())
 437                 }).map(|(_, c) | { c }).sum();
 438                 assert_eq!(l, count)
 439         }
 440
 441     /// Search for the number of occurrences of logged lines which
 442     /// 1. belong to the specified module and
 443     /// 2. match the given regex pattern.
 444     /// Assert that the number of occurrences equals the given `count`
 445         pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
 446                 let log_entries = self.lines.lock().unwrap();
 447                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
 448                         m == &module && pattern.is_match(&l)
 449                 }).map(|(_, c) | { c }).sum();
 450                 assert_eq!(l, count)
 451         }
 452 }
 453
 454 impl Logger for TestLogger {
 455         fn log(&self, record: &Record) {
 456                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
 457                 if record.level >= self.level {
 458                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
 459                 }
 460         }
 461 }
 462
 463 pub struct TestKeysInterface {
 464         pub backing: keysinterface::KeysManager,
 465         pub override_session_priv: Mutex<Option<[u8; 32]>>,
 466         pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
 467         pub disable_revocation_policy_check: bool,
 468         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
 469         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
 470 }
 471
 472 impl keysinterface::KeysInterface for TestKeysInterface {
 473         type Signer = EnforcingSigner;
 474
 475         fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
 476         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
 477
 478         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
 479                 match &mut *self.expectations.lock().unwrap() {
 480                         None => self.backing.get_shutdown_scriptpubkey(),
 481                         Some(expectations) => match expectations.pop_front() {
 482                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
 483                                 Some(expectation) => expectation.returns,
 484                         },
 485                 }
 486         }
 487
 488         fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
 489                 let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis);
 490                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 491                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 492         }
 493
 494         fn get_secure_random_bytes(&self) -> [u8; 32] {
 495                 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
 496                 let override_session_key = self.override_session_priv.lock().unwrap();
 497                 if override_channel_id.is_some() && override_session_key.is_some() {
 498                         panic!("We don't know which override key to use!");
 499                 }
 500                 if let Some(key) = &*override_channel_id {
 501                         return *key;
 502                 }
 503                 if let Some(key) = &*override_session_key {
 504                         return *key;
 505                 }
 506                 self.backing.get_secure_random_bytes()
 507         }
 508
 509         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
 510                 let mut reader = io::Cursor::new(buffer);
 511
 512                 let inner: InMemorySigner = Readable::read(&mut reader)?;
 513                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
 514
 515                 Ok(EnforcingSigner::new_with_revoked(
 516                         inner,
 517                         state,
 518                         self.disable_revocation_policy_check
 519                 ))
 520         }
 521
 522         fn sign_invoice(&self, invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
 523                 self.backing.sign_invoice(invoice_preimage)
 524         }
 525 }
 526
 527 impl TestKeysInterface {
 528         pub fn new(seed: &[u8; 32], network: Network) -> Self {
 529                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
 530                 Self {
 531                         backing: keysinterface::KeysManager::new(seed, now.as_secs(), now.subsec_nanos()),
 532                         override_session_priv: Mutex::new(None),
 533                         override_channel_id_priv: Mutex::new(None),
 534                         disable_revocation_policy_check: false,
 535                         enforcement_states: Mutex::new(HashMap::new()),
 536                         expectations: Mutex::new(None),
 537                 }
 538         }
 539
 540         /// Sets an expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] is
 541         /// called.
 542         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
 543                 self.expectations.lock().unwrap()
 544                         .get_or_insert_with(|| VecDeque::new())
 545                         .push_back(expectation);
 546                 self
 547         }
 548
 549         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
 550                 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
 551                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
 552                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
 553         }
 554
 555         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
 556                 let mut states = self.enforcement_states.lock().unwrap();
 557                 if !states.contains_key(&commitment_seed) {
 558                         let state = EnforcementState::new();
 559                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
 560                 }
 561                 let cell = states.get(&commitment_seed).unwrap();
 562                 Arc::clone(cell)
 563         }
 564 }
 565
 566 impl Drop for TestKeysInterface {
 567         fn drop(&mut self) {
 568                 if std::thread::panicking() {
 569                         return;
 570                 }
 571
 572                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 573                         if !expectations.is_empty() {
 574                                 panic!("Unsatisfied expectations: {:?}", expectations);
 575                         }
 576                 }
 577         }
 578 }
 579
 580 /// An expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] was called and
 581 /// returns a [`ShutdownScript`].
 582 pub struct OnGetShutdownScriptpubkey {
 583         /// A shutdown script used to close a channel.
 584         pub returns: ShutdownScript,
 585 }
 586
 587 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
 588         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 589                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
 590         }
 591 }
 592
 593 pub struct TestChainSource {
 594         pub genesis_hash: BlockHash,
 595         pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
 596         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
 597         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
 598         expectations: Mutex<Option<VecDeque<OnRegisterOutput>>>,
 599 }
 600
 601 impl TestChainSource {
 602         pub fn new(network: Network) -> Self {
 603                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
 604                 Self {
 605                         genesis_hash: genesis_block(network).block_hash(),
 606                         utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
 607                         watched_txn: Mutex::new(HashSet::new()),
 608                         watched_outputs: Mutex::new(HashSet::new()),
 609                         expectations: Mutex::new(None),
 610                 }
 611         }
 612
 613         /// Sets an expectation that [`chain::Filter::register_output`] is called.
 614         pub fn expect(&self, expectation: OnRegisterOutput) -> &Self {
 615                 self.expectations.lock().unwrap()
 616                         .get_or_insert_with(|| VecDeque::new())
 617                         .push_back(expectation);
 618                 self
 619         }
 620 }
 621
 622 impl chain::Access for TestChainSource {
 623         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
 624                 if self.genesis_hash != *genesis_hash {
 625                         return Err(chain::AccessError::UnknownChain);
 626                 }
 627
 628                 self.utxo_ret.lock().unwrap().clone()
 629         }
 630 }
 631
 632 impl chain::Filter for TestChainSource {
 633         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
 634                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
 635         }
 636
 637         fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> {
 638                 let dependent_tx = match &mut *self.expectations.lock().unwrap() {
 639                         None => None,
 640                         Some(expectations) => match expectations.pop_front() {
 641                                 None => {
 642                                         panic!("Unexpected register_output: {:?}",
 643                                                 (output.outpoint, output.script_pubkey));
 644                                 },
 645                                 Some(expectation) => {
 646                                         assert_eq!(output.outpoint, expectation.outpoint());
 647                                         assert_eq!(&output.script_pubkey, expectation.script_pubkey());
 648                                         expectation.returns
 649                                 },
 650                         },
 651                 };
 652
 653                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
 654                 dependent_tx
 655         }
 656 }
 657
 658 impl Drop for TestChainSource {
 659         fn drop(&mut self) {
 660                 if std::thread::panicking() {
 661                         return;
 662                 }
 663
 664                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
 665                         if !expectations.is_empty() {
 666                                 panic!("Unsatisfied expectations: {:?}", expectations);
 667                         }
 668                 }
 669         }
 670 }
 671
 672 /// An expectation that [`chain::Filter::register_output`] was called with a transaction output and
 673 /// returns an optional dependent transaction that spends the output in the same block.
 674 pub struct OnRegisterOutput {
 675         /// The transaction output to register.
 676         pub with: TxOutReference,
 677
 678         /// A dependent transaction spending the output along with its position in the block.
 679         pub returns: Option<(usize, Transaction)>,
 680 }
 681
 682 /// A transaction output as identified by an index into a transaction's output list.
 683 pub struct TxOutReference(pub Transaction, pub usize);
 684
 685 impl OnRegisterOutput {
 686         fn outpoint(&self) -> OutPoint {
 687                 let txid = self.with.0.txid();
 688                 let index = self.with.1 as u16;
 689                 OutPoint { txid, index }
 690         }
 691
 692         fn script_pubkey(&self) -> &Script {
 693                 let index = self.with.1;
 694                 &self.with.0.output[index].script_pubkey
 695         }
 696 }
 697
 698 impl core::fmt::Debug for OnRegisterOutput {
 699         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
 700                 f.debug_struct("OnRegisterOutput")
 701                         .field("outpoint", &self.outpoint())
 702                         .field("script_pubkey", self.script_pubkey())
 703                         .finish()
 704         }
 705 }
 706
 707 /// A scorer useful in testing, when the passage of time isn't a concern.
 708 pub type TestScorer = ScorerUsingTime<Eternity>;