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