X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Futil%2Ftest_utils.rs;h=6dd5836c4809ec4d9691f1d926457ab2aa985836;hb=c828ff42c006abf3ceffe552dfe510f9f3538e11;hp=a0ccf4f816ea991e31a019351018d43a95633324;hpb=e8a0824dd4b62288805f0e6cf435e52fd022b7c2;p=rust-lightning diff --git a/lightning/src/util/test_utils.rs b/lightning/src/util/test_utils.rs index a0ccf4f8..6dd5836c 100644 --- a/lightning/src/util/test_utils.rs +++ b/lightning/src/util/test_utils.rs @@ -8,6 +8,7 @@ // licenses. use chain; +use chain::WatchedOutput; use chain::chaininterface; use chain::chaininterface::ConfirmationTarget; use chain::chainmonitor; @@ -18,7 +19,8 @@ use chain::keysinterface; use ln::features::{ChannelFeatures, InitFeatures}; use ln::msgs; use ln::msgs::OptionalField; -use util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER}; +use ln::script::ShutdownScript; +use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState}; use util::events; use util::logger::{Logger, Level, Record}; use util::ser::{Readable, ReadableArgs, Writer, Writeable}; @@ -27,23 +29,26 @@ use bitcoin::blockdata::constants::genesis_block; use bitcoin::blockdata::transaction::{Transaction, TxOut}; use bitcoin::blockdata::script::{Builder, Script}; use bitcoin::blockdata::opcodes; +use bitcoin::blockdata::block::BlockHeader; use bitcoin::network::constants::Network; use bitcoin::hash_types::{BlockHash, Txid}; use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature}; +use bitcoin::secp256k1::recovery::RecoverableSignature; use regex; -use std::time::Duration; -use std::sync::{Mutex, Arc}; -use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering}; -use std::{cmp, mem}; -use std::collections::{HashMap, HashSet}; +use io; +use prelude::*; +use core::time::Duration; +use sync::{Mutex, Arc}; +use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering}; +use core::{cmp, mem}; use chain::keysinterface::InMemorySigner; pub struct TestVecWriter(pub Vec); impl Writer for TestVecWriter { - fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> { + fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> { self.0.extend_from_slice(buf); Ok(()) } @@ -53,11 +58,11 @@ impl Writer for TestVecWriter { } pub struct TestFeeEstimator { - pub sat_per_kw: u32, + pub sat_per_kw: Mutex, } impl chaininterface::FeeEstimator for TestFeeEstimator { fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 { - self.sat_per_kw + *self.sat_per_kw.lock().unwrap() } } @@ -67,13 +72,21 @@ impl keysinterface::KeysInterface for OnlyReadsKeysInterface { fn get_node_secret(&self) -> SecretKey { unreachable!(); } fn get_destination_script(&self) -> Script { unreachable!(); } - fn get_shutdown_pubkey(&self) -> PublicKey { unreachable!(); } + fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); } fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> EnforcingSigner { unreachable!(); } fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] } - fn read_chan_signer(&self, reader: &[u8]) -> Result { - EnforcingSigner::read(&mut std::io::Cursor::new(reader)) + fn read_chan_signer(&self, mut reader: &[u8]) -> Result { + let inner: InMemorySigner = Readable::read(&mut reader)?; + let state = Arc::new(Mutex::new(EnforcementState::new())); + + Ok(EnforcingSigner::new_with_revoked( + inner, + state, + false + )) } + fn sign_invoice(&self, _invoice_preimage: Vec) -> Result { unreachable!(); } } pub struct TestChainMonitor<'a> { @@ -110,7 +123,7 @@ impl<'a> chain::Watch for TestChainMonitor<'a> { let mut w = TestVecWriter(Vec::new()); monitor.write(&mut w).unwrap(); let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor)>::read( - &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1; + &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1; assert!(new_monitor == monitor); self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id())); self.added_monitors.lock().unwrap().push((funding_txo, monitor)); @@ -132,7 +145,7 @@ impl<'a> chain::Watch for TestChainMonitor<'a> { let mut w = TestVecWriter(Vec::new()); update.write(&mut w).unwrap(); assert!(channelmonitor::ChannelMonitorUpdate::read( - &mut ::std::io::Cursor::new(&w.0)).unwrap() == update); + &mut io::Cursor::new(&w.0)).unwrap() == update); if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() { assert_eq!(funding_txo.to_channel_id(), exp.0); @@ -151,7 +164,7 @@ impl<'a> chain::Watch for TestChainMonitor<'a> { w.0.clear(); monitor.write(&mut w).unwrap(); let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor)>::read( - &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1; + &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1; assert!(new_monitor == *monitor); self.added_monitors.lock().unwrap().push((funding_txo, new_monitor)); @@ -185,21 +198,30 @@ impl TestPersister { *self.update_ret.lock().unwrap() = ret; } } -impl channelmonitor::Persist for TestPersister { - fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> { +impl channelmonitor::Persist for TestPersister { + fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> { self.update_ret.lock().unwrap().clone() } - fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> { + fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> { self.update_ret.lock().unwrap().clone() } } pub struct TestBroadcaster { pub txn_broadcasted: Mutex>, + pub blocks: Arc>>, } impl chaininterface::BroadcasterInterface for TestBroadcaster { fn broadcast_transaction(&self, tx: &Transaction) { + assert!(tx.lock_time < 1_500_000_000); + if tx.lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && tx.lock_time < 500_000_000 { + for inp in tx.input.iter() { + if inp.sequence != 0xffffffff { + panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time); + } + } + } self.txn_broadcasted.lock().unwrap().push(tx.clone()); } } @@ -327,7 +349,6 @@ impl msgs::RoutingMessageHandler for TestRoutingMessageHandler { self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel); Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError }) } - fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {} fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option, Option)> { let mut chan_anns = Vec::new(); const TOTAL_UPDS: u64 = 100; @@ -426,7 +447,7 @@ impl TestLogger { impl Logger for TestLogger { fn log(&self, record: &Record) { *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1; - if self.level >= record.level { + if record.level >= self.level { println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args); } } @@ -437,7 +458,8 @@ pub struct TestKeysInterface { pub override_session_priv: Mutex>, pub override_channel_id_priv: Mutex>, pub disable_revocation_policy_check: bool, - revoked_commitments: Mutex>>>, + enforcement_states: Mutex>>>, + expectations: Mutex>>, } impl keysinterface::KeysInterface for TestKeysInterface { @@ -445,11 +467,21 @@ impl keysinterface::KeysInterface for TestKeysInterface { fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() } fn get_destination_script(&self) -> Script { self.backing.get_destination_script() } - fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() } + + fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { + match &mut *self.expectations.lock().unwrap() { + None => self.backing.get_shutdown_scriptpubkey(), + Some(expectations) => match expectations.pop_front() { + None => panic!("Unexpected get_shutdown_scriptpubkey"), + Some(expectation) => expectation.returns, + }, + } + } + fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner { let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis); - let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed); - EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check) + let state = self.make_enforcement_state_cell(keys.commitment_seed); + EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check) } fn get_secure_random_bytes(&self) -> [u8; 32] { @@ -468,22 +500,22 @@ impl keysinterface::KeysInterface for TestKeysInterface { } fn read_chan_signer(&self, buffer: &[u8]) -> Result { - let mut reader = std::io::Cursor::new(buffer); + let mut reader = io::Cursor::new(buffer); let inner: InMemorySigner = Readable::read(&mut reader)?; - let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed); - - let last_commitment_number = Readable::read(&mut reader)?; + let state = self.make_enforcement_state_cell(inner.commitment_seed); - Ok(EnforcingSigner { + Ok(EnforcingSigner::new_with_revoked( inner, - last_commitment_number: Arc::new(Mutex::new(last_commitment_number)), - revoked_commitment, - disable_revocation_policy_check: self.disable_revocation_policy_check, - }) + state, + self.disable_revocation_policy_check + )) } -} + fn sign_invoice(&self, invoice_preimage: Vec) -> Result { + self.backing.sign_invoice(invoice_preimage) + } +} impl TestKeysInterface { pub fn new(seed: &[u8; 32], network: Network) -> Self { @@ -493,30 +525,70 @@ impl TestKeysInterface { override_session_priv: Mutex::new(None), override_channel_id_priv: Mutex::new(None), disable_revocation_policy_check: false, - revoked_commitments: Mutex::new(HashMap::new()), + enforcement_states: Mutex::new(HashMap::new()), + expectations: Mutex::new(None), } } + + /// Sets an expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] is + /// called. + pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self { + self.expectations.lock().unwrap() + .get_or_insert_with(|| VecDeque::new()) + .push_back(expectation); + self + } + pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner { let keys = self.backing.derive_channel_keys(channel_value_satoshis, id); - let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed); - EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check) + let state = self.make_enforcement_state_cell(keys.commitment_seed); + EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check) } - fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc> { - let mut revoked_commitments = self.revoked_commitments.lock().unwrap(); - if !revoked_commitments.contains_key(&commitment_seed) { - revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER))); + fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc> { + let mut states = self.enforcement_states.lock().unwrap(); + if !states.contains_key(&commitment_seed) { + let state = EnforcementState::new(); + states.insert(commitment_seed, Arc::new(Mutex::new(state))); } - let cell = revoked_commitments.get(&commitment_seed).unwrap(); + let cell = states.get(&commitment_seed).unwrap(); Arc::clone(cell) } } +impl Drop for TestKeysInterface { + fn drop(&mut self) { + if std::thread::panicking() { + return; + } + + if let Some(expectations) = &*self.expectations.lock().unwrap() { + if !expectations.is_empty() { + panic!("Unsatisfied expectations: {:?}", expectations); + } + } + } +} + +/// An expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] was called and +/// returns a [`ShutdownScript`]. +pub struct OnGetShutdownScriptpubkey { + /// A shutdown script used to close a channel. + pub returns: ShutdownScript, +} + +impl core::fmt::Debug for OnGetShutdownScriptpubkey { + fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { + f.debug_struct("OnGetShutdownScriptpubkey").finish() + } +} + pub struct TestChainSource { pub genesis_hash: BlockHash, pub utxo_ret: Mutex>, pub watched_txn: Mutex>, pub watched_outputs: Mutex>, + expectations: Mutex>>, } impl TestChainSource { @@ -527,8 +599,17 @@ impl TestChainSource { utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })), watched_txn: Mutex::new(HashSet::new()), watched_outputs: Mutex::new(HashSet::new()), + expectations: Mutex::new(None), } } + + /// Sets an expectation that [`chain::Filter::register_output`] is called. + pub fn expect(&self, expectation: OnRegisterOutput) -> &Self { + self.expectations.lock().unwrap() + .get_or_insert_with(|| VecDeque::new()) + .push_back(expectation); + self + } } impl chain::Access for TestChainSource { @@ -546,7 +627,72 @@ impl chain::Filter for TestChainSource { self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone())); } - fn register_output(&self, outpoint: &OutPoint, script_pubkey: &Script) { - self.watched_outputs.lock().unwrap().insert((*outpoint, script_pubkey.clone())); + fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> { + let dependent_tx = match &mut *self.expectations.lock().unwrap() { + None => None, + Some(expectations) => match expectations.pop_front() { + None => { + panic!("Unexpected register_output: {:?}", + (output.outpoint, output.script_pubkey)); + }, + Some(expectation) => { + assert_eq!(output.outpoint, expectation.outpoint()); + assert_eq!(&output.script_pubkey, expectation.script_pubkey()); + expectation.returns + }, + }, + }; + + self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey)); + dependent_tx + } +} + +impl Drop for TestChainSource { + fn drop(&mut self) { + if std::thread::panicking() { + return; + } + + if let Some(expectations) = &*self.expectations.lock().unwrap() { + if !expectations.is_empty() { + panic!("Unsatisfied expectations: {:?}", expectations); + } + } + } +} + +/// An expectation that [`chain::Filter::register_output`] was called with a transaction output and +/// returns an optional dependent transaction that spends the output in the same block. +pub struct OnRegisterOutput { + /// The transaction output to register. + pub with: TxOutReference, + + /// A dependent transaction spending the output along with its position in the block. + pub returns: Option<(usize, Transaction)>, +} + +/// A transaction output as identified by an index into a transaction's output list. +pub struct TxOutReference(pub Transaction, pub usize); + +impl OnRegisterOutput { + fn outpoint(&self) -> OutPoint { + let txid = self.with.0.txid(); + let index = self.with.1 as u16; + OutPoint { txid, index } + } + + fn script_pubkey(&self) -> &Script { + let index = self.with.1; + &self.with.0.output[index].script_pubkey + } +} + +impl core::fmt::Debug for OnRegisterOutput { + fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { + f.debug_struct("OnRegisterOutput") + .field("outpoint", &self.outpoint()) + .field("script_pubkey", self.script_pubkey()) + .finish() } }