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