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::network::constants::Network;
32 use bitcoin::hash_types::{BlockHash, Txid};
34 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
35 use bitcoin::secp256k1::recovery::RecoverableSignature;
39 use core::time::Duration;
40 use std::sync::{Mutex, Arc};
41 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
43 use std::collections::{HashMap, HashSet, VecDeque};
44 use chain::keysinterface::InMemorySigner;
46 pub struct TestVecWriter(pub Vec<u8>);
47 impl Writer for TestVecWriter {
48 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
49 self.0.extend_from_slice(buf);
52 fn size_hint(&mut self, size: usize) {
53 self.0.reserve_exact(size);
57 pub struct TestFeeEstimator {
60 impl chaininterface::FeeEstimator for TestFeeEstimator {
61 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
66 pub struct OnlyReadsKeysInterface {}
67 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
68 type Signer = EnforcingSigner;
70 fn get_node_secret(&self) -> SecretKey { unreachable!(); }
71 fn get_destination_script(&self) -> Script { unreachable!(); }
72 fn get_shutdown_pubkey(&self) -> PublicKey { 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] }
76 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
77 EnforcingSigner::read(&mut std::io::Cursor::new(reader))
79 fn sign_invoice(&self, _invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> { unreachable!(); }
82 pub struct TestChainMonitor<'a> {
83 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
84 pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64)>>,
85 pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a channelmonitor::Persist<EnforcingSigner>>,
86 pub keys_manager: &'a TestKeysInterface,
87 pub update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
88 /// If this is set to Some(), after the next return, we'll always return this until update_ret
90 pub next_update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
91 /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
92 /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
94 pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
96 impl<'a> TestChainMonitor<'a> {
97 pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a channelmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
99 added_monitors: Mutex::new(Vec::new()),
100 latest_monitor_update_id: Mutex::new(HashMap::new()),
101 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
103 update_ret: Mutex::new(None),
104 next_update_ret: Mutex::new(None),
105 expect_channel_force_closed: Mutex::new(None),
109 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
110 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
111 // At every point where we get a monitor update, we should be able to send a useful monitor
112 // to a watchtower and disk...
113 let mut w = TestVecWriter(Vec::new());
114 monitor.write(&mut w).unwrap();
115 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
116 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
117 assert!(new_monitor == monitor);
118 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id()));
119 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
120 let watch_res = self.chain_monitor.watch_channel(funding_txo, new_monitor);
122 let ret = self.update_ret.lock().unwrap().clone();
123 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
124 *self.update_ret.lock().unwrap() = Some(next_ret);
127 assert!(watch_res.is_ok());
133 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
134 // Every monitor update should survive roundtrip
135 let mut w = TestVecWriter(Vec::new());
136 update.write(&mut w).unwrap();
137 assert!(channelmonitor::ChannelMonitorUpdate::read(
138 &mut ::std::io::Cursor::new(&w.0)).unwrap() == update);
140 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
141 assert_eq!(funding_txo.to_channel_id(), exp.0);
142 assert_eq!(update.updates.len(), 1);
143 if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
144 assert_eq!(should_broadcast, exp.1);
148 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, update.update_id));
149 let update_res = self.chain_monitor.update_channel(funding_txo, update);
150 // At every point where we get a monitor update, we should be able to send a useful monitor
151 // to a watchtower and disk...
152 let monitors = self.chain_monitor.monitors.read().unwrap();
153 let monitor = monitors.get(&funding_txo).unwrap();
155 monitor.write(&mut w).unwrap();
156 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
157 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap().1;
158 assert!(new_monitor == *monitor);
159 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
161 let ret = self.update_ret.lock().unwrap().clone();
162 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
163 *self.update_ret.lock().unwrap() = Some(next_ret);
166 assert!(update_res.is_ok());
172 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
173 return self.chain_monitor.release_pending_monitor_events();
177 pub struct TestPersister {
178 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>
181 pub fn new() -> Self {
183 update_ret: Mutex::new(Ok(()))
187 pub fn set_update_ret(&self, ret: Result<(), channelmonitor::ChannelMonitorUpdateErr>) {
188 *self.update_ret.lock().unwrap() = ret;
191 impl<Signer: keysinterface::Sign> channelmonitor::Persist<Signer> for TestPersister {
192 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
193 self.update_ret.lock().unwrap().clone()
196 fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor<Signer>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
197 self.update_ret.lock().unwrap().clone()
201 pub struct TestBroadcaster {
202 pub txn_broadcasted: Mutex<Vec<Transaction>>,
204 impl chaininterface::BroadcasterInterface for TestBroadcaster {
205 fn broadcast_transaction(&self, tx: &Transaction) {
206 self.txn_broadcasted.lock().unwrap().push(tx.clone());
210 pub struct TestChannelMessageHandler {
211 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
214 impl TestChannelMessageHandler {
215 pub fn new() -> Self {
216 TestChannelMessageHandler {
217 pending_events: Mutex::new(Vec::new()),
222 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
223 fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
224 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
225 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
226 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
227 fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
228 fn handle_shutdown(&self, _their_node_id: &PublicKey, _their_features: &InitFeatures, _msg: &msgs::Shutdown) {}
229 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
230 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
231 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
232 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
233 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
234 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
235 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
236 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
237 fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {}
238 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
239 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
240 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
241 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
242 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
245 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
246 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
247 let mut pending_events = self.pending_events.lock().unwrap();
248 let mut ret = Vec::new();
249 mem::swap(&mut ret, &mut *pending_events);
254 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
255 use bitcoin::secp256k1::ffi::Signature as FFISignature;
256 let secp_ctx = Secp256k1::new();
257 let network = Network::Testnet;
258 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
259 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
260 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
261 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
262 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
263 features: ChannelFeatures::known(),
264 chain_hash: genesis_block(network).header.block_hash(),
265 short_channel_id: short_chan_id,
266 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
267 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
268 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
269 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
270 excess_data: Vec::new(),
274 msgs::ChannelAnnouncement {
275 node_signature_1: Signature::from(FFISignature::new()),
276 node_signature_2: Signature::from(FFISignature::new()),
277 bitcoin_signature_1: Signature::from(FFISignature::new()),
278 bitcoin_signature_2: Signature::from(FFISignature::new()),
279 contents: unsigned_ann,
284 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
285 use bitcoin::secp256k1::ffi::Signature as FFISignature;
286 let network = Network::Testnet;
287 msgs::ChannelUpdate {
288 signature: Signature::from(unsafe { FFISignature::new() }),
289 contents: msgs::UnsignedChannelUpdate {
290 chain_hash: genesis_block(network).header.block_hash(),
291 short_channel_id: short_chan_id,
294 cltv_expiry_delta: 0,
295 htlc_minimum_msat: 0,
296 htlc_maximum_msat: OptionalField::Absent,
298 fee_proportional_millionths: 0,
304 pub struct TestRoutingMessageHandler {
305 pub chan_upds_recvd: AtomicUsize,
306 pub chan_anns_recvd: AtomicUsize,
307 pub chan_anns_sent: AtomicUsize,
308 pub request_full_sync: AtomicBool,
311 impl TestRoutingMessageHandler {
312 pub fn new() -> Self {
313 TestRoutingMessageHandler {
314 chan_upds_recvd: AtomicUsize::new(0),
315 chan_anns_recvd: AtomicUsize::new(0),
316 chan_anns_sent: AtomicUsize::new(0),
317 request_full_sync: AtomicBool::new(false),
321 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
322 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
323 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
325 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
326 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
327 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
329 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
330 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
331 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
333 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
334 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
335 let mut chan_anns = Vec::new();
336 const TOTAL_UPDS: u64 = 100;
337 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS - self.chan_anns_sent.load(Ordering::Acquire) as u64);
338 for i in starting_point..end {
339 let chan_upd_1 = get_dummy_channel_update(i);
340 let chan_upd_2 = get_dummy_channel_update(i);
341 let chan_ann = get_dummy_channel_announcement(i);
343 chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
346 self.chan_anns_sent.fetch_add(chan_anns.len(), Ordering::AcqRel);
350 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
354 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
356 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
360 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
364 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
368 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
373 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
374 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
379 pub struct TestLogger {
382 pub lines: Mutex<HashMap<(String, String), usize>>,
386 pub fn new() -> TestLogger {
387 Self::with_id("".to_owned())
389 pub fn with_id(id: String) -> TestLogger {
393 lines: Mutex::new(HashMap::new())
396 pub fn enable(&mut self, level: Level) {
399 pub fn assert_log(&self, module: String, line: String, count: usize) {
400 let log_entries = self.lines.lock().unwrap();
401 assert_eq!(log_entries.get(&(module, line)), Some(&count));
404 /// Search for the number of occurrence of the logged lines which
405 /// 1. belongs to the specified module and
406 /// 2. contains `line` in it.
407 /// And asserts if the number of occurrences is the same with the given `count`
408 pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
409 let log_entries = self.lines.lock().unwrap();
410 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
411 m == &module && l.contains(line.as_str())
412 }).map(|(_, c) | { c }).sum();
416 /// Search for the number of occurrences of logged lines which
417 /// 1. belong to the specified module and
418 /// 2. match the given regex pattern.
419 /// Assert that the number of occurrences equals the given `count`
420 pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
421 let log_entries = self.lines.lock().unwrap();
422 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
423 m == &module && pattern.is_match(&l)
424 }).map(|(_, c) | { c }).sum();
429 impl Logger for TestLogger {
430 fn log(&self, record: &Record) {
431 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
432 if self.level >= record.level {
433 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
438 pub struct TestKeysInterface {
439 pub backing: keysinterface::KeysManager,
440 pub override_session_priv: Mutex<Option<[u8; 32]>>,
441 pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
442 pub disable_revocation_policy_check: bool,
443 revoked_commitments: Mutex<HashMap<[u8;32], Arc<Mutex<u64>>>>,
446 impl keysinterface::KeysInterface for TestKeysInterface {
447 type Signer = EnforcingSigner;
449 fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
450 fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
451 fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
452 fn get_channel_signer(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingSigner {
453 let keys = self.backing.get_channel_signer(inbound, channel_value_satoshis);
454 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
455 EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check)
458 fn get_secure_random_bytes(&self) -> [u8; 32] {
459 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
460 let override_session_key = self.override_session_priv.lock().unwrap();
461 if override_channel_id.is_some() && override_session_key.is_some() {
462 panic!("We don't know which override key to use!");
464 if let Some(key) = &*override_channel_id {
467 if let Some(key) = &*override_session_key {
470 self.backing.get_secure_random_bytes()
473 fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
474 let mut reader = std::io::Cursor::new(buffer);
476 let inner: InMemorySigner = Readable::read(&mut reader)?;
477 let revoked_commitment = self.make_revoked_commitment_cell(inner.commitment_seed);
479 let last_commitment_number = Readable::read(&mut reader)?;
483 last_commitment_number: Arc::new(Mutex::new(last_commitment_number)),
485 disable_revocation_policy_check: self.disable_revocation_policy_check,
489 fn sign_invoice(&self, invoice_preimage: Vec<u8>) -> Result<RecoverableSignature, ()> {
490 self.backing.sign_invoice(invoice_preimage)
495 impl TestKeysInterface {
496 pub fn new(seed: &[u8; 32], network: Network) -> Self {
497 let now = Duration::from_secs(genesis_block(network).header.time as u64);
499 backing: keysinterface::KeysManager::new(seed, now.as_secs(), now.subsec_nanos()),
500 override_session_priv: Mutex::new(None),
501 override_channel_id_priv: Mutex::new(None),
502 disable_revocation_policy_check: false,
503 revoked_commitments: Mutex::new(HashMap::new()),
506 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
507 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
508 let revoked_commitment = self.make_revoked_commitment_cell(keys.commitment_seed);
509 EnforcingSigner::new_with_revoked(keys, revoked_commitment, self.disable_revocation_policy_check)
512 fn make_revoked_commitment_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<u64>> {
513 let mut revoked_commitments = self.revoked_commitments.lock().unwrap();
514 if !revoked_commitments.contains_key(&commitment_seed) {
515 revoked_commitments.insert(commitment_seed, Arc::new(Mutex::new(INITIAL_REVOKED_COMMITMENT_NUMBER)));
517 let cell = revoked_commitments.get(&commitment_seed).unwrap();
522 pub struct TestChainSource {
523 pub genesis_hash: BlockHash,
524 pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
525 pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
526 pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
527 expectations: Mutex<Option<VecDeque<OnRegisterOutput>>>,
530 impl TestChainSource {
531 pub fn new(network: Network) -> Self {
532 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
534 genesis_hash: genesis_block(network).block_hash(),
535 utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
536 watched_txn: Mutex::new(HashSet::new()),
537 watched_outputs: Mutex::new(HashSet::new()),
538 expectations: Mutex::new(None),
542 /// Sets an expectation that [`chain::Filter::register_output`] is called.
543 pub fn expect(&self, expectation: OnRegisterOutput) -> &Self {
544 self.expectations.lock().unwrap()
545 .get_or_insert_with(|| VecDeque::new())
546 .push_back(expectation);
551 impl chain::Access for TestChainSource {
552 fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
553 if self.genesis_hash != *genesis_hash {
554 return Err(chain::AccessError::UnknownChain);
557 self.utxo_ret.lock().unwrap().clone()
561 impl chain::Filter for TestChainSource {
562 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
563 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
566 fn register_output(&self, output: WatchedOutput) -> Option<(usize, Transaction)> {
567 let dependent_tx = match &mut *self.expectations.lock().unwrap() {
569 Some(expectations) => match expectations.pop_front() {
571 panic!("Unexpected register_output: {:?}",
572 (output.outpoint, output.script_pubkey));
574 Some(expectation) => {
575 assert_eq!(output.outpoint, expectation.outpoint());
576 assert_eq!(&output.script_pubkey, expectation.script_pubkey());
582 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
587 impl Drop for TestChainSource {
589 if std::thread::panicking() {
593 if let Some(expectations) = &*self.expectations.lock().unwrap() {
594 if !expectations.is_empty() {
595 panic!("Unsatisfied expectations: {:?}", expectations);
601 /// An expectation that [`chain::Filter::register_output`] was called with a transaction output and
602 /// returns an optional dependent transaction that spends the output in the same block.
603 pub struct OnRegisterOutput {
604 /// The transaction output to register.
605 pub with: TxOutReference,
607 /// A dependent transaction spending the output along with its position in the block.
608 pub returns: Option<(usize, Transaction)>,
611 /// A transaction output as identified by an index into a transaction's output list.
612 pub struct TxOutReference(pub Transaction, pub usize);
614 impl OnRegisterOutput {
615 fn outpoint(&self) -> OutPoint {
616 let txid = self.with.0.txid();
617 let index = self.with.1 as u16;
618 OutPoint { txid, index }
621 fn script_pubkey(&self) -> &Script {
622 let index = self.with.1;
623 &self.with.0.output[index].script_pubkey
627 impl core::fmt::Debug for OnRegisterOutput {
628 fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
629 f.debug_struct("OnRegisterOutput")
630 .field("outpoint", &self.outpoint())
631 .field("script_pubkey", self.script_pubkey())