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::channelmonitor;
16 use chain::channelmonitor::MonitorEvent;
17 use chain::transaction::OutPoint;
18 use chain::keysinterface;
19 use ln::features::{ChannelFeatures, InitFeatures};
21 use ln::msgs::OptionalField;
22 use util::enforcing_trait_impls::{EnforcingSigner, INITIAL_REVOKED_COMMITMENT_NUMBER};
24 use util::logger::{Logger, Level, Record};
25 use util::ser::{Readable, ReadableArgs, Writer, Writeable};
27 use bitcoin::blockdata::constants::genesis_block;
28 use bitcoin::blockdata::transaction::{Transaction, TxOut};
29 use bitcoin::blockdata::script::{Builder, Script};
30 use bitcoin::blockdata::opcodes;
31 use bitcoin::blockdata::block::BlockHeader;
32 use bitcoin::network::constants::Network;
33 use bitcoin::hash_types::{BlockHash, Txid};
35 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
36 use bitcoin::secp256k1::recovery::RecoverableSignature;
41 use core::time::Duration;
42 use std::sync::{Mutex, Arc};
43 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
45 use std::collections::{HashMap, HashSet, VecDeque};
46 use chain::keysinterface::InMemorySigner;
48 pub struct TestVecWriter(pub Vec<u8>);
49 impl Writer for TestVecWriter {
50 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
51 self.0.extend_from_slice(buf);
54 fn size_hint(&mut self, size: usize) {
55 self.0.reserve_exact(size);
59 pub struct TestFeeEstimator {
62 impl chaininterface::FeeEstimator for TestFeeEstimator {
63 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
68 pub struct OnlyReadsKeysInterface {}
69 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
70 type Signer = EnforcingSigner;
72 fn get_node_secret(&self) -> SecretKey { unreachable!(); }
73 fn get_destination_script(&self) -> Script { unreachable!(); }
74 fn get_shutdown_pubkey(&self) -> PublicKey { unreachable!(); }
75 fn get_channel_signer(&self, _inbound: bool, _channel_value_satoshis: u64) -> EnforcingSigner { unreachable!(); }
76 fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }
78 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
79 EnforcingSigner::read(&mut std::io::Cursor::new(reader))
81 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { unreachable!(); }
84 pub struct TestChainMonitor<'a> {
85 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
86 pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64)>>,
87 pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a channelmonitor::Persist<EnforcingSigner>>,
88 pub keys_manager: &'a TestKeysInterface,
89 pub update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
90 /// If this is set to Some(), after the next return, we'll always return this until update_ret
92 pub next_update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
93 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
94 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
96 pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
98 impl<'a> TestChainMonitor<'a> {
99 pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a channelmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
101 added_monitors: Mutex::new(Vec::new()),
102 latest_monitor_update_id: Mutex::new(HashMap::new()),
103 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
105 update_ret: Mutex::new(None),
106 next_update_ret: Mutex::new(None),
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<(), channelmonitor::ChannelMonitorUpdateErr> {
113 // At every point where we get a monitor update, we should be able to send a useful monitor
114 // to a watchtower and disk...
115 let mut w = TestVecWriter(Vec::new());
116 monitor.write(&mut w).unwrap();
117 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
118 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
119 assert!(new_monitor == monitor);
120 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id()));
121 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
122 let watch_res = self.chain_monitor.watch_channel(funding_txo, new_monitor);
124 let ret = self.update_ret.lock().unwrap().clone();
125 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
126 *self.update_ret.lock().unwrap() = Some(next_ret);
129 assert!(watch_res.is_ok());
135 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
136 // Every monitor update should survive roundtrip
137 let mut w = TestVecWriter(Vec::new());
138 update.write(&mut w).unwrap();
139 assert!(channelmonitor::ChannelMonitorUpdate::read(
140 &mut ::std::io::Cursor::new(&w.0)).unwrap() == update);
142 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
143 assert_eq!(funding_txo.to_channel_id(), exp.0);
144 assert_eq!(update.updates.len(), 1);
145 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
146 assert_eq!(should_broadcast, exp.1);
150 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, update.update_id));
151 let update_res = self.chain_monitor.update_channel(funding_txo, update);
152 // At every point where we get a monitor update, we should be able to send a useful monitor
153 // to a watchtower and disk...
154 let monitors = self.chain_monitor.monitors.read().unwrap();
155 let monitor = monitors.get(&funding_txo).unwrap();
157 monitor.write(&mut w).unwrap();
158 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
159 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
160 assert!(new_monitor == *monitor);
161 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
163 let ret = self.update_ret.lock().unwrap().clone();
164 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
165 *self.update_ret.lock().unwrap() = Some(next_ret);
168 assert!(update_res.is_ok());
174 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
175 return self.chain_monitor.release_pending_monitor_events();
179 pub struct TestPersister {
180 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>
183 pub fn new() -> Self {
185 update_ret: Mutex::new(Ok(()))
189 pub fn set_update_ret(&self, ret: Result<(), channelmonitor::ChannelMonitorUpdateErr>) {
190 *self.update_ret.lock().unwrap() = ret;
193 impl<Signer: keysinterface::Sign> channelmonitor::Persist<Signer> for TestPersister {
194 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
195 self.update_ret.lock().unwrap().clone()
198 fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor<Signer>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
199 self.update_ret.lock().unwrap().clone()
203 pub struct TestBroadcaster {
204 pub txn_broadcasted: Mutex<Vec<Transaction>>,
205 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
207 impl chaininterface::BroadcasterInterface for TestBroadcaster {
208 fn broadcast_transaction(&self, tx: &Transaction) {
209 self.txn_broadcasted.lock().unwrap().push(tx.clone());
213 pub struct TestChannelMessageHandler {
214 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
217 impl TestChannelMessageHandler {
218 pub fn new() -> Self {
219 TestChannelMessageHandler {
220 pending_events: Mutex::new(Vec::new()),
225 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
226 fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
227 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
228 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
229 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
230 fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
231 fn handle_shutdown(&self, _their_node_id: &PublicKey, _their_features: &InitFeatures, _msg: &msgs::Shutdown) {}
232 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
233 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
234 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
235 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
236 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
237 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
238 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
239 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
240 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
241 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
242 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
243 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
244 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
245 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
248 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
249 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
250 let mut pending_events = self.pending_events.lock().unwrap();
251 let mut ret = Vec::new();
252 mem::swap(&mut ret, &mut *pending_events);
257 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
258 use bitcoin::secp256k1::ffi::Signature as FFISignature;
259 let secp_ctx = Secp256k1::new();
260 let network = Network::Testnet;
261 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
262 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
263 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
264 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
265 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
266 features: ChannelFeatures::known(),
267 chain_hash: genesis_block(network).header.block_hash(),
268 short_channel_id: short_chan_id,
269 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
270 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
271 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
272 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
273 excess_data: Vec::new(),
277 msgs::ChannelAnnouncement {
278 node_signature_1: Signature::from(FFISignature::new()),
279 node_signature_2: Signature::from(FFISignature::new()),
280 bitcoin_signature_1: Signature::from(FFISignature::new()),
281 bitcoin_signature_2: Signature::from(FFISignature::new()),
282 contents: unsigned_ann,
287 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
288 use bitcoin::secp256k1::ffi::Signature as FFISignature;
289 let network = Network::Testnet;
290 msgs::ChannelUpdate {
291 signature: Signature::from(unsafe { FFISignature::new() }),
292 contents: msgs::UnsignedChannelUpdate {
293 chain_hash: genesis_block(network).header.block_hash(),
294 short_channel_id: short_chan_id,
297 cltv_expiry_delta: 0,
298 htlc_minimum_msat: 0,
299 htlc_maximum_msat: OptionalField::Absent,
301 fee_proportional_millionths: 0,
307 pub struct TestRoutingMessageHandler {
308 pub chan_upds_recvd: AtomicUsize,
309 pub chan_anns_recvd: AtomicUsize,
310 pub chan_anns_sent: AtomicUsize,
311 pub request_full_sync: AtomicBool,
314 impl TestRoutingMessageHandler {
315 pub fn new() -> Self {
316 TestRoutingMessageHandler {
317 chan_upds_recvd: AtomicUsize::new(0),
318 chan_anns_recvd: AtomicUsize::new(0),
319 chan_anns_sent: AtomicUsize::new(0),
320 request_full_sync: AtomicBool::new(false),
324 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
325 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
326 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
328 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
329 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
330 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
332 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
333 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
334 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
336 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
337 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
338 let mut chan_anns = Vec::new();
339 const TOTAL_UPDS: u64 = 100;
340 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS - self.chan_anns_sent.load(Ordering::Acquire) as u64);
341 for i in starting_point..end {
342 let chan_upd_1 = get_dummy_channel_update(i);
343 let chan_upd_2 = get_dummy_channel_update(i);
344 let chan_ann = get_dummy_channel_announcement(i);
346 chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
349 self.chan_anns_sent.fetch_add(chan_anns.len(), Ordering::AcqRel);
353 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
357 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
359 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
363 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
367 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
371 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
376 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
377 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
382 pub struct TestLogger {
385 pub lines: Mutex<HashMap<(String, String), usize>>,
389 pub fn new() -> TestLogger {
390 Self::with_id("".to_owned())
392 pub fn with_id(id: String) -> TestLogger {
396 lines: Mutex::new(HashMap::new())
399 pub fn enable(&mut self, level: Level) {
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));
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();
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();
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 self.level >= record.level {
436 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
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 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
449 impl keysinterface::KeysInterface for TestKeysInterface {
450 type Signer = EnforcingSigner;
452 fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
453 fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
454 fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
455 fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
456 let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis);
457 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
458 EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check)
461 fn get_secure_random_bytes(&self) -> [u8; 32] {
462 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
463 let override_session_key = self.override_session_priv.lock().unwrap();
464 if override_channel_id.is_some() && override_session_key.is_some() {
465 panic!("We don't know which override key to use!");
467 if let Some(key) = &*override_channel_id {
470 if let Some(key) = &*override_session_key {
473 self.backing.get_secure_random_bytes()
476 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
477 let mut reader = std::io::Cursor::new(buffer);
479 let inner: InMemorySigner = Readable::read(&mut reader)?;
480 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
482 let last_commitment_number = Readable::read(&mut reader)?;
486 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
488 disable_revocation_policy_check: self.disable_revocation_policy_check,
492 fn sign_invoice(&self, invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
493 self.backing.sign_invoice(invoice_preimage)
498 impl TestKeysInterface {
499 pub fn new(seed: &[u8; 32], network: Network) -> Self {
500 let now = Duration::from_secs(genesis_block(network).header.time as u64);
502 backing: keysinterface::KeysManager::new(seed, now.as_secs(), now.subsec_nanos()),
503 override_session_priv: Mutex::new(None),
504 override_channel_id_priv: Mutex::new(None),
505 disable_revocation_policy_check: false,
506 revoked_commitments: Mutex::new(HashMap::new()),
509 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
510 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
511 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
512 EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check)
515 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
516 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
517 if !revoked_commitments.contains_key(&commitment_seed) {
518 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
520 let cell = revoked_commitments.get(&commitment_seed).unwrap();
525 pub struct TestChainSource {
526 pub genesis_hash: BlockHash,
527 pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
528 pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
529 pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
530 expectations: Mutex<Option<VecDeque<OnRegisterOutput>>>,
533 impl TestChainSource {
534 pub fn new(network: Network) -> Self {
535 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
537 genesis_hash: genesis_block(network).block_hash(),
538 utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
539 watched_txn: Mutex::new(HashSet::new()),
540 watched_outputs: Mutex::new(HashSet::new()),
541 expectations: Mutex::new(None),
545 /// Sets an expectation that [`chain::Filter::register_output`] is called.
546 pub fn expect(&self, expectation: OnRegisterOutput) -> &Self {
547 self.expectations.lock().unwrap()
548 .get_or_insert_with(|| VecDeque::new())
549 .push_back(expectation);
554 impl chain::Access for TestChainSource {
555 fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
556 if self.genesis_hash != *genesis_hash {
557 return Err(chain::AccessError::UnknownChain);
560 self.utxo_ret.lock().unwrap().clone()
564 impl chain::Filter for TestChainSource {
565 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
566 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
569 fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> {
570 let dependent_tx = match &mut *self.expectations.lock().unwrap() {
572 Some(expectations) => match expectations.pop_front() {
574 panic!("Unexpected register_output: {:?}",
575 (output.outpoint, output.script_pubkey));
577 Some(expectation) => {
578 assert_eq!(output.outpoint, expectation.outpoint());
579 assert_eq!(&output.script_pubkey, expectation.script_pubkey());
585 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
590 impl Drop for TestChainSource {
592 if std::thread::panicking() {
596 if let Some(expectations) = &*self.expectations.lock().unwrap() {
597 if !expectations.is_empty() {
598 panic!("Unsatisfied expectations: {:?}", expectations);
604 /// An expectation that [`chain::Filter::register_output`] was called with a transaction output and
605 /// returns an optional dependent transaction that spends the output in the same block.
606 pub struct OnRegisterOutput {
607 /// The transaction output to register.
608 pub with: TxOutReference,
610 /// A dependent transaction spending the output along with its position in the block.
611 pub returns: Option<(usize, Transaction)>,
614 /// A transaction output as identified by an index into a transaction's output list.
615 pub struct TxOutReference(pub Transaction, pub usize);
617 impl OnRegisterOutput {
618 fn outpoint(&self) -> OutPoint {
619 let txid = self.with.0.txid();
620 let index = self.with.1 as u16;
621 OutPoint { txid, index }
624 fn script_pubkey(&self) -> &Script {
625 let index = self.with.1;
626 &self.with.0.output[index].script_pubkey
630 impl core::fmt::Debug for OnRegisterOutput {
631 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
632 f.debug_struct("OnRegisterOutput")
633 .field("outpoint", &self.outpoint())
634 .field("script_pubkey", self.script_pubkey())