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