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