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::chaininterface;
12 use chain::chaininterface::ConfirmationTarget;
13 use chain::chainmonitor;
14 use chain::channelmonitor;
15 use chain::channelmonitor::MonitorEvent;
16 use chain::transaction::OutPoint;
17 use chain::keysinterface;
18 use ln::features::{ChannelFeatures, InitFeatures};
20 use ln::msgs::OptionalField;
21 use util::enforcing_trait_impls::EnforcingChannelKeys;
23 use util::logger::{Logger, Level, Record};
24 use util::ser::{Readable, ReadableArgs, Writer, Writeable};
26 use bitcoin::blockdata::constants::genesis_block;
27 use bitcoin::blockdata::transaction::{Transaction, TxOut};
28 use bitcoin::blockdata::script::{Builder, Script};
29 use bitcoin::blockdata::opcodes;
30 use bitcoin::network::constants::Network;
31 use bitcoin::hash_types::{BlockHash, Txid};
33 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
37 use std::time::Duration;
39 use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
41 use std::collections::{HashMap, HashSet};
43 pub struct TestVecWriter(pub Vec<u8>);
44 impl Writer for TestVecWriter {
45 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
46 self.0.extend_from_slice(buf);
49 fn size_hint(&mut self, size: usize) {
50 self.0.reserve_exact(size);
54 pub struct TestFeeEstimator {
57 impl chaininterface::FeeEstimator for TestFeeEstimator {
58 fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
63 pub struct OnlyReadsKeysInterface {}
64 impl keysinterface::KeysInterface for OnlyReadsKeysInterface {
65 type ChanKeySigner = EnforcingChannelKeys;
67 fn get_node_secret(&self) -> SecretKey { unreachable!(); }
68 fn get_destination_script(&self) -> Script { unreachable!(); }
69 fn get_shutdown_pubkey(&self) -> PublicKey { unreachable!(); }
70 fn get_channel_keys(&self, _inbound: bool, _channel_value_satoshis: u64) -> EnforcingChannelKeys { unreachable!(); }
71 fn get_secure_random_bytes(&self) -> [u8; 32] { unreachable!(); }
73 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::ChanKeySigner, msgs::DecodeError> {
74 EnforcingChannelKeys::read(&mut std::io::Cursor::new(reader))
78 pub struct TestChainMonitor<'a> {
79 pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>>,
80 pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64)>>,
81 pub chain_monitor: chainmonitor::ChainMonitor<EnforcingChannelKeys, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a channelmonitor::Persist<EnforcingChannelKeys>>,
82 pub update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
83 // If this is set to Some(), after the next return, we'll always return this until update_ret
85 pub next_update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
87 impl<'a> TestChainMonitor<'a> {
88 pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a channelmonitor::Persist<EnforcingChannelKeys>) -> Self {
90 added_monitors: Mutex::new(Vec::new()),
91 latest_monitor_update_id: Mutex::new(HashMap::new()),
92 chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
93 update_ret: Mutex::new(None),
94 next_update_ret: Mutex::new(None),
98 impl<'a> chain::Watch for TestChainMonitor<'a> {
99 type Keys = EnforcingChannelKeys;
101 fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
102 // At every point where we get a monitor update, we should be able to send a useful monitor
103 // to a watchtower and disk...
104 let mut w = TestVecWriter(Vec::new());
105 monitor.write(&mut w).unwrap();
106 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
107 &mut ::std::io::Cursor::new(&w.0), &OnlyReadsKeysInterface {}).unwrap().1;
108 assert!(new_monitor == monitor);
109 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id()));
110 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
111 let watch_res = self.chain_monitor.watch_channel(funding_txo, new_monitor);
113 let ret = self.update_ret.lock().unwrap().clone();
114 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
115 *self.update_ret.lock().unwrap() = Some(next_ret);
118 assert!(watch_res.is_ok());
124 fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::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 ::std::io::Cursor::new(&w.0)).unwrap() == update);
131 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, update.update_id));
132 let update_res = self.chain_monitor.update_channel(funding_txo, update);
133 // At every point where we get a monitor update, we should be able to send a useful monitor
134 // to a watchtower and disk...
135 let monitors = self.chain_monitor.monitors.lock().unwrap();
136 let monitor = monitors.get(&funding_txo).unwrap();
138 monitor.write(&mut w).unwrap();
139 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
140 &mut ::std::io::Cursor::new(&w.0), &OnlyReadsKeysInterface {}).unwrap().1;
141 assert!(new_monitor == *monitor);
142 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
144 let ret = self.update_ret.lock().unwrap().clone();
145 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
146 *self.update_ret.lock().unwrap() = Some(next_ret);
149 assert!(update_res.is_ok());
155 fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
156 return self.chain_monitor.release_pending_monitor_events();
160 pub struct TestPersister {
161 pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>
164 pub fn new() -> Self {
166 update_ret: Mutex::new(Ok(()))
170 pub fn set_update_ret(&self, ret: Result<(), channelmonitor::ChannelMonitorUpdateErr>) {
171 *self.update_ret.lock().unwrap() = ret;
174 impl channelmonitor::Persist<EnforcingChannelKeys> for TestPersister {
175 fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
176 self.update_ret.lock().unwrap().clone()
179 fn update_persisted_channel(&self, _funding_txo: OutPoint, _update: &channelmonitor::ChannelMonitorUpdate, _data: &channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
180 self.update_ret.lock().unwrap().clone()
184 pub struct TestBroadcaster {
185 pub txn_broadcasted: Mutex<Vec<Transaction>>,
187 impl chaininterface::BroadcasterInterface for TestBroadcaster {
188 fn broadcast_transaction(&self, tx: &Transaction) {
189 self.txn_broadcasted.lock().unwrap().push(tx.clone());
193 pub struct TestChannelMessageHandler {
194 pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
197 impl TestChannelMessageHandler {
198 pub fn new() -> Self {
199 TestChannelMessageHandler {
200 pending_events: Mutex::new(Vec::new()),
205 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
206 fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
207 fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
208 fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
209 fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
210 fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
211 fn handle_shutdown(&self, _their_node_id: &PublicKey, _msg: &msgs::Shutdown) {}
212 fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
213 fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
214 fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
215 fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
216 fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
217 fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
218 fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
219 fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
220 fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
221 fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
222 fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
223 fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
224 fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
227 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
228 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
229 let mut pending_events = self.pending_events.lock().unwrap();
230 let mut ret = Vec::new();
231 mem::swap(&mut ret, &mut *pending_events);
236 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
237 use bitcoin::secp256k1::ffi::Signature as FFISignature;
238 let secp_ctx = Secp256k1::new();
239 let network = Network::Testnet;
240 let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
241 let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
242 let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
243 let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
244 let unsigned_ann = msgs::UnsignedChannelAnnouncement {
245 features: ChannelFeatures::known(),
246 chain_hash: genesis_block(network).header.block_hash(),
247 short_channel_id: short_chan_id,
248 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
249 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
250 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
251 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
252 excess_data: Vec::new(),
255 msgs::ChannelAnnouncement {
256 node_signature_1: Signature::from(FFISignature::new()),
257 node_signature_2: Signature::from(FFISignature::new()),
258 bitcoin_signature_1: Signature::from(FFISignature::new()),
259 bitcoin_signature_2: Signature::from(FFISignature::new()),
260 contents: unsigned_ann,
264 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
265 use bitcoin::secp256k1::ffi::Signature as FFISignature;
266 let network = Network::Testnet;
267 msgs::ChannelUpdate {
268 signature: Signature::from(FFISignature::new()),
269 contents: msgs::UnsignedChannelUpdate {
270 chain_hash: genesis_block(network).header.block_hash(),
271 short_channel_id: short_chan_id,
274 cltv_expiry_delta: 0,
275 htlc_minimum_msat: 0,
276 htlc_maximum_msat: OptionalField::Absent,
278 fee_proportional_millionths: 0,
284 pub struct TestRoutingMessageHandler {
285 pub chan_upds_recvd: AtomicUsize,
286 pub chan_anns_recvd: AtomicUsize,
287 pub chan_anns_sent: AtomicUsize,
288 pub request_full_sync: AtomicBool,
291 impl TestRoutingMessageHandler {
292 pub fn new() -> Self {
293 TestRoutingMessageHandler {
294 chan_upds_recvd: AtomicUsize::new(0),
295 chan_anns_recvd: AtomicUsize::new(0),
296 chan_anns_sent: AtomicUsize::new(0),
297 request_full_sync: AtomicBool::new(false),
301 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
302 fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
303 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
305 fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
306 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
307 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
309 fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
310 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
311 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
313 fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
314 fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
315 let mut chan_anns = Vec::new();
316 const TOTAL_UPDS: u64 = 100;
317 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS - self.chan_anns_sent.load(Ordering::Acquire) as u64);
318 for i in starting_point..end {
319 let chan_upd_1 = get_dummy_channel_update(i);
320 let chan_upd_2 = get_dummy_channel_update(i);
321 let chan_ann = get_dummy_channel_announcement(i);
323 chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
326 self.chan_anns_sent.fetch_add(chan_anns.len(), Ordering::AcqRel);
330 fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
334 fn sync_routing_table(&self, _their_node_id: &PublicKey, _init_msg: &msgs::Init) {}
336 fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
340 fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
344 fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
348 fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
353 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
354 fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
359 pub struct TestLogger {
362 pub lines: Mutex<HashMap<(String, String), usize>>,
366 pub fn new() -> TestLogger {
367 Self::with_id("".to_owned())
369 pub fn with_id(id: String) -> TestLogger {
373 lines: Mutex::new(HashMap::new())
376 pub fn enable(&mut self, level: Level) {
379 pub fn assert_log(&self, module: String, line: String, count: usize) {
380 let log_entries = self.lines.lock().unwrap();
381 assert_eq!(log_entries.get(&(module, line)), Some(&count));
384 /// Search for the number of occurrence of the logged lines which
385 /// 1. belongs to the specified module and
386 /// 2. contains `line` in it.
387 /// And asserts if the number of occurrences is the same with the given `count`
388 pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
389 let log_entries = self.lines.lock().unwrap();
390 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
391 m == &module && l.contains(line.as_str())
392 }).map(|(_, c) | { c }).sum();
396 /// Search for the number of occurrences of logged lines which
397 /// 1. belong to the specified module and
398 /// 2. match the given regex pattern.
399 /// Assert that the number of occurrences equals the given `count`
400 pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
401 let log_entries = self.lines.lock().unwrap();
402 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
403 m == &module && pattern.is_match(&l)
404 }).map(|(_, c) | { c }).sum();
409 impl Logger for TestLogger {
410 fn log(&self, record: &Record) {
411 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
412 if self.level >= record.level {
413 println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
418 pub struct TestKeysInterface {
419 backing: keysinterface::KeysManager,
420 pub override_session_priv: Mutex<Option<[u8; 32]>>,
421 pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
424 impl keysinterface::KeysInterface for TestKeysInterface {
425 type ChanKeySigner = EnforcingChannelKeys;
427 fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
428 fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
429 fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
430 fn get_channel_keys(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
431 EnforcingChannelKeys::new(self.backing.get_channel_keys(inbound, channel_value_satoshis))
434 fn get_secure_random_bytes(&self) -> [u8; 32] {
435 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
436 let override_session_key = self.override_session_priv.lock().unwrap();
437 if override_channel_id.is_some() && override_session_key.is_some() {
438 panic!("We don't know which override key to use!");
440 if let Some(key) = &*override_channel_id {
443 if let Some(key) = &*override_session_key {
446 self.backing.get_secure_random_bytes()
449 fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::ChanKeySigner, msgs::DecodeError> {
450 EnforcingChannelKeys::read(&mut std::io::Cursor::new(reader))
454 impl TestKeysInterface {
455 pub fn new(seed: &[u8; 32], network: Network) -> Self {
456 let now = Duration::from_secs(genesis_block(network).header.time as u64);
458 backing: keysinterface::KeysManager::new(seed, network, now.as_secs(), now.subsec_nanos()),
459 override_session_priv: Mutex::new(None),
460 override_channel_id_priv: Mutex::new(None),
463 pub fn derive_channel_keys(&self, channel_value_satoshis: u64, user_id_1: u64, user_id_2: u64) -> EnforcingChannelKeys {
464 EnforcingChannelKeys::new(self.backing.derive_channel_keys(channel_value_satoshis, user_id_1, user_id_2))
468 pub struct TestChainSource {
469 pub genesis_hash: BlockHash,
470 pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
471 pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
472 pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
475 impl TestChainSource {
476 pub fn new(network: Network) -> Self {
477 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
479 genesis_hash: genesis_block(network).block_hash(),
480 utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
481 watched_txn: Mutex::new(HashSet::new()),
482 watched_outputs: Mutex::new(HashSet::new()),
487 impl chain::Access for TestChainSource {
488 fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
489 if self.genesis_hash != *genesis_hash {
490 return Err(chain::AccessError::UnknownChain);
493 self.utxo_ret.lock().unwrap().clone()
497 impl chain::Filter for TestChainSource {
498 fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
499 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
502 fn register_output(&self, outpoint: &OutPoint, script_pubkey: &Script) {
503 self.watched_outputs.lock().unwrap().insert((*outpoint, script_pubkey.clone()));