]> git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/util/test_utils.rs
Merge pull request #739 from rloomba/rloomba/add-clippy-to-travis
[rust-lightning] / lightning / src / util / test_utils.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
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
8 // licenses.
9
10 use chain;
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};
19 use ln::msgs;
20 use ln::msgs::OptionalField;
21 use util::enforcing_trait_impls::EnforcingChannelKeys;
22 use util::events;
23 use util::logger::{Logger, Level, Record};
24 use util::ser::{Readable, Writer, Writeable};
25
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};
32
33 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, Signature};
34
35 use regex;
36
37 use std::time::Duration;
38 use std::sync::Mutex;
39 use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
40 use std::{cmp, mem};
41 use std::collections::{HashMap, HashSet};
42
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);
47                 Ok(())
48         }
49         fn size_hint(&mut self, size: usize) {
50                 self.0.reserve_exact(size);
51         }
52 }
53
54 pub struct TestFeeEstimator {
55         pub sat_per_kw: u32,
56 }
57 impl chaininterface::FeeEstimator for TestFeeEstimator {
58         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
59                 self.sat_per_kw
60         }
61 }
62
63 pub struct TestChainMonitor<'a> {
64         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>>,
65         pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64)>>,
66         pub chain_monitor: chainmonitor::ChainMonitor<EnforcingChannelKeys, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger>,
67         pub update_ret: Mutex<Result<(), channelmonitor::ChannelMonitorUpdateErr>>,
68         // If this is set to Some(), after the next return, we'll always return this until update_ret
69         // is changed:
70         pub next_update_ret: Mutex<Option<Result<(), channelmonitor::ChannelMonitorUpdateErr>>>,
71 }
72 impl<'a> TestChainMonitor<'a> {
73         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator) -> Self {
74                 Self {
75                         added_monitors: Mutex::new(Vec::new()),
76                         latest_monitor_update_id: Mutex::new(HashMap::new()),
77                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator),
78                         update_ret: Mutex::new(Ok(())),
79                         next_update_ret: Mutex::new(None),
80                 }
81         }
82 }
83 impl<'a> chain::Watch for TestChainMonitor<'a> {
84         type Keys = EnforcingChannelKeys;
85
86         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingChannelKeys>) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
87                 // At every point where we get a monitor update, we should be able to send a useful monitor
88                 // to a watchtower and disk...
89                 let mut w = TestVecWriter(Vec::new());
90                 monitor.write_for_disk(&mut w).unwrap();
91                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
92                         &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
93                 assert!(new_monitor == monitor);
94                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, monitor.get_latest_update_id()));
95                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
96                 assert!(self.chain_monitor.watch_channel(funding_txo, new_monitor).is_ok());
97
98                 let ret = self.update_ret.lock().unwrap().clone();
99                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
100                         *self.update_ret.lock().unwrap() = next_ret;
101                 }
102                 ret
103         }
104
105         fn update_channel(&self, funding_txo: OutPoint, update: channelmonitor::ChannelMonitorUpdate) -> Result<(), channelmonitor::ChannelMonitorUpdateErr> {
106                 // Every monitor update should survive roundtrip
107                 let mut w = TestVecWriter(Vec::new());
108                 update.write(&mut w).unwrap();
109                 assert!(channelmonitor::ChannelMonitorUpdate::read(
110                                 &mut ::std::io::Cursor::new(&w.0)).unwrap() == update);
111
112                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(), (funding_txo, update.update_id));
113                 assert!(self.chain_monitor.update_channel(funding_txo, update).is_ok());
114                 // At every point where we get a monitor update, we should be able to send a useful monitor
115                 // to a watchtower and disk...
116                 let monitors = self.chain_monitor.monitors.lock().unwrap();
117                 let monitor = monitors.get(&funding_txo).unwrap();
118                 w.0.clear();
119                 monitor.write_for_disk(&mut w).unwrap();
120                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
121                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
122                 assert!(new_monitor == *monitor);
123                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
124
125                 let ret = self.update_ret.lock().unwrap().clone();
126                 if let Some(next_ret) = self.next_update_ret.lock().unwrap().take() {
127                         *self.update_ret.lock().unwrap() = next_ret;
128                 }
129                 ret
130         }
131
132         fn release_pending_monitor_events(&self) -> Vec<MonitorEvent> {
133                 return self.chain_monitor.release_pending_monitor_events();
134         }
135 }
136
137 pub struct TestBroadcaster {
138         pub txn_broadcasted: Mutex<Vec<Transaction>>,
139 }
140 impl chaininterface::BroadcasterInterface for TestBroadcaster {
141         fn broadcast_transaction(&self, tx: &Transaction) {
142                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
143         }
144 }
145
146 pub struct TestChannelMessageHandler {
147         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
148 }
149
150 impl TestChannelMessageHandler {
151         pub fn new() -> Self {
152                 TestChannelMessageHandler {
153                         pending_events: Mutex::new(Vec::new()),
154                 }
155         }
156 }
157
158 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
159         fn handle_open_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::OpenChannel) {}
160         fn handle_accept_channel(&self, _their_node_id: &PublicKey, _their_features: InitFeatures, _msg: &msgs::AcceptChannel) {}
161         fn handle_funding_created(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingCreated) {}
162         fn handle_funding_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingSigned) {}
163         fn handle_funding_locked(&self, _their_node_id: &PublicKey, _msg: &msgs::FundingLocked) {}
164         fn handle_shutdown(&self, _their_node_id: &PublicKey, _msg: &msgs::Shutdown) {}
165         fn handle_closing_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::ClosingSigned) {}
166         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateAddHTLC) {}
167         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFulfillHTLC) {}
168         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailHTLC) {}
169         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFailMalformedHTLC) {}
170         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, _msg: &msgs::CommitmentSigned) {}
171         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, _msg: &msgs::RevokeAndACK) {}
172         fn handle_update_fee(&self, _their_node_id: &PublicKey, _msg: &msgs::UpdateFee) {}
173         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, _msg: &msgs::AnnouncementSignatures) {}
174         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelReestablish) {}
175         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
176         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) {}
177         fn handle_error(&self, _their_node_id: &PublicKey, _msg: &msgs::ErrorMessage) {}
178 }
179
180 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
181         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
182                 let mut pending_events = self.pending_events.lock().unwrap();
183                 let mut ret = Vec::new();
184                 mem::swap(&mut ret, &mut *pending_events);
185                 ret
186         }
187 }
188
189 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
190         use bitcoin::secp256k1::ffi::Signature as FFISignature;
191         let secp_ctx = Secp256k1::new();
192         let network = Network::Testnet;
193         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
194         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
195         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
196         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
197         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
198                 features: ChannelFeatures::known(),
199                 chain_hash: genesis_block(network).header.block_hash(),
200                 short_channel_id: short_chan_id,
201                 node_id_1: PublicKey::from_secret_key(&secp_ctx, &node_1_privkey),
202                 node_id_2: PublicKey::from_secret_key(&secp_ctx, &node_2_privkey),
203                 bitcoin_key_1: PublicKey::from_secret_key(&secp_ctx, &node_1_btckey),
204                 bitcoin_key_2: PublicKey::from_secret_key(&secp_ctx, &node_2_btckey),
205                 excess_data: Vec::new(),
206         };
207
208         msgs::ChannelAnnouncement {
209                 node_signature_1: Signature::from(FFISignature::new()),
210                 node_signature_2: Signature::from(FFISignature::new()),
211                 bitcoin_signature_1: Signature::from(FFISignature::new()),
212                 bitcoin_signature_2: Signature::from(FFISignature::new()),
213                 contents: unsigned_ann,
214         }
215 }
216
217 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
218         use bitcoin::secp256k1::ffi::Signature as FFISignature;
219         let network = Network::Testnet;
220         msgs::ChannelUpdate {
221                 signature: Signature::from(FFISignature::new()),
222                 contents: msgs::UnsignedChannelUpdate {
223                         chain_hash: genesis_block(network).header.block_hash(),
224                         short_channel_id: short_chan_id,
225                         timestamp: 0,
226                         flags: 0,
227                         cltv_expiry_delta: 0,
228                         htlc_minimum_msat: 0,
229                         htlc_maximum_msat: OptionalField::Absent,
230                         fee_base_msat: 0,
231                         fee_proportional_millionths: 0,
232                         excess_data: vec![],
233                 }
234         }
235 }
236
237 pub struct TestRoutingMessageHandler {
238         pub chan_upds_recvd: AtomicUsize,
239         pub chan_anns_recvd: AtomicUsize,
240         pub chan_anns_sent: AtomicUsize,
241         pub request_full_sync: AtomicBool,
242 }
243
244 impl TestRoutingMessageHandler {
245         pub fn new() -> Self {
246                 TestRoutingMessageHandler {
247                         chan_upds_recvd: AtomicUsize::new(0),
248                         chan_anns_recvd: AtomicUsize::new(0),
249                         chan_anns_sent: AtomicUsize::new(0),
250                         request_full_sync: AtomicBool::new(false),
251                 }
252         }
253 }
254 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
255         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
256                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
257         }
258         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
259                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
260                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
261         }
262         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
263                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
264                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
265         }
266         fn handle_htlc_fail_channel_update(&self, _update: &msgs::HTLCFailChannelUpdate) {}
267         fn get_next_channel_announcements(&self, starting_point: u64, batch_amount: u8) -> Vec<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
268                 let mut chan_anns = Vec::new();
269                 const TOTAL_UPDS: u64 = 100;
270                 let end: u64 = cmp::min(starting_point + batch_amount as u64, TOTAL_UPDS - self.chan_anns_sent.load(Ordering::Acquire) as u64);
271                 for i in starting_point..end {
272                         let chan_upd_1 = get_dummy_channel_update(i);
273                         let chan_upd_2 = get_dummy_channel_update(i);
274                         let chan_ann = get_dummy_channel_announcement(i);
275
276                         chan_anns.push((chan_ann, Some(chan_upd_1), Some(chan_upd_2)));
277                 }
278
279                 self.chan_anns_sent.fetch_add(chan_anns.len(), Ordering::AcqRel);
280                 chan_anns
281         }
282
283         fn get_next_node_announcements(&self, _starting_point: Option<&PublicKey>, _batch_amount: u8) -> Vec<msgs::NodeAnnouncement> {
284                 Vec::new()
285         }
286
287         fn should_request_full_sync(&self, _node_id: &PublicKey) -> bool {
288                 self.request_full_sync.load(Ordering::Acquire)
289         }
290 }
291
292 pub struct TestLogger {
293         level: Level,
294         id: String,
295         pub lines: Mutex<HashMap<(String, String), usize>>,
296 }
297
298 impl TestLogger {
299         pub fn new() -> TestLogger {
300                 Self::with_id("".to_owned())
301         }
302         pub fn with_id(id: String) -> TestLogger {
303                 TestLogger {
304                         level: Level::Trace,
305                         id,
306                         lines: Mutex::new(HashMap::new())
307                 }
308         }
309         pub fn enable(&mut self, level: Level) {
310                 self.level = level;
311         }
312         pub fn assert_log(&self, module: String, line: String, count: usize) {
313                 let log_entries = self.lines.lock().unwrap();
314                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
315         }
316
317         /// Search for the number of occurrence of the logged lines which
318         /// 1. belongs to the specified module and
319         /// 2. contains `line` in it.
320         /// And asserts if the number of occurrences is the same with the given `count`
321         pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
322                 let log_entries = self.lines.lock().unwrap();
323                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
324                         m == &module && l.contains(line.as_str())
325                 }).map(|(_, c) | { c }).sum();
326                 assert_eq!(l, count)
327         }
328
329     /// Search for the number of occurrences of logged lines which
330     /// 1. belong to the specified module and
331     /// 2. match the given regex pattern.
332     /// Assert that the number of occurrences equals the given `count`
333         pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
334                 let log_entries = self.lines.lock().unwrap();
335                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
336                         m == &module && pattern.is_match(&l)
337                 }).map(|(_, c) | { c }).sum();
338                 assert_eq!(l, count)
339         }
340 }
341
342 impl Logger for TestLogger {
343         fn log(&self, record: &Record) {
344                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
345                 if self.level >= record.level {
346                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
347                 }
348         }
349 }
350
351 pub struct TestKeysInterface {
352         backing: keysinterface::KeysManager,
353         pub override_session_priv: Mutex<Option<[u8; 32]>>,
354         pub override_channel_id_priv: Mutex<Option<[u8; 32]>>,
355 }
356
357 impl keysinterface::KeysInterface for TestKeysInterface {
358         type ChanKeySigner = EnforcingChannelKeys;
359
360         fn get_node_secret(&self) -> SecretKey { self.backing.get_node_secret() }
361         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
362         fn get_shutdown_pubkey(&self) -> PublicKey { self.backing.get_shutdown_pubkey() }
363         fn get_channel_keys(&self, inbound: bool, channel_value_satoshis: u64) -> EnforcingChannelKeys {
364                 EnforcingChannelKeys::new(self.backing.get_channel_keys(inbound, channel_value_satoshis))
365         }
366
367         fn get_secure_random_bytes(&self) -> [u8; 32] {
368                 let override_channel_id = self.override_channel_id_priv.lock().unwrap();
369                 let override_session_key = self.override_session_priv.lock().unwrap();
370                 if override_channel_id.is_some() && override_session_key.is_some() {
371                         panic!("We don't know which override key to use!");
372                 }
373                 if let Some(key) = &*override_channel_id {
374                         return *key;
375                 }
376                 if let Some(key) = &*override_session_key {
377                         return *key;
378                 }
379                 self.backing.get_secure_random_bytes()
380         }
381 }
382
383 impl TestKeysInterface {
384         pub fn new(seed: &[u8; 32], network: Network) -> Self {
385                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
386                 Self {
387                         backing: keysinterface::KeysManager::new(seed, network, now.as_secs(), now.subsec_nanos()),
388                         override_session_priv: Mutex::new(None),
389                         override_channel_id_priv: Mutex::new(None),
390                 }
391         }
392         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, user_id_1: u64, user_id_2: u64) -> EnforcingChannelKeys {
393                 EnforcingChannelKeys::new(self.backing.derive_channel_keys(channel_value_satoshis, user_id_1, user_id_2))
394         }
395 }
396
397 pub struct TestChainSource {
398         pub genesis_hash: BlockHash,
399         pub utxo_ret: Mutex<Result<TxOut, chain::AccessError>>,
400         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
401         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
402 }
403
404 impl TestChainSource {
405         pub fn new(network: Network) -> Self {
406                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
407                 Self {
408                         genesis_hash: genesis_block(network).block_hash(),
409                         utxo_ret: Mutex::new(Ok(TxOut { value: u64::max_value(), script_pubkey })),
410                         watched_txn: Mutex::new(HashSet::new()),
411                         watched_outputs: Mutex::new(HashSet::new()),
412                 }
413         }
414 }
415
416 impl chain::Access for TestChainSource {
417         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> Result<TxOut, chain::AccessError> {
418                 if self.genesis_hash != *genesis_hash {
419                         return Err(chain::AccessError::UnknownChain);
420                 }
421
422                 self.utxo_ret.lock().unwrap().clone()
423         }
424 }
425
426 impl chain::Filter for TestChainSource {
427         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
428                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
429         }
430
431         fn register_output(&self, outpoint: &OutPoint, script_pubkey: &Script) {
432                 self.watched_outputs.lock().unwrap().insert((*outpoint, script_pubkey.clone()));
433         }
434 }