Handle `MonitorUpdateCompletionAction`s after monitor update sync
[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 crate::chain;
11 use crate::chain::WatchedOutput;
12 use crate::chain::chaininterface;
13 use crate::chain::chaininterface::ConfirmationTarget;
14 use crate::chain::chainmonitor;
15 use crate::chain::chainmonitor::MonitorUpdateId;
16 use crate::chain::channelmonitor;
17 use crate::chain::channelmonitor::MonitorEvent;
18 use crate::chain::transaction::OutPoint;
19 use crate::chain::keysinterface;
20 use crate::ln::channelmanager;
21 use crate::ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
22 use crate::ln::{msgs, wire};
23 use crate::ln::msgs::LightningError;
24 use crate::ln::script::ShutdownScript;
25 use crate::routing::gossip::{EffectiveCapacity, NetworkGraph, NodeId};
26 use crate::routing::utxo::{UtxoLookup, UtxoLookupError, UtxoResult};
27 use crate::routing::router::{find_route, InFlightHtlcs, Route, RouteHop, RouteParameters, Router, ScorerAccountingForInFlightHtlcs};
28 use crate::routing::scoring::{ChannelUsage, Score};
29 use crate::util::config::UserConfig;
30 use crate::util::enforcing_trait_impls::{EnforcingSigner, EnforcementState};
31 use crate::util::events;
32 use crate::util::logger::{Logger, Level, Record};
33 use crate::util::ser::{Readable, ReadableArgs, Writer, Writeable};
34
35 use bitcoin::blockdata::constants::genesis_block;
36 use bitcoin::blockdata::transaction::{Transaction, TxOut};
37 use bitcoin::blockdata::script::{Builder, Script};
38 use bitcoin::blockdata::opcodes;
39 use bitcoin::blockdata::block::Block;
40 use bitcoin::network::constants::Network;
41 use bitcoin::hash_types::{BlockHash, Txid};
42
43 use bitcoin::secp256k1::{SecretKey, PublicKey, Secp256k1, ecdsa::Signature, Scalar};
44 use bitcoin::secp256k1::ecdh::SharedSecret;
45 use bitcoin::secp256k1::ecdsa::RecoverableSignature;
46
47 use regex;
48
49 use crate::io;
50 use crate::prelude::*;
51 use core::cell::RefCell;
52 use core::time::Duration;
53 use crate::sync::{Mutex, Arc};
54 use core::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
55 use core::mem;
56 use bitcoin::bech32::u5;
57 use crate::chain::keysinterface::{InMemorySigner, Recipient, EntropySource, NodeSigner, SignerProvider};
58
59 #[cfg(feature = "std")]
60 use std::time::{SystemTime, UNIX_EPOCH};
61 use bitcoin::Sequence;
62
63 pub struct TestVecWriter(pub Vec<u8>);
64 impl Writer for TestVecWriter {
65         fn write_all(&mut self, buf: &[u8]) -> Result<(), io::Error> {
66                 self.0.extend_from_slice(buf);
67                 Ok(())
68         }
69 }
70
71 pub struct TestFeeEstimator {
72         pub sat_per_kw: Mutex<u32>,
73 }
74 impl chaininterface::FeeEstimator for TestFeeEstimator {
75         fn get_est_sat_per_1000_weight(&self, _confirmation_target: ConfirmationTarget) -> u32 {
76                 *self.sat_per_kw.lock().unwrap()
77         }
78 }
79
80 pub struct TestRouter<'a> {
81         pub network_graph: Arc<NetworkGraph<&'a TestLogger>>,
82         pub next_routes: Mutex<VecDeque<(RouteParameters, Result<Route, LightningError>)>>,
83         pub scorer: &'a Mutex<TestScorer>,
84 }
85
86 impl<'a> TestRouter<'a> {
87         pub fn new(network_graph: Arc<NetworkGraph<&'a TestLogger>>, scorer: &'a Mutex<TestScorer>) -> Self {
88                 Self { network_graph, next_routes: Mutex::new(VecDeque::new()), scorer }
89         }
90
91         pub fn expect_find_route(&self, query: RouteParameters, result: Result<Route, LightningError>) {
92                 let mut expected_routes = self.next_routes.lock().unwrap();
93                 expected_routes.push_back((query, result));
94         }
95 }
96
97 impl<'a> Router for TestRouter<'a> {
98         fn find_route(
99                 &self, payer: &PublicKey, params: &RouteParameters, first_hops: Option<&[&channelmanager::ChannelDetails]>,
100                 inflight_htlcs: &InFlightHtlcs
101         ) -> Result<Route, msgs::LightningError> {
102                 if let Some((find_route_query, find_route_res)) = self.next_routes.lock().unwrap().pop_front() {
103                         assert_eq!(find_route_query, *params);
104                         if let Ok(ref route) = find_route_res {
105                                 let locked_scorer = self.scorer.lock().unwrap();
106                                 let scorer = ScorerAccountingForInFlightHtlcs::new(locked_scorer, inflight_htlcs);
107                                 for path in &route.paths {
108                                         let mut aggregate_msat = 0u64;
109                                         for (idx, hop) in path.iter().rev().enumerate() {
110                                                 aggregate_msat += hop.fee_msat;
111                                                 let usage = ChannelUsage {
112                                                         amount_msat: aggregate_msat,
113                                                         inflight_htlc_msat: 0,
114                                                         effective_capacity: EffectiveCapacity::Unknown,
115                                                 };
116
117                                                 // Since the path is reversed, the last element in our iteration is the first
118                                                 // hop.
119                                                 if idx == path.len() - 1 {
120                                                         scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(payer), &NodeId::from_pubkey(&hop.pubkey), usage);
121                                                 } else {
122                                                         let curr_hop_path_idx = path.len() - 1 - idx;
123                                                         scorer.channel_penalty_msat(hop.short_channel_id, &NodeId::from_pubkey(&path[curr_hop_path_idx - 1].pubkey), &NodeId::from_pubkey(&hop.pubkey), usage);
124                                                 }
125                                         }
126                                 }
127                         }
128                         return find_route_res;
129                 }
130                 let logger = TestLogger::new();
131                 let scorer = self.scorer.lock().unwrap();
132                 find_route(
133                         payer, params, &self.network_graph, first_hops, &logger,
134                         &ScorerAccountingForInFlightHtlcs::new(scorer, &inflight_htlcs),
135                         &[42; 32]
136                 )
137         }
138 }
139
140 impl<'a> Drop for TestRouter<'a> {
141         fn drop(&mut self) {
142                 #[cfg(feature = "std")] {
143                         if std::thread::panicking() {
144                                 return;
145                         }
146                 }
147                 assert!(self.next_routes.lock().unwrap().is_empty());
148         }
149 }
150
151 pub struct OnlyReadsKeysInterface {}
152
153 impl EntropySource for OnlyReadsKeysInterface {
154         fn get_secure_random_bytes(&self) -> [u8; 32] { [0; 32] }}
155
156 impl SignerProvider for OnlyReadsKeysInterface {
157         type Signer = EnforcingSigner;
158
159         fn generate_channel_keys_id(&self, _inbound: bool, _channel_value_satoshis: u64, _user_channel_id: u128) -> [u8; 32] { unreachable!(); }
160
161         fn derive_channel_signer(&self, _channel_value_satoshis: u64, _channel_keys_id: [u8; 32]) -> Self::Signer { unreachable!(); }
162
163         fn read_chan_signer(&self, mut reader: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
164                 let inner: InMemorySigner = Readable::read(&mut reader)?;
165                 let state = Arc::new(Mutex::new(EnforcementState::new()));
166
167                 Ok(EnforcingSigner::new_with_revoked(
168                         inner,
169                         state,
170                         false
171                 ))
172         }
173
174         fn get_destination_script(&self) -> Script { unreachable!(); }
175         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript { unreachable!(); }
176 }
177
178 pub struct TestChainMonitor<'a> {
179         pub added_monitors: Mutex<Vec<(OutPoint, channelmonitor::ChannelMonitor<EnforcingSigner>)>>,
180         pub monitor_updates: Mutex<HashMap<[u8; 32], Vec<channelmonitor::ChannelMonitorUpdate>>>,
181         pub latest_monitor_update_id: Mutex<HashMap<[u8; 32], (OutPoint, u64, MonitorUpdateId)>>,
182         pub chain_monitor: chainmonitor::ChainMonitor<EnforcingSigner, &'a TestChainSource, &'a chaininterface::BroadcasterInterface, &'a TestFeeEstimator, &'a TestLogger, &'a chainmonitor::Persist<EnforcingSigner>>,
183         pub keys_manager: &'a TestKeysInterface,
184         /// If this is set to Some(), the next update_channel call (not watch_channel) must be a
185         /// ChannelForceClosed event for the given channel_id with should_broadcast set to the given
186         /// boolean.
187         pub expect_channel_force_closed: Mutex<Option<([u8; 32], bool)>>,
188 }
189 impl<'a> TestChainMonitor<'a> {
190         pub fn new(chain_source: Option<&'a TestChainSource>, broadcaster: &'a chaininterface::BroadcasterInterface, logger: &'a TestLogger, fee_estimator: &'a TestFeeEstimator, persister: &'a chainmonitor::Persist<EnforcingSigner>, keys_manager: &'a TestKeysInterface) -> Self {
191                 Self {
192                         added_monitors: Mutex::new(Vec::new()),
193                         monitor_updates: Mutex::new(HashMap::new()),
194                         latest_monitor_update_id: Mutex::new(HashMap::new()),
195                         chain_monitor: chainmonitor::ChainMonitor::new(chain_source, broadcaster, logger, fee_estimator, persister),
196                         keys_manager,
197                         expect_channel_force_closed: Mutex::new(None),
198                 }
199         }
200
201         pub fn complete_sole_pending_chan_update(&self, channel_id: &[u8; 32]) {
202                 let (outpoint, _, latest_update) = self.latest_monitor_update_id.lock().unwrap().get(channel_id).unwrap().clone();
203                 self.chain_monitor.channel_monitor_updated(outpoint, latest_update).unwrap();
204         }
205 }
206 impl<'a> chain::Watch<EnforcingSigner> for TestChainMonitor<'a> {
207         fn watch_channel(&self, funding_txo: OutPoint, monitor: channelmonitor::ChannelMonitor<EnforcingSigner>) -> chain::ChannelMonitorUpdateStatus {
208                 // At every point where we get a monitor update, we should be able to send a useful monitor
209                 // to a watchtower and disk...
210                 let mut w = TestVecWriter(Vec::new());
211                 monitor.write(&mut w).unwrap();
212                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
213                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
214                 assert!(new_monitor == monitor);
215                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
216                         (funding_txo, monitor.get_latest_update_id(), MonitorUpdateId::from_new_monitor(&monitor)));
217                 self.added_monitors.lock().unwrap().push((funding_txo, monitor));
218                 self.chain_monitor.watch_channel(funding_txo, new_monitor)
219         }
220
221         fn update_channel(&self, funding_txo: OutPoint, update: &channelmonitor::ChannelMonitorUpdate) -> chain::ChannelMonitorUpdateStatus {
222                 // Every monitor update should survive roundtrip
223                 let mut w = TestVecWriter(Vec::new());
224                 update.write(&mut w).unwrap();
225                 assert!(channelmonitor::ChannelMonitorUpdate::read(
226                                 &mut io::Cursor::new(&w.0)).unwrap() == *update);
227
228                 self.monitor_updates.lock().unwrap().entry(funding_txo.to_channel_id()).or_insert(Vec::new()).push(update.clone());
229
230                 if let Some(exp) = self.expect_channel_force_closed.lock().unwrap().take() {
231                         assert_eq!(funding_txo.to_channel_id(), exp.0);
232                         assert_eq!(update.updates.len(), 1);
233                         if let channelmonitor::ChannelMonitorUpdateStep::ChannelForceClosed { should_broadcast } = update.updates[0] {
234                                 assert_eq!(should_broadcast, exp.1);
235                         } else { panic!(); }
236                 }
237
238                 self.latest_monitor_update_id.lock().unwrap().insert(funding_txo.to_channel_id(),
239                         (funding_txo, update.update_id, MonitorUpdateId::from_monitor_update(update)));
240                 let update_res = self.chain_monitor.update_channel(funding_txo, update);
241                 // At every point where we get a monitor update, we should be able to send a useful monitor
242                 // to a watchtower and disk...
243                 let monitor = self.chain_monitor.get_monitor(funding_txo).unwrap();
244                 w.0.clear();
245                 monitor.write(&mut w).unwrap();
246                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingSigner>)>::read(
247                         &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap().1;
248                 assert!(new_monitor == *monitor);
249                 self.added_monitors.lock().unwrap().push((funding_txo, new_monitor));
250                 update_res
251         }
252
253         fn release_pending_monitor_events(&self) -> Vec<(OutPoint, Vec<MonitorEvent>, Option<PublicKey>)> {
254                 return self.chain_monitor.release_pending_monitor_events();
255         }
256 }
257
258 pub struct TestPersister {
259         /// The queue of update statuses we'll return. If none are queued, ::Completed will always be
260         /// returned.
261         pub update_rets: Mutex<VecDeque<chain::ChannelMonitorUpdateStatus>>,
262         /// When we get an update_persisted_channel call with no ChannelMonitorUpdate, we insert the
263         /// MonitorUpdateId here.
264         pub chain_sync_monitor_persistences: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
265         /// When we get an update_persisted_channel call *with* a ChannelMonitorUpdate, we insert the
266         /// MonitorUpdateId here.
267         pub offchain_monitor_updates: Mutex<HashMap<OutPoint, HashSet<MonitorUpdateId>>>,
268 }
269 impl TestPersister {
270         pub fn new() -> Self {
271                 Self {
272                         update_rets: Mutex::new(VecDeque::new()),
273                         chain_sync_monitor_persistences: Mutex::new(HashMap::new()),
274                         offchain_monitor_updates: Mutex::new(HashMap::new()),
275                 }
276         }
277
278         /// Queue an update status to return.
279         pub fn set_update_ret(&self, next_ret: chain::ChannelMonitorUpdateStatus) {
280                 self.update_rets.lock().unwrap().push_back(next_ret);
281         }
282 }
283 impl<Signer: keysinterface::WriteableEcdsaChannelSigner> chainmonitor::Persist<Signer> for TestPersister {
284         fn persist_new_channel(&self, _funding_txo: OutPoint, _data: &channelmonitor::ChannelMonitor<Signer>, _id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
285                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
286                         return update_ret
287                 }
288                 chain::ChannelMonitorUpdateStatus::Completed
289         }
290
291         fn update_persisted_channel(&self, funding_txo: OutPoint, update: Option<&channelmonitor::ChannelMonitorUpdate>, _data: &channelmonitor::ChannelMonitor<Signer>, update_id: MonitorUpdateId) -> chain::ChannelMonitorUpdateStatus {
292                 let mut ret = chain::ChannelMonitorUpdateStatus::Completed;
293                 if let Some(update_ret) = self.update_rets.lock().unwrap().pop_front() {
294                         ret = update_ret;
295                 }
296                 if update.is_none() {
297                         self.chain_sync_monitor_persistences.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
298                 } else {
299                         self.offchain_monitor_updates.lock().unwrap().entry(funding_txo).or_insert(HashSet::new()).insert(update_id);
300                 }
301                 ret
302         }
303 }
304
305 pub struct TestBroadcaster {
306         pub txn_broadcasted: Mutex<Vec<Transaction>>,
307         pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
308 }
309
310 impl TestBroadcaster {
311         pub fn new(blocks: Arc<Mutex<Vec<(Block, u32)>>>) -> TestBroadcaster {
312                 TestBroadcaster { txn_broadcasted: Mutex::new(Vec::new()), blocks }
313         }
314 }
315
316 impl chaininterface::BroadcasterInterface for TestBroadcaster {
317         fn broadcast_transaction(&self, tx: &Transaction) {
318                 let lock_time = tx.lock_time.0;
319                 assert!(lock_time < 1_500_000_000);
320                 if lock_time > self.blocks.lock().unwrap().len() as u32 + 1 && lock_time < 500_000_000 {
321                         for inp in tx.input.iter() {
322                                 if inp.sequence != Sequence::MAX {
323                                         panic!("We should never broadcast a transaction before its locktime ({})!", tx.lock_time);
324                                 }
325                         }
326                 }
327                 self.txn_broadcasted.lock().unwrap().push(tx.clone());
328         }
329 }
330
331 pub struct TestChannelMessageHandler {
332         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
333         expected_recv_msgs: Mutex<Option<Vec<wire::Message<()>>>>,
334 }
335
336 impl TestChannelMessageHandler {
337         pub fn new() -> Self {
338                 TestChannelMessageHandler {
339                         pending_events: Mutex::new(Vec::new()),
340                         expected_recv_msgs: Mutex::new(None),
341                 }
342         }
343
344         #[cfg(test)]
345         pub(crate) fn expect_receive_msg(&self, ev: wire::Message<()>) {
346                 let mut expected_msgs = self.expected_recv_msgs.lock().unwrap();
347                 if expected_msgs.is_none() { *expected_msgs = Some(Vec::new()); }
348                 expected_msgs.as_mut().unwrap().push(ev);
349         }
350
351         fn received_msg(&self, _ev: wire::Message<()>) {
352                 let mut msgs = self.expected_recv_msgs.lock().unwrap();
353                 if msgs.is_none() { return; }
354                 assert!(!msgs.as_ref().unwrap().is_empty(), "Received message when we weren't expecting one");
355                 #[cfg(test)]
356                 assert_eq!(msgs.as_ref().unwrap()[0], _ev);
357                 msgs.as_mut().unwrap().remove(0);
358         }
359 }
360
361 impl Drop for TestChannelMessageHandler {
362         fn drop(&mut self) {
363                 #[cfg(feature = "std")]
364                 {
365                         let l = self.expected_recv_msgs.lock().unwrap();
366                         if !std::thread::panicking() {
367                                 assert!(l.is_none() || l.as_ref().unwrap().is_empty());
368                         }
369                 }
370         }
371 }
372
373 impl msgs::ChannelMessageHandler for TestChannelMessageHandler {
374         fn handle_open_channel(&self, _their_node_id: &PublicKey, msg: &msgs::OpenChannel) {
375                 self.received_msg(wire::Message::OpenChannel(msg.clone()));
376         }
377         fn handle_accept_channel(&self, _their_node_id: &PublicKey, msg: &msgs::AcceptChannel) {
378                 self.received_msg(wire::Message::AcceptChannel(msg.clone()));
379         }
380         fn handle_funding_created(&self, _their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
381                 self.received_msg(wire::Message::FundingCreated(msg.clone()));
382         }
383         fn handle_funding_signed(&self, _their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
384                 self.received_msg(wire::Message::FundingSigned(msg.clone()));
385         }
386         fn handle_channel_ready(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReady) {
387                 self.received_msg(wire::Message::ChannelReady(msg.clone()));
388         }
389         fn handle_shutdown(&self, _their_node_id: &PublicKey, msg: &msgs::Shutdown) {
390                 self.received_msg(wire::Message::Shutdown(msg.clone()));
391         }
392         fn handle_closing_signed(&self, _their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
393                 self.received_msg(wire::Message::ClosingSigned(msg.clone()));
394         }
395         fn handle_update_add_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
396                 self.received_msg(wire::Message::UpdateAddHTLC(msg.clone()));
397         }
398         fn handle_update_fulfill_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
399                 self.received_msg(wire::Message::UpdateFulfillHTLC(msg.clone()));
400         }
401         fn handle_update_fail_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
402                 self.received_msg(wire::Message::UpdateFailHTLC(msg.clone()));
403         }
404         fn handle_update_fail_malformed_htlc(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
405                 self.received_msg(wire::Message::UpdateFailMalformedHTLC(msg.clone()));
406         }
407         fn handle_commitment_signed(&self, _their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
408                 self.received_msg(wire::Message::CommitmentSigned(msg.clone()));
409         }
410         fn handle_revoke_and_ack(&self, _their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
411                 self.received_msg(wire::Message::RevokeAndACK(msg.clone()));
412         }
413         fn handle_update_fee(&self, _their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
414                 self.received_msg(wire::Message::UpdateFee(msg.clone()));
415         }
416         fn handle_channel_update(&self, _their_node_id: &PublicKey, _msg: &msgs::ChannelUpdate) {
417                 // Don't call `received_msg` here as `TestRoutingMessageHandler` generates these sometimes
418         }
419         fn handle_announcement_signatures(&self, _their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
420                 self.received_msg(wire::Message::AnnouncementSignatures(msg.clone()));
421         }
422         fn handle_channel_reestablish(&self, _their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
423                 self.received_msg(wire::Message::ChannelReestablish(msg.clone()));
424         }
425         fn peer_disconnected(&self, _their_node_id: &PublicKey, _no_connection_possible: bool) {}
426         fn peer_connected(&self, _their_node_id: &PublicKey, _msg: &msgs::Init) -> Result<(), ()> {
427                 // Don't bother with `received_msg` for Init as its auto-generated and we don't want to
428                 // bother re-generating the expected Init message in all tests.
429                 Ok(())
430         }
431         fn handle_error(&self, _their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
432                 self.received_msg(wire::Message::Error(msg.clone()));
433         }
434         fn provided_node_features(&self) -> NodeFeatures {
435                 channelmanager::provided_node_features(&UserConfig::default())
436         }
437         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
438                 channelmanager::provided_init_features(&UserConfig::default())
439         }
440 }
441
442 impl events::MessageSendEventsProvider for TestChannelMessageHandler {
443         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
444                 let mut pending_events = self.pending_events.lock().unwrap();
445                 let mut ret = Vec::new();
446                 mem::swap(&mut ret, &mut *pending_events);
447                 ret
448         }
449 }
450
451 fn get_dummy_channel_announcement(short_chan_id: u64) -> msgs::ChannelAnnouncement {
452         use bitcoin::secp256k1::ffi::Signature as FFISignature;
453         let secp_ctx = Secp256k1::new();
454         let network = Network::Testnet;
455         let node_1_privkey = SecretKey::from_slice(&[42; 32]).unwrap();
456         let node_2_privkey = SecretKey::from_slice(&[41; 32]).unwrap();
457         let node_1_btckey = SecretKey::from_slice(&[40; 32]).unwrap();
458         let node_2_btckey = SecretKey::from_slice(&[39; 32]).unwrap();
459         let unsigned_ann = msgs::UnsignedChannelAnnouncement {
460                 features: ChannelFeatures::empty(),
461                 chain_hash: genesis_block(network).header.block_hash(),
462                 short_channel_id: short_chan_id,
463                 node_id_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_privkey)),
464                 node_id_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_privkey)),
465                 bitcoin_key_1: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_1_btckey)),
466                 bitcoin_key_2: NodeId::from_pubkey(&PublicKey::from_secret_key(&secp_ctx, &node_2_btckey)),
467                 excess_data: Vec::new(),
468         };
469
470         unsafe {
471                 msgs::ChannelAnnouncement {
472                         node_signature_1: Signature::from(FFISignature::new()),
473                         node_signature_2: Signature::from(FFISignature::new()),
474                         bitcoin_signature_1: Signature::from(FFISignature::new()),
475                         bitcoin_signature_2: Signature::from(FFISignature::new()),
476                         contents: unsigned_ann,
477                 }
478         }
479 }
480
481 fn get_dummy_channel_update(short_chan_id: u64) -> msgs::ChannelUpdate {
482         use bitcoin::secp256k1::ffi::Signature as FFISignature;
483         let network = Network::Testnet;
484         msgs::ChannelUpdate {
485                 signature: Signature::from(unsafe { FFISignature::new() }),
486                 contents: msgs::UnsignedChannelUpdate {
487                         chain_hash: genesis_block(network).header.block_hash(),
488                         short_channel_id: short_chan_id,
489                         timestamp: 0,
490                         flags: 0,
491                         cltv_expiry_delta: 0,
492                         htlc_minimum_msat: 0,
493                         htlc_maximum_msat: msgs::MAX_VALUE_MSAT,
494                         fee_base_msat: 0,
495                         fee_proportional_millionths: 0,
496                         excess_data: vec![],
497                 }
498         }
499 }
500
501 pub struct TestRoutingMessageHandler {
502         pub chan_upds_recvd: AtomicUsize,
503         pub chan_anns_recvd: AtomicUsize,
504         pub pending_events: Mutex<Vec<events::MessageSendEvent>>,
505         pub request_full_sync: AtomicBool,
506 }
507
508 impl TestRoutingMessageHandler {
509         pub fn new() -> Self {
510                 TestRoutingMessageHandler {
511                         chan_upds_recvd: AtomicUsize::new(0),
512                         chan_anns_recvd: AtomicUsize::new(0),
513                         pending_events: Mutex::new(vec![]),
514                         request_full_sync: AtomicBool::new(false),
515                 }
516         }
517 }
518 impl msgs::RoutingMessageHandler for TestRoutingMessageHandler {
519         fn handle_node_announcement(&self, _msg: &msgs::NodeAnnouncement) -> Result<bool, msgs::LightningError> {
520                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
521         }
522         fn handle_channel_announcement(&self, _msg: &msgs::ChannelAnnouncement) -> Result<bool, msgs::LightningError> {
523                 self.chan_anns_recvd.fetch_add(1, Ordering::AcqRel);
524                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
525         }
526         fn handle_channel_update(&self, _msg: &msgs::ChannelUpdate) -> Result<bool, msgs::LightningError> {
527                 self.chan_upds_recvd.fetch_add(1, Ordering::AcqRel);
528                 Err(msgs::LightningError { err: "".to_owned(), action: msgs::ErrorAction::IgnoreError })
529         }
530         fn get_next_channel_announcement(&self, starting_point: u64) -> Option<(msgs::ChannelAnnouncement, Option<msgs::ChannelUpdate>, Option<msgs::ChannelUpdate>)> {
531                 let chan_upd_1 = get_dummy_channel_update(starting_point);
532                 let chan_upd_2 = get_dummy_channel_update(starting_point);
533                 let chan_ann = get_dummy_channel_announcement(starting_point);
534
535                 Some((chan_ann, Some(chan_upd_1), Some(chan_upd_2)))
536         }
537
538         fn get_next_node_announcement(&self, _starting_point: Option<&NodeId>) -> Option<msgs::NodeAnnouncement> {
539                 None
540         }
541
542         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) -> Result<(), ()> {
543                 if !init_msg.features.supports_gossip_queries() {
544                         return Ok(());
545                 }
546
547                 #[allow(unused_mut, unused_assignments)]
548                 let mut gossip_start_time = 0;
549                 #[cfg(feature = "std")]
550                 {
551                         gossip_start_time = SystemTime::now().duration_since(UNIX_EPOCH).expect("Time must be > 1970").as_secs();
552                         if self.request_full_sync.load(Ordering::Acquire) {
553                                 gossip_start_time -= 60 * 60 * 24 * 7 * 2; // 2 weeks ago
554                         } else {
555                                 gossip_start_time -= 60 * 60; // an hour ago
556                         }
557                 }
558
559                 let mut pending_events = self.pending_events.lock().unwrap();
560                 pending_events.push(events::MessageSendEvent::SendGossipTimestampFilter {
561                         node_id: their_node_id.clone(),
562                         msg: msgs::GossipTimestampFilter {
563                                 chain_hash: genesis_block(Network::Testnet).header.block_hash(),
564                                 first_timestamp: gossip_start_time as u32,
565                                 timestamp_range: u32::max_value(),
566                         },
567                 });
568                 Ok(())
569         }
570
571         fn handle_reply_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyChannelRange) -> Result<(), msgs::LightningError> {
572                 Ok(())
573         }
574
575         fn handle_reply_short_channel_ids_end(&self, _their_node_id: &PublicKey, _msg: msgs::ReplyShortChannelIdsEnd) -> Result<(), msgs::LightningError> {
576                 Ok(())
577         }
578
579         fn handle_query_channel_range(&self, _their_node_id: &PublicKey, _msg: msgs::QueryChannelRange) -> Result<(), msgs::LightningError> {
580                 Ok(())
581         }
582
583         fn handle_query_short_channel_ids(&self, _their_node_id: &PublicKey, _msg: msgs::QueryShortChannelIds) -> Result<(), msgs::LightningError> {
584                 Ok(())
585         }
586
587         fn provided_node_features(&self) -> NodeFeatures {
588                 let mut features = NodeFeatures::empty();
589                 features.set_gossip_queries_optional();
590                 features
591         }
592
593         fn provided_init_features(&self, _their_init_features: &PublicKey) -> InitFeatures {
594                 let mut features = InitFeatures::empty();
595                 features.set_gossip_queries_optional();
596                 features
597         }
598
599         fn processing_queue_high(&self) -> bool { false }
600 }
601
602 impl events::MessageSendEventsProvider for TestRoutingMessageHandler {
603         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
604                 let mut ret = Vec::new();
605                 let mut pending_events = self.pending_events.lock().unwrap();
606                 core::mem::swap(&mut ret, &mut pending_events);
607                 ret
608         }
609 }
610
611 pub struct TestLogger {
612         level: Level,
613         pub(crate) id: String,
614         pub lines: Mutex<HashMap<(String, String), usize>>,
615 }
616
617 impl TestLogger {
618         pub fn new() -> TestLogger {
619                 Self::with_id("".to_owned())
620         }
621         pub fn with_id(id: String) -> TestLogger {
622                 TestLogger {
623                         level: Level::Trace,
624                         id,
625                         lines: Mutex::new(HashMap::new())
626                 }
627         }
628         pub fn enable(&mut self, level: Level) {
629                 self.level = level;
630         }
631         pub fn assert_log(&self, module: String, line: String, count: usize) {
632                 let log_entries = self.lines.lock().unwrap();
633                 assert_eq!(log_entries.get(&(module, line)), Some(&count));
634         }
635
636         /// Search for the number of occurrence of the logged lines which
637         /// 1. belongs to the specified module and
638         /// 2. contains `line` in it.
639         /// And asserts if the number of occurrences is the same with the given `count`
640         pub fn assert_log_contains(&self, module: String, line: String, count: usize) {
641                 let log_entries = self.lines.lock().unwrap();
642                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
643                         m == &module && l.contains(line.as_str())
644                 }).map(|(_, c) | { c }).sum();
645                 assert_eq!(l, count)
646         }
647
648         /// Search for the number of occurrences of logged lines which
649         /// 1. belong to the specified module and
650         /// 2. match the given regex pattern.
651         /// Assert that the number of occurrences equals the given `count`
652         pub fn assert_log_regex(&self, module: String, pattern: regex::Regex, count: usize) {
653                 let log_entries = self.lines.lock().unwrap();
654                 let l: usize = log_entries.iter().filter(|&(&(ref m, ref l), _c)| {
655                         m == &module && pattern.is_match(&l)
656                 }).map(|(_, c) | { c }).sum();
657                 assert_eq!(l, count)
658         }
659 }
660
661 impl Logger for TestLogger {
662         fn log(&self, record: &Record) {
663                 *self.lines.lock().unwrap().entry((record.module_path.to_string(), format!("{}", record.args))).or_insert(0) += 1;
664                 if record.level >= self.level {
665                         #[cfg(feature = "std")]
666                         println!("{:<5} {} [{} : {}, {}] {}", record.level.to_string(), self.id, record.module_path, record.file, record.line, record.args);
667                 }
668         }
669 }
670
671 pub struct TestNodeSigner {
672         node_secret: SecretKey,
673 }
674
675 impl TestNodeSigner {
676         pub fn new(node_secret: SecretKey) -> Self {
677                 Self { node_secret }
678         }
679 }
680
681 impl NodeSigner for TestNodeSigner {
682         fn get_inbound_payment_key_material(&self) -> crate::chain::keysinterface::KeyMaterial {
683                 unreachable!()
684         }
685
686         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
687                 let node_secret = match recipient {
688                         Recipient::Node => Ok(&self.node_secret),
689                         Recipient::PhantomNode => Err(())
690                 }?;
691                 Ok(PublicKey::from_secret_key(&Secp256k1::signing_only(), node_secret))
692         }
693
694         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&bitcoin::secp256k1::Scalar>) -> Result<SharedSecret, ()> {
695                 let mut node_secret = match recipient {
696                         Recipient::Node => Ok(self.node_secret.clone()),
697                         Recipient::PhantomNode => Err(())
698                 }?;
699                 if let Some(tweak) = tweak {
700                         node_secret = node_secret.mul_tweak(tweak).map_err(|_| ())?;
701                 }
702                 Ok(SharedSecret::new(other_key, &node_secret))
703         }
704
705         fn sign_invoice(&self, _: &[u8], _: &[bitcoin::bech32::u5], _: Recipient) -> Result<bitcoin::secp256k1::ecdsa::RecoverableSignature, ()> {
706                 unreachable!()
707         }
708
709         fn sign_gossip_message(&self, _msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
710                 unreachable!()
711         }
712 }
713
714 pub struct TestKeysInterface {
715         pub backing: keysinterface::PhantomKeysManager,
716         pub override_random_bytes: Mutex<Option<[u8; 32]>>,
717         pub disable_revocation_policy_check: bool,
718         enforcement_states: Mutex<HashMap<[u8;32], Arc<Mutex<EnforcementState>>>>,
719         expectations: Mutex<Option<VecDeque<OnGetShutdownScriptpubkey>>>,
720 }
721
722 impl EntropySource for TestKeysInterface {
723         fn get_secure_random_bytes(&self) -> [u8; 32] {
724                 let override_random_bytes = self.override_random_bytes.lock().unwrap();
725                 if let Some(bytes) = &*override_random_bytes {
726                         return *bytes;
727                 }
728                 self.backing.get_secure_random_bytes()
729         }
730 }
731
732 impl NodeSigner for TestKeysInterface {
733         fn get_node_id(&self, recipient: Recipient) -> Result<PublicKey, ()> {
734                 self.backing.get_node_id(recipient)
735         }
736
737         fn ecdh(&self, recipient: Recipient, other_key: &PublicKey, tweak: Option<&Scalar>) -> Result<SharedSecret, ()> {
738                 self.backing.ecdh(recipient, other_key, tweak)
739         }
740
741         fn get_inbound_payment_key_material(&self) -> keysinterface::KeyMaterial {
742                 self.backing.get_inbound_payment_key_material()
743         }
744
745         fn sign_invoice(&self, hrp_bytes: &[u8], invoice_data: &[u5], recipient: Recipient) -> Result<RecoverableSignature, ()> {
746                 self.backing.sign_invoice(hrp_bytes, invoice_data, recipient)
747         }
748
749         fn sign_gossip_message(&self, msg: msgs::UnsignedGossipMessage) -> Result<Signature, ()> {
750                 self.backing.sign_gossip_message(msg)
751         }
752 }
753
754 impl SignerProvider for TestKeysInterface {
755         type Signer = EnforcingSigner;
756
757         fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32] {
758                 self.backing.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id)
759         }
760
761         fn derive_channel_signer(&self, channel_value_satoshis: u64, channel_keys_id: [u8; 32]) -> EnforcingSigner {
762                 let keys = self.backing.derive_channel_signer(channel_value_satoshis, channel_keys_id);
763                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
764                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
765         }
766
767         fn read_chan_signer(&self, buffer: &[u8]) -> Result<Self::Signer, msgs::DecodeError> {
768                 let mut reader = io::Cursor::new(buffer);
769
770                 let inner: InMemorySigner = Readable::read(&mut reader)?;
771                 let state = self.make_enforcement_state_cell(inner.commitment_seed);
772
773                 Ok(EnforcingSigner::new_with_revoked(
774                         inner,
775                         state,
776                         self.disable_revocation_policy_check
777                 ))
778         }
779
780         fn get_destination_script(&self) -> Script { self.backing.get_destination_script() }
781
782         fn get_shutdown_scriptpubkey(&self) -> ShutdownScript {
783                 match &mut *self.expectations.lock().unwrap() {
784                         None => self.backing.get_shutdown_scriptpubkey(),
785                         Some(expectations) => match expectations.pop_front() {
786                                 None => panic!("Unexpected get_shutdown_scriptpubkey"),
787                                 Some(expectation) => expectation.returns,
788                         },
789                 }
790         }
791 }
792
793 impl TestKeysInterface {
794         pub fn new(seed: &[u8; 32], network: Network) -> Self {
795                 let now = Duration::from_secs(genesis_block(network).header.time as u64);
796                 Self {
797                         backing: keysinterface::PhantomKeysManager::new(seed, now.as_secs(), now.subsec_nanos(), seed),
798                         override_random_bytes: Mutex::new(None),
799                         disable_revocation_policy_check: false,
800                         enforcement_states: Mutex::new(HashMap::new()),
801                         expectations: Mutex::new(None),
802                 }
803         }
804
805         /// Sets an expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] is
806         /// called.
807         pub fn expect(&self, expectation: OnGetShutdownScriptpubkey) -> &Self {
808                 self.expectations.lock().unwrap()
809                         .get_or_insert_with(|| VecDeque::new())
810                         .push_back(expectation);
811                 self
812         }
813
814         pub fn derive_channel_keys(&self, channel_value_satoshis: u64, id: &[u8; 32]) -> EnforcingSigner {
815                 let keys = self.backing.derive_channel_keys(channel_value_satoshis, id);
816                 let state = self.make_enforcement_state_cell(keys.commitment_seed);
817                 EnforcingSigner::new_with_revoked(keys, state, self.disable_revocation_policy_check)
818         }
819
820         fn make_enforcement_state_cell(&self, commitment_seed: [u8; 32]) -> Arc<Mutex<EnforcementState>> {
821                 let mut states = self.enforcement_states.lock().unwrap();
822                 if !states.contains_key(&commitment_seed) {
823                         let state = EnforcementState::new();
824                         states.insert(commitment_seed, Arc::new(Mutex::new(state)));
825                 }
826                 let cell = states.get(&commitment_seed).unwrap();
827                 Arc::clone(cell)
828         }
829 }
830
831 pub(crate) fn panicking() -> bool {
832         #[cfg(feature = "std")]
833         let panicking = ::std::thread::panicking();
834         #[cfg(not(feature = "std"))]
835         let panicking = false;
836         return panicking;
837 }
838
839 impl Drop for TestKeysInterface {
840         fn drop(&mut self) {
841                 if panicking() {
842                         return;
843                 }
844
845                 if let Some(expectations) = &*self.expectations.lock().unwrap() {
846                         if !expectations.is_empty() {
847                                 panic!("Unsatisfied expectations: {:?}", expectations);
848                         }
849                 }
850         }
851 }
852
853 /// An expectation that [`keysinterface::SignerProvider::get_shutdown_scriptpubkey`] was called and
854 /// returns a [`ShutdownScript`].
855 pub struct OnGetShutdownScriptpubkey {
856         /// A shutdown script used to close a channel.
857         pub returns: ShutdownScript,
858 }
859
860 impl core::fmt::Debug for OnGetShutdownScriptpubkey {
861         fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
862                 f.debug_struct("OnGetShutdownScriptpubkey").finish()
863         }
864 }
865
866 pub struct TestChainSource {
867         pub genesis_hash: BlockHash,
868         pub utxo_ret: Mutex<UtxoResult>,
869         pub get_utxo_call_count: AtomicUsize,
870         pub watched_txn: Mutex<HashSet<(Txid, Script)>>,
871         pub watched_outputs: Mutex<HashSet<(OutPoint, Script)>>,
872 }
873
874 impl TestChainSource {
875         pub fn new(network: Network) -> Self {
876                 let script_pubkey = Builder::new().push_opcode(opcodes::OP_TRUE).into_script();
877                 Self {
878                         genesis_hash: genesis_block(network).block_hash(),
879                         utxo_ret: Mutex::new(UtxoResult::Sync(Ok(TxOut { value: u64::max_value(), script_pubkey }))),
880                         get_utxo_call_count: AtomicUsize::new(0),
881                         watched_txn: Mutex::new(HashSet::new()),
882                         watched_outputs: Mutex::new(HashSet::new()),
883                 }
884         }
885 }
886
887 impl UtxoLookup for TestChainSource {
888         fn get_utxo(&self, genesis_hash: &BlockHash, _short_channel_id: u64) -> UtxoResult {
889                 self.get_utxo_call_count.fetch_add(1, Ordering::Relaxed);
890                 if self.genesis_hash != *genesis_hash {
891                         return UtxoResult::Sync(Err(UtxoLookupError::UnknownChain));
892                 }
893
894                 self.utxo_ret.lock().unwrap().clone()
895         }
896 }
897
898 impl chain::Filter for TestChainSource {
899         fn register_tx(&self, txid: &Txid, script_pubkey: &Script) {
900                 self.watched_txn.lock().unwrap().insert((*txid, script_pubkey.clone()));
901         }
902
903         fn register_output(&self, output: WatchedOutput) {
904                 self.watched_outputs.lock().unwrap().insert((output.outpoint, output.script_pubkey));
905         }
906 }
907
908 impl Drop for TestChainSource {
909         fn drop(&mut self) {
910                 if panicking() {
911                         return;
912                 }
913         }
914 }
915
916 pub struct TestScorer {
917         /// Stores a tuple of (scid, ChannelUsage)
918         scorer_expectations: RefCell<Option<VecDeque<(u64, ChannelUsage)>>>,
919 }
920
921 impl TestScorer {
922         pub fn new() -> Self {
923                 Self {
924                         scorer_expectations: RefCell::new(None),
925                 }
926         }
927
928         pub fn expect_usage(&self, scid: u64, expectation: ChannelUsage) {
929                 self.scorer_expectations.borrow_mut().get_or_insert_with(|| VecDeque::new()).push_back((scid, expectation));
930         }
931 }
932
933 #[cfg(c_bindings)]
934 impl crate::util::ser::Writeable for TestScorer {
935         fn write<W: crate::util::ser::Writer>(&self, _: &mut W) -> Result<(), crate::io::Error> { unreachable!(); }
936 }
937
938 impl Score for TestScorer {
939         fn channel_penalty_msat(
940                 &self, short_channel_id: u64, _source: &NodeId, _target: &NodeId, usage: ChannelUsage
941         ) -> u64 {
942                 if let Some(scorer_expectations) = self.scorer_expectations.borrow_mut().as_mut() {
943                         match scorer_expectations.pop_front() {
944                                 Some((scid, expectation)) => {
945                                         assert_eq!(expectation, usage);
946                                         assert_eq!(scid, short_channel_id);
947                                 },
948                                 None => {},
949                         }
950                 }
951                 0
952         }
953
954         fn payment_path_failed(&mut self, _actual_path: &[&RouteHop], _actual_short_channel_id: u64) {}
955
956         fn payment_path_successful(&mut self, _actual_path: &[&RouteHop]) {}
957
958         fn probe_failed(&mut self, _actual_path: &[&RouteHop], _: u64) {}
959
960         fn probe_successful(&mut self, _actual_path: &[&RouteHop]) {}
961 }
962
963 impl Drop for TestScorer {
964         fn drop(&mut self) {
965                 #[cfg(feature = "std")] {
966                         if std::thread::panicking() {
967                                 return;
968                         }
969                 }
970
971                 if let Some(scorer_expectations) = self.scorer_expectations.borrow().as_ref() {
972                         if !scorer_expectations.is_empty() {
973                                 panic!("Unsatisfied scorer expectations: {:?}", scorer_expectations)
974                         }
975                 }
976         }
977 }