1 // This file is Copyright its original authors, visible in version control
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
11 use chain::WatchedOutput;
12 use chain::chaininterface;
13 use chain::chaininterface::ConfirmationTarget;
14 use chain::chainmonitor;
15 use chain::chainmonitor::MonitorUpdateId;
16 use chain::channelmonitor;
17 use chain::channelmonitor::MonitorEvent;
18 use chain::transaction::OutPoint;
19 use chain::keysinterface;
20 use ln::features::{ChannelFeatures, InitFeatures};
22 use ln::msgs::OptionalField;
23 use ln::script::ShutdownScript;
24 use util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
26 use util::logger::{Logger, Level, Record};
27 use util::ser::{Readable, ReadableArgs, Writer, Writeable};
29 use bitcoin::blockdata::constants::genesis_block;
30 use bitcoin::blockdata::transaction::{Transaction, TxOut};
31 use bitcoin::blockdata::script::{Builder, Script};
32 use bitcoin::blockdata::opcodes;
33 use bitcoin::blockdata::block::BlockHeader;
34 use bitcoin::network::constants::Network;
35 use bitcoin::hash_types::{BlockHash, Txid};
37 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
38 use bitcoin::secp256k1::recovery::RecoverableSignature;
44 use core::time::Duration;
45 use sync::{Mutex, Arc};
46 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
48 use chain::keysinterface::InMemorySigner;
50 pub struct TestVecWriter(pub Vec<u8>);
51 impl Writer for TestVecWriter {
52 fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
53 self.0.extend_from_slice(buf);
58 pub struct TestFeeEstimator {
59 pub sat_per_kw: Mutex<u32>,
61 impl chaininterface::FeeEstimator for TestFeeEstimator {
62 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
63 *self.sat_per_kw.lock().unwrap()
67 pub struct OnlyReadsKeysInterface {}
68 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
69 type Signer = EnforcingSigner;
71 fn get_node_secret(&self) -> SecretKey { unreachable!(); }
72 fn get_destination_script(&self) -> Script { unreachable!(); }
73 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { 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] }
77 fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
78 let inner: InMemorySigner = Readable::read(&mut reader)?;
79 let state = Arc::new(Mutex::new(EnforcementState::new()));
81 Ok(EnforcingSigner::new_with_revoked(
87 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { unreachable!(); }
90 pub struct TestChainMonitor<'a> {
91 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
92 pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64, MonitorUpdateId)>>,
93 pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<EnforcingSigner>>,
94 pub keys_manager: &'a TestKeysInterface,
95 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
96 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
98 pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
100 impl<'a> TestChainMonitor<'a> {
101 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 {
103 added_monitors: Mutex::new(Vec::new()),
104 latest_monitor_update_id: Mutex::new(HashMap::new()),
105 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
107 expect_channel_force_closed: Mutex::new(None),
111 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
112 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), chain::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(),
121 (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
122 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
123 self.chain_monitor.watch_channel(funding_txo, new_monitor)
126 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), chain::ChannelMonitorUpdateErr> {
127 // Every monitor update should survive roundtrip
128 let mut w = TestVecWriter(Vec::new());
129 update.write(&mut w).unwrap();
130 assert!(channelmonitor::ChannelMonitorUpdate::read(
131 &mut io::Cursor::new(&w.0)).unwrap() == update);
133 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
134 assert_eq!(funding_txo.to_channel_id(), exp.0);
135 assert_eq!(update.updates.len(), 1);
136 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
137 assert_eq!(should_broadcast, exp.1);
141 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
142 (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(&update)));
143 let update_res = self.chain_monitor.update_channel(funding_txo, update);
144 // At every point where we get a monitor update, we should be able to send a useful monitor
145 // to a watchtower and disk...
146 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
148 monitor.write(&mut w).unwrap();
149 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
150 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
151 assert!(new_monitor == *monitor);
152 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
156 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
157 return self.chain_monitor.release_pending_monitor_events();
161 pub struct TestPersister {
162 pub update_ret: Mutex<Result<(), chain::ChannelMonitorUpdateErr>>,
163 /// If this is set to Some(), after the next return, we'll always return this until update_ret
165 pub next_update_ret: Mutex<Option<Result<(), chain::ChannelMonitorUpdateErr>>>,
169 pub fn new() -> Self {
171 update_ret: Mutex::new(Ok(())),
172 next_update_ret: Mutex::new(None),
176 pub fn set_update_ret(&self, ret: Result<(), chain::ChannelMonitorUpdateErr>) {
177 *self.update_ret.lock().unwrap() = ret;
180 pub fn set_next_update_ret(&self, next_ret: Option<Result<(), chain::ChannelMonitorUpdateErr>>) {
181 *self.next_update_ret.lock().unwrap() = next_ret;
184 impl<Signer: keysinterface::Sign> chainmonitor::Persist<Signer> for TestPersister {
185 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
186 let ret = self.update_ret.lock().unwrap().clone();
187 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
188 *self.update_ret.lock().unwrap() = next_ret;
193 fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> Result<(), chain::ChannelMonitorUpdateErr> {
194 let ret = self.update_ret.lock().unwrap().clone();
195 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
196 *self.update_ret.lock().unwrap() = next_ret;
202 pub struct TestBroadcaster {
203 pub txn_broadcasted: Mutex<Vec<Transaction>>,
204 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
206 impl chaininterface::BroadcasterInterface for TestBroadcaster {
207 fn broadcast_transaction(&self, tx: &Transaction) {
208 assert!(tx.lock_time < 1_500_000_000);
209 if tx.lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && tx.lock_time < 500_000_000 {
210 for inp in tx.input.iter() {
211 if inp.sequence != 0xffffffff {
212 panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
216 self.txn_broadcasted.lock().unwrap().push(tx.clone());
220 pub struct TestChannelMessageHandler {
221 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
224 impl TestChannelMessageHandler {
225 pub fn new() -> Self {
226 TestChannelMessageHandler {
227 pending_events: Mutex::new(Vec::new()),
232 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
233 fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
234 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
235 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
236 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
237 fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
238 fn handle_shutdown(&self, _their_node_id: &PublicKey, _their_features: &InitFeatures, _msg: &msgs::Shutdown) {}
239 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
240 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
241 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
242 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
243 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
244 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
245 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
246 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
247 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
248 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
249 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
250 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
251 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
252 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
255 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
256 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
257 let mut pending_events = self.pending_events.lock().unwrap();
258 let mut ret = Vec::new();
259 mem::swap(&mut ret, &mut *pending_events);
264 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
265 use bitcoin::secp256k1::ffi::Signature as FFISignature;
266 let secp_ctx = Secp256k1::new();
267 let network = Network::Testnet;
268 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
269 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
270 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
271 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
272 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
273 features: ChannelFeatures::known(),
274 chain_hash: genesis_block(network).header.block_hash(),
275 short_channel_id: short_chan_id,
276 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
277 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
278 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
279 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
280 excess_data: Vec::new(),
284 msgs::ChannelAnnouncement {
285 node_signature_1: Signature::from(FFISignature::new()),
286 node_signature_2: Signature::from(FFISignature::new()),
287 bitcoin_signature_1: Signature::from(FFISignature::new()),
288 bitcoin_signature_2: Signature::from(FFISignature::new()),
289 contents: unsigned_ann,
294 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
295 use bitcoin::secp256k1::ffi::Signature as FFISignature;
296 let network = Network::Testnet;
297 msgs::ChannelUpdate {
298 signature: Signature::from(unsafe { FFISignature::new() }),
299 contents: msgs::UnsignedChannelUpdate {
300 chain_hash: genesis_block(network).header.block_hash(),
301 short_channel_id: short_chan_id,
304 cltv_expiry_delta: 0,
305 htlc_minimum_msat: 0,
306 htlc_maximum_msat: OptionalField::Absent,
308 fee_proportional_millionths: 0,
314 pub struct TestRoutingMessageHandler {
315 pub chan_upds_recvd: AtomicUsize,
316 pub chan_anns_recvd: AtomicUsize,
317 pub chan_anns_sent: AtomicUsize,
318 pub request_full_sync: AtomicBool,
321 impl TestRoutingMessageHandler {
322 pub fn new() -> Self {
323 TestRoutingMessageHandler {
324 chan_upds_recvd: AtomicUsize::new(0),
325 chan_anns_recvd: AtomicUsize::new(0),
326 chan_anns_sent: AtomicUsize::new(0),
327 request_full_sync: AtomicBool::new(false),
331 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
332 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
333 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
335 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
336 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
337 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
339 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
340 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
341 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
343 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
344 let mut chan_anns = Vec::new();
345 const TOTAL_UPDS: u64 = 100;
346 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS - self.chan_anns_sent.load(Ordering::Acquire) as u64);
347 for i in starting_point..end {
348 let chan_upd_1 = get_dummy_channel_update(i);
349 let chan_upd_2 = get_dummy_channel_update(i);
350 let chan_ann = get_dummy_channel_announcement(i);
352 chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
355 self.chan_anns_sent.fetch_add(chan_anns.len(), Ordering::AcqRel);
359 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
363 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
365 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
369 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
373 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
377 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
382 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
383 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
388 pub struct TestLogger {
391 pub lines: Mutex<HashMap<(String, String), usize>>,
395 pub fn new() -> TestLogger {
396 Self::with_id("".to_owned())
398 pub fn with_id(id: String) -> TestLogger {
402 lines: Mutex::new(HashMap::new())
405 pub fn enable(&mut self, level: Level) {
408 pub fn assert_log(&self, module: String, line: String, count: usize) {
409 let log_entries = self.lines.lock().unwrap();
410 assert_eq!(log_entries.get(&(module, line)), Some(&count));
413 /// Search for the number of occurrence of the logged lines which
414 /// 1. belongs to the specified module and
415 /// 2. contains `line` in it.
416 /// And asserts if the number of occurrences is the same with the given `count`
417 pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
418 let log_entries = self.lines.lock().unwrap();
419 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
420 m == &module && l.contains(line.as_str())
421 }).map(|(_, c) | { c }).sum();
425 /// Search for the number of occurrences of logged lines which
426 /// 1. belong to the specified module and
427 /// 2. match the given regex pattern.
428 /// Assert that the number of occurrences equals the given `count`
429 pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
430 let log_entries = self.lines.lock().unwrap();
431 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
432 m == &module && pattern.is_match(&l)
433 }).map(|(_, c) | { c }).sum();
438 impl Logger for TestLogger {
439 fn log(&self, record: &Record) {
440 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
441 if record.level >= self.level {
442 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
447 pub struct TestKeysInterface {
448 pub backing: keysinterface::KeysManager,
449 pub override_session_priv: Mutex<Option<[u8; 32]>>,
450 pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
451 pub disable_revocation_policy_check: bool,
452 enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
453 expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
456 impl keysinterface::KeysInterface for TestKeysInterface {
457 type Signer = EnforcingSigner;
459 fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
460 fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
462 fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
463 match &mut *self.expectations.lock().unwrap() {
464 None => self.backing.get_shutdown_scriptpubkey(),
465 Some(expectations) => match expectations.pop_front() {
466 None => panic!("Unexpected get_shutdown_scriptpubkey"),
467 Some(expectation) => expectation.returns,
472 fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
473 let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis);
474 let state = self.make_enforcement_state_cell(keys.commitment_seed);
475 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
478 fn get_secure_random_bytes(&self) -> [u8; 32] {
479 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
480 let override_session_key = self.override_session_priv.lock().unwrap();
481 if override_channel_id.is_some() && override_session_key.is_some() {
482 panic!("We don't know which override key to use!");
484 if let Some(key) = &*override_channel_id {
487 if let Some(key) = &*override_session_key {
490 self.backing.get_secure_random_bytes()
493 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
494 let mut reader = io::Cursor::new(buffer);
496 let inner: InMemorySigner = Readable::read(&mut reader)?;
497 let state = self.make_enforcement_state_cell(inner.commitment_seed);
499 Ok(EnforcingSigner::new_with_revoked(
502 self.disable_revocation_policy_check
506 fn sign_invoice(&self, invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
507 self.backing.sign_invoice(invoice_preimage)
511 impl TestKeysInterface {
512 pub fn new(seed: &[u8; 32], network: Network) -> Self {
513 let now = Duration::from_secs(genesis_block(network).header.time as u64);
515 backing: keysinterface::KeysManager::new(seed, now.as_secs(), now.subsec_nanos()),
516 override_session_priv: Mutex::new(None),
517 override_channel_id_priv: Mutex::new(None),
518 disable_revocation_policy_check: false,
519 enforcement_states: Mutex::new(HashMap::new()),
520 expectations: Mutex::new(None),
524 /// Sets an expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] is
526 pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
527 self.expectations.lock().unwrap()
528 .get_or_insert_with(|| VecDeque::new())
529 .push_back(expectation);
533 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
534 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
535 let state = self.make_enforcement_state_cell(keys.commitment_seed);
536 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
539 fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
540 let mut states = self.enforcement_states.lock().unwrap();
541 if !states.contains_key(&commitment_seed) {
542 let state = EnforcementState::new();
543 states.insert(commitment_seed, Arc::new(Mutex::new(state)));
545 let cell = states.get(&commitment_seed).unwrap();
550 impl Drop for TestKeysInterface {
552 if std::thread::panicking() {
556 if let Some(expectations) = &*self.expectations.lock().unwrap() {
557 if !expectations.is_empty() {
558 panic!("Unsatisfied expectations: {:?}", expectations);
564 /// An expectation that [`keysinterface::KeysInterface::get_shutdown_scriptpubkey`] was called and
565 /// returns a [`ShutdownScript`].
566 pub struct OnGetShutdownScriptpubkey {
567 /// A shutdown script used to close a channel.
568 pub returns: ShutdownScript,
571 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
572 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
573 f.debug_struct("OnGetShutdownScriptpubkey").finish()
577 pub struct TestChainSource {
578 pub genesis_hash: BlockHash,
579 pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
580 pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
581 pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
582 expectations: Mutex<Option<VecDeque<OnRegisterOutput>>>,
585 impl TestChainSource {
586 pub fn new(network: Network) -> Self {
587 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
589 genesis_hash: genesis_block(network).block_hash(),
590 utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
591 watched_txn: Mutex::new(HashSet::new()),
592 watched_outputs: Mutex::new(HashSet::new()),
593 expectations: Mutex::new(None),
597 /// Sets an expectation that [`chain::Filter::register_output`] is called.
598 pub fn expect(&self, expectation: OnRegisterOutput) -> &Self {
599 self.expectations.lock().unwrap()
600 .get_or_insert_with(|| VecDeque::new())
601 .push_back(expectation);
606 impl chain::Access for TestChainSource {
607 fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
608 if self.genesis_hash != *genesis_hash {
609 return Err(chain::AccessError::UnknownChain);
612 self.utxo_ret.lock().unwrap().clone()
616 impl chain::Filter for TestChainSource {
617 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
618 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
621 fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> {
622 let dependent_tx = match &mut *self.expectations.lock().unwrap() {
624 Some(expectations) => match expectations.pop_front() {
626 panic!("Unexpected register_output: {:?}",
627 (output.outpoint, output.script_pubkey));
629 Some(expectation) => {
630 assert_eq!(output.outpoint, expectation.outpoint());
631 assert_eq!(&output.script_pubkey, expectation.script_pubkey());
637 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
642 impl Drop for TestChainSource {
644 if std::thread::panicking() {
648 if let Some(expectations) = &*self.expectations.lock().unwrap() {
649 if !expectations.is_empty() {
650 panic!("Unsatisfied expectations: {:?}", expectations);
656 /// An expectation that [`chain::Filter::register_output`] was called with a transaction output and
657 /// returns an optional dependent transaction that spends the output in the same block.
658 pub struct OnRegisterOutput {
659 /// The transaction output to register.
660 pub with: TxOutReference,
662 /// A dependent transaction spending the output along with its position in the block.
663 pub returns: Option<(usize, Transaction)>,
666 /// A transaction output as identified by an index into a transaction's output list.
667 pub struct TxOutReference(pub Transaction, pub usize);
669 impl OnRegisterOutput {
670 fn outpoint(&self) -> OutPoint {
671 let txid = self.with.0.txid();
672 let index = self.with.1 as u16;
673 OutPoint { txid, index }
676 fn script_pubkey(&self) -> &Script {
677 let index = self.with.1;
678 &self.with.0.output[index].script_pubkey
682 impl core::fmt::Debug for OnRegisterOutput {
683 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
684 f.debug_struct("OnRegisterOutput")
685 .field("outpoint", &self.outpoint())
686 .field("script_pubkey", self.script_pubkey())