Test that we don't forget to track any outputs at monitor-load
[rust-lightning] / lightning / src / ln / functional_test_utils.rs
1 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
2 //! nodes for functional tests.
3
4 use chain::chaininterface;
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::KeysInterface;
7 use ln::channelmanager::{ChannelManager,RAACommitmentOrder, PaymentPreimage, PaymentHash};
8 use ln::channelmonitor::{ChannelMonitor, ManyChannelMonitor};
9 use ln::router::{Route, Router};
10 use ln::features::InitFeatures;
11 use ln::msgs;
12 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
13 use util::enforcing_trait_impls::EnforcingChannelKeys;
14 use util::test_utils;
15 use util::test_utils::TestChannelMonitor;
16 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
17 use util::errors::APIError;
18 use util::logger::Logger;
19 use util::config::UserConfig;
20 use util::ser::ReadableArgs;
21
22 use bitcoin::util::hash::BitcoinHash;
23 use bitcoin::blockdata::block::BlockHeader;
24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
25 use bitcoin::network::constants::Network;
26
27 use bitcoin_hashes::sha256::Hash as Sha256;
28 use bitcoin_hashes::sha256d::Hash as Sha256d;
29 use bitcoin_hashes::Hash;
30
31 use secp256k1::Secp256k1;
32 use secp256k1::key::PublicKey;
33
34 use rand::{thread_rng,Rng};
35
36 use std::cell::RefCell;
37 use std::rc::Rc;
38 use std::sync::{Arc, Mutex};
39 use std::mem;
40 use std::collections::HashSet;
41
42 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
43 pub fn confirm_transaction<'a, 'b: 'a>(notifier: &'a chaininterface::BlockNotifierRef<'b>, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
44         assert!(chain.does_match_tx(tx));
45         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
46         notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
47         for i in 2..CHAN_CONFIRM_DEPTH {
48                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
49                 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
50         }
51 }
52
53 pub fn connect_blocks<'a, 'b>(notifier: &'a chaininterface::BlockNotifierRef<'b>, depth: u32, height: u32, parent: bool, prev_blockhash: Sha256d) -> Sha256d {
54         let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
55         notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
56         for i in 2..depth + 1 {
57                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
58                 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
59         }
60         header.bitcoin_hash()
61 }
62
63 pub struct NodeCfg {
64         pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
65         pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
66         pub fee_estimator: Arc<test_utils::TestFeeEstimator>,
67         pub chan_monitor: test_utils::TestChannelMonitor,
68         pub keys_manager: Arc<test_utils::TestKeysInterface>,
69         pub logger: Arc<test_utils::TestLogger>,
70         pub node_seed: [u8; 32],
71 }
72
73 pub struct Node<'a, 'b: 'a> {
74         pub block_notifier: chaininterface::BlockNotifierRef<'b>,
75         pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
76         pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
77         pub chan_monitor: &'b test_utils::TestChannelMonitor,
78         pub keys_manager: Arc<test_utils::TestKeysInterface>,
79         pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor>,
80         pub router: Router,
81         pub node_seed: [u8; 32],
82         pub network_payment_count: Rc<RefCell<u8>>,
83         pub network_chan_count: Rc<RefCell<u32>>,
84         pub logger: Arc<test_utils::TestLogger>
85 }
86
87 impl<'a, 'b> Drop for Node<'a, 'b> {
88         fn drop(&mut self) {
89                 if !::std::thread::panicking() {
90                         // Check that we processed all pending events
91                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
92                         assert!(self.node.get_and_clear_pending_events().is_empty());
93                         assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
94
95                         // Check that if we serialize and then deserialize all our channel monitors we get the
96                         // same set of outputs to watch for on chain as we have now. Note that if we write
97                         // tests that fully close channels and remove the monitors at some point this may break.
98                         let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
99                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
100                         let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), feeest);
101                         let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
102                         for (_, old_monitor) in old_monitors.iter() {
103                                 let mut w = test_utils::TestVecWriter(Vec::new());
104                                 old_monitor.write_for_disk(&mut w).unwrap();
105                                 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
106                                         &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
107                                 if let Err(_) = channel_monitor.add_update_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
108                                         panic!();
109                                 }
110                         }
111
112                         if *chain_watch != *self.chain_monitor {
113                                 panic!();
114                         }
115                 }
116         }
117 }
118
119 pub fn create_chan_between_nodes<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
120         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
121 }
122
123 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
124         let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
125         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
126         (announcement, as_update, bs_update, channel_id, tx)
127 }
128
129 macro_rules! get_revoke_commit_msgs {
130         ($node: expr, $node_id: expr) => {
131                 {
132                         let events = $node.node.get_and_clear_pending_msg_events();
133                         assert_eq!(events.len(), 2);
134                         (match events[0] {
135                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
136                                         assert_eq!(*node_id, $node_id);
137                                         (*msg).clone()
138                                 },
139                                 _ => panic!("Unexpected event"),
140                         }, match events[1] {
141                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
142                                         assert_eq!(*node_id, $node_id);
143                                         assert!(updates.update_add_htlcs.is_empty());
144                                         assert!(updates.update_fulfill_htlcs.is_empty());
145                                         assert!(updates.update_fail_htlcs.is_empty());
146                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
147                                         assert!(updates.update_fee.is_none());
148                                         updates.commitment_signed.clone()
149                                 },
150                                 _ => panic!("Unexpected event"),
151                         })
152                 }
153         }
154 }
155
156 macro_rules! get_event_msg {
157         ($node: expr, $event_type: path, $node_id: expr) => {
158                 {
159                         let events = $node.node.get_and_clear_pending_msg_events();
160                         assert_eq!(events.len(), 1);
161                         match events[0] {
162                                 $event_type { ref node_id, ref msg } => {
163                                         assert_eq!(*node_id, $node_id);
164                                         (*msg).clone()
165                                 },
166                                 _ => panic!("Unexpected event"),
167                         }
168                 }
169         }
170 }
171
172 macro_rules! get_htlc_update_msgs {
173         ($node: expr, $node_id: expr) => {
174                 {
175                         let events = $node.node.get_and_clear_pending_msg_events();
176                         assert_eq!(events.len(), 1);
177                         match events[0] {
178                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
179                                         assert_eq!(*node_id, $node_id);
180                                         (*updates).clone()
181                                 },
182                                 _ => panic!("Unexpected event"),
183                         }
184                 }
185         }
186 }
187
188 macro_rules! get_feerate {
189         ($node: expr, $channel_id: expr) => {
190                 {
191                         let chan_lock = $node.node.channel_state.lock().unwrap();
192                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
193                         chan.get_feerate()
194                 }
195         }
196 }
197
198 pub fn create_funding_transaction<'a, 'b>(node: &Node<'a, 'b>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
199         let chan_id = *node.network_chan_count.borrow();
200
201         let events = node.node.get_and_clear_pending_events();
202         assert_eq!(events.len(), 1);
203         match events[0] {
204                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
205                         assert_eq!(*channel_value_satoshis, expected_chan_value);
206                         assert_eq!(user_channel_id, expected_user_chan_id);
207
208                         let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
209                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
210                         }]};
211                         let funding_outpoint = OutPoint::new(tx.txid(), 0);
212                         (*temporary_channel_id, tx, funding_outpoint)
213                 },
214                 _ => panic!("Unexpected event"),
215         }
216 }
217
218 pub fn create_chan_between_nodes_with_value_init<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> Transaction {
219         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
220         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
221         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
222
223         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
224
225         {
226                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
227                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
228                 assert_eq!(added_monitors.len(), 1);
229                 assert_eq!(added_monitors[0].0, funding_output);
230                 added_monitors.clear();
231         }
232
233         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
234         {
235                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
236                 assert_eq!(added_monitors.len(), 1);
237                 assert_eq!(added_monitors[0].0, funding_output);
238                 added_monitors.clear();
239         }
240
241         node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id()));
242         {
243                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
244                 assert_eq!(added_monitors.len(), 1);
245                 assert_eq!(added_monitors[0].0, funding_output);
246                 added_monitors.clear();
247         }
248
249         let events_4 = node_a.node.get_and_clear_pending_events();
250         assert_eq!(events_4.len(), 1);
251         match events_4[0] {
252                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
253                         assert_eq!(user_channel_id, 42);
254                         assert_eq!(*funding_txo, funding_output);
255                 },
256                 _ => panic!("Unexpected event"),
257         };
258
259         tx
260 }
261
262 pub fn create_chan_between_nodes_with_value_confirm_first<'a, 'b, 'c>(node_recv: &'a Node<'a, 'b>, node_conf: &'a Node<'a, 'b>, tx: &Transaction) {
263         confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
264         node_recv.node.handle_funding_locked(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendFundingLocked, node_recv.node.get_our_node_id()));
265 }
266
267 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b>(node_recv: &Node<'a, 'b>, node_conf: &Node<'a, 'b>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
268         let channel_id;
269         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
270         assert_eq!(events_6.len(), 2);
271         ((match events_6[0] {
272                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
273                         channel_id = msg.channel_id.clone();
274                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
275                         msg.clone()
276                 },
277                 _ => panic!("Unexpected event"),
278         }, match events_6[1] {
279                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
280                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
281                         msg.clone()
282                 },
283                 _ => panic!("Unexpected event"),
284         }), channel_id)
285 }
286
287 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
288         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
289         confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
290         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
291 }
292
293 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
294         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
295         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
296         (msgs, chan_id, tx)
297 }
298
299 pub fn create_chan_between_nodes_with_value_b<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
300         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
301         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
302         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
303
304         let events_7 = node_b.node.get_and_clear_pending_msg_events();
305         assert_eq!(events_7.len(), 1);
306         let (announcement, bs_update) = match events_7[0] {
307                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
308                         (msg, update_msg)
309                 },
310                 _ => panic!("Unexpected event"),
311         };
312
313         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
314         let events_8 = node_a.node.get_and_clear_pending_msg_events();
315         assert_eq!(events_8.len(), 1);
316         let as_update = match events_8[0] {
317                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
318                         assert!(*announcement == *msg);
319                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
320                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
321                         update_msg
322                 },
323                 _ => panic!("Unexpected event"),
324         };
325
326         *node_a.network_chan_count.borrow_mut() += 1;
327
328         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
329 }
330
331 pub fn create_announced_chan_between_nodes<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
332         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
333 }
334
335 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
336         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
337         for node in nodes {
338                 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
339                 node.router.handle_channel_update(&chan_announcement.1).unwrap();
340                 node.router.handle_channel_update(&chan_announcement.2).unwrap();
341         }
342         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
343 }
344
345 macro_rules! check_spends {
346         ($tx: expr, $spends_tx: expr) => {
347                 {
348                         $tx.verify(|out_point| {
349                                 if out_point.txid == $spends_tx.txid() {
350                                         $spends_tx.output.get(out_point.vout as usize).cloned()
351                                 } else {
352                                         None
353                                 }
354                         }).unwrap();
355                 }
356         }
357 }
358
359 macro_rules! get_closing_signed_broadcast {
360         ($node: expr, $dest_pubkey: expr) => {
361                 {
362                         let events = $node.get_and_clear_pending_msg_events();
363                         assert!(events.len() == 1 || events.len() == 2);
364                         (match events[events.len() - 1] {
365                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
366                                         assert_eq!(msg.contents.flags & 2, 2);
367                                         msg.clone()
368                                 },
369                                 _ => panic!("Unexpected event"),
370                         }, if events.len() == 2 {
371                                 match events[0] {
372                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
373                                                 assert_eq!(*node_id, $dest_pubkey);
374                                                 Some(msg.clone())
375                                         },
376                                         _ => panic!("Unexpected event"),
377                                 }
378                         } else { None })
379                 }
380         }
381 }
382
383 macro_rules! check_closed_broadcast {
384         ($node: expr, $with_error_msg: expr) => {{
385                 let events = $node.node.get_and_clear_pending_msg_events();
386                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
387                 match events[0] {
388                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
389                                 assert_eq!(msg.contents.flags & 2, 2);
390                         },
391                         _ => panic!("Unexpected event"),
392                 }
393                 if $with_error_msg {
394                         match events[1] {
395                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
396                                         // TODO: Check node_id
397                                         Some(msg.clone())
398                                 },
399                                 _ => panic!("Unexpected event"),
400                         }
401                 } else { None }
402         }}
403 }
404
405 pub fn close_channel<'a, 'b>(outbound_node: &Node<'a, 'b>, inbound_node: &Node<'a, 'b>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
406         let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
407         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
408         let (tx_a, tx_b);
409
410         node_a.close_channel(channel_id).unwrap();
411         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
412
413         let events_1 = node_b.get_and_clear_pending_msg_events();
414         assert!(events_1.len() >= 1);
415         let shutdown_b = match events_1[0] {
416                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
417                         assert_eq!(node_id, &node_a.get_our_node_id());
418                         msg.clone()
419                 },
420                 _ => panic!("Unexpected event"),
421         };
422
423         let closing_signed_b = if !close_inbound_first {
424                 assert_eq!(events_1.len(), 1);
425                 None
426         } else {
427                 Some(match events_1[1] {
428                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
429                                 assert_eq!(node_id, &node_a.get_our_node_id());
430                                 msg.clone()
431                         },
432                         _ => panic!("Unexpected event"),
433                 })
434         };
435
436         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
437         let (as_update, bs_update) = if close_inbound_first {
438                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
439                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
440                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
441                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
442                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
443
444                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
445                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
446                 assert!(none_b.is_none());
447                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
448                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
449                 (as_update, bs_update)
450         } else {
451                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
452
453                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
454                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
455                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
456                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
457
458                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
459                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
460                 assert!(none_a.is_none());
461                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
462                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
463                 (as_update, bs_update)
464         };
465         assert_eq!(tx_a, tx_b);
466         check_spends!(tx_a, funding_tx);
467
468         (as_update, bs_update, tx_a)
469 }
470
471 pub struct SendEvent {
472         pub node_id: PublicKey,
473         pub msgs: Vec<msgs::UpdateAddHTLC>,
474         pub commitment_msg: msgs::CommitmentSigned,
475 }
476 impl SendEvent {
477         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
478                 assert!(updates.update_fulfill_htlcs.is_empty());
479                 assert!(updates.update_fail_htlcs.is_empty());
480                 assert!(updates.update_fail_malformed_htlcs.is_empty());
481                 assert!(updates.update_fee.is_none());
482                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
483         }
484
485         pub fn from_event(event: MessageSendEvent) -> SendEvent {
486                 match event {
487                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
488                         _ => panic!("Unexpected event type!"),
489                 }
490         }
491
492         pub fn from_node<'a, 'b>(node: &Node<'a, 'b>) -> SendEvent {
493                 let mut events = node.node.get_and_clear_pending_msg_events();
494                 assert_eq!(events.len(), 1);
495                 SendEvent::from_event(events.pop().unwrap())
496         }
497 }
498
499 macro_rules! check_added_monitors {
500         ($node: expr, $count: expr) => {
501                 {
502                         let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
503                         assert_eq!(added_monitors.len(), $count);
504                         added_monitors.clear();
505                 }
506         }
507 }
508
509 macro_rules! commitment_signed_dance {
510         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
511                 {
512                         check_added_monitors!($node_a, 0);
513                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
514                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
515                         check_added_monitors!($node_a, 1);
516                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
517                 }
518         };
519         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
520                 {
521                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
522                         check_added_monitors!($node_b, 0);
523                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
524                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
525                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
526                         check_added_monitors!($node_b, 1);
527                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
528                         let (bs_revoke_and_ack, extra_msg_option) = {
529                                 let events = $node_b.node.get_and_clear_pending_msg_events();
530                                 assert!(events.len() <= 2);
531                                 (match events[0] {
532                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
533                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
534                                                 (*msg).clone()
535                                         },
536                                         _ => panic!("Unexpected event"),
537                                 }, events.get(1).map(|e| e.clone()))
538                         };
539                         check_added_monitors!($node_b, 1);
540                         if $fail_backwards {
541                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
542                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
543                         }
544                         (extra_msg_option, bs_revoke_and_ack)
545                 }
546         };
547         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
548                 {
549                         check_added_monitors!($node_a, 0);
550                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
551                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
552                         check_added_monitors!($node_a, 1);
553                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
554                         assert!(extra_msg_option.is_none());
555                         bs_revoke_and_ack
556                 }
557         };
558         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
559                 {
560                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
561                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
562                         check_added_monitors!($node_a, 1);
563                         extra_msg_option
564                 }
565         };
566         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
567                 {
568                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
569                 }
570         };
571         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
572                 {
573                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
574                         if $fail_backwards {
575                                 expect_pending_htlcs_forwardable!($node_a);
576                                 check_added_monitors!($node_a, 1);
577
578                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
579                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
580                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
581                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
582                                 } else { panic!("Unexpected event"); }
583                         } else {
584                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
585                         }
586                 }
587         }
588 }
589
590 macro_rules! get_payment_preimage_hash {
591         ($node: expr) => {
592                 {
593                         let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
594                         *$node.network_payment_count.borrow_mut() += 1;
595                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
596                         (payment_preimage, payment_hash)
597                 }
598         }
599 }
600
601 macro_rules! expect_pending_htlcs_forwardable {
602         ($node: expr) => {{
603                 let events = $node.node.get_and_clear_pending_events();
604                 assert_eq!(events.len(), 1);
605                 match events[0] {
606                         Event::PendingHTLCsForwardable { .. } => { },
607                         _ => panic!("Unexpected event"),
608                 };
609                 $node.node.process_pending_htlc_forwards();
610         }}
611 }
612
613 macro_rules! expect_payment_received {
614         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
615                 let events = $node.node.get_and_clear_pending_events();
616                 assert_eq!(events.len(), 1);
617                 match events[0] {
618                         Event::PaymentReceived { ref payment_hash, amt } => {
619                                 assert_eq!($expected_payment_hash, *payment_hash);
620                                 assert_eq!($expected_recv_value, amt);
621                         },
622                         _ => panic!("Unexpected event"),
623                 }
624         }
625 }
626
627 macro_rules! expect_payment_sent {
628         ($node: expr, $expected_payment_preimage: expr) => {
629                 let events = $node.node.get_and_clear_pending_events();
630                 assert_eq!(events.len(), 1);
631                 match events[0] {
632                         Event::PaymentSent { ref payment_preimage } => {
633                                 assert_eq!($expected_payment_preimage, *payment_preimage);
634                         },
635                         _ => panic!("Unexpected event"),
636                 }
637         }
638 }
639
640 pub fn send_along_route_with_hash<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64, our_payment_hash: PaymentHash) {
641         let mut payment_event = {
642                 origin_node.node.send_payment(route, our_payment_hash).unwrap();
643                 check_added_monitors!(origin_node, 1);
644
645                 let mut events = origin_node.node.get_and_clear_pending_msg_events();
646                 assert_eq!(events.len(), 1);
647                 SendEvent::from_event(events.remove(0))
648         };
649         let mut prev_node = origin_node;
650
651         for (idx, &node) in expected_route.iter().enumerate() {
652                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
653
654                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
655                 check_added_monitors!(node, 0);
656                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
657
658                 expect_pending_htlcs_forwardable!(node);
659
660                 if idx == expected_route.len() - 1 {
661                         let events_2 = node.node.get_and_clear_pending_events();
662                         assert_eq!(events_2.len(), 1);
663                         match events_2[0] {
664                                 Event::PaymentReceived { ref payment_hash, amt } => {
665                                         assert_eq!(our_payment_hash, *payment_hash);
666                                         assert_eq!(amt, recv_value);
667                                 },
668                                 _ => panic!("Unexpected event"),
669                         }
670                 } else {
671                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
672                         assert_eq!(events_2.len(), 1);
673                         check_added_monitors!(node, 1);
674                         payment_event = SendEvent::from_event(events_2.remove(0));
675                         assert_eq!(payment_event.msgs.len(), 1);
676                 }
677
678                 prev_node = node;
679         }
680 }
681
682 pub fn send_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
683         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
684         send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
685         (our_payment_preimage, our_payment_hash)
686 }
687
688 pub fn claim_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
689         assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
690         check_added_monitors!(expected_route.last().unwrap(), 1);
691
692         let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
693         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
694         macro_rules! get_next_msgs {
695                 ($node: expr) => {
696                         {
697                                 let events = $node.node.get_and_clear_pending_msg_events();
698                                 assert_eq!(events.len(), 1);
699                                 match events[0] {
700                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
701                                                 assert!(update_add_htlcs.is_empty());
702                                                 assert_eq!(update_fulfill_htlcs.len(), 1);
703                                                 assert!(update_fail_htlcs.is_empty());
704                                                 assert!(update_fail_malformed_htlcs.is_empty());
705                                                 assert!(update_fee.is_none());
706                                                 expected_next_node = node_id.clone();
707                                                 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
708                                         },
709                                         _ => panic!("Unexpected event"),
710                                 }
711                         }
712                 }
713         }
714
715         macro_rules! last_update_fulfill_dance {
716                 ($node: expr, $prev_node: expr) => {
717                         {
718                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
719                                 check_added_monitors!($node, 0);
720                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
721                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
722                         }
723                 }
724         }
725         macro_rules! mid_update_fulfill_dance {
726                 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
727                         {
728                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
729                                 check_added_monitors!($node, 1);
730                                 let new_next_msgs = if $new_msgs {
731                                         get_next_msgs!($node)
732                                 } else {
733                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
734                                         None
735                                 };
736                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
737                                 next_msgs = new_next_msgs;
738                         }
739                 }
740         }
741
742         let mut prev_node = expected_route.last().unwrap();
743         for (idx, node) in expected_route.iter().rev().enumerate() {
744                 assert_eq!(expected_next_node, node.node.get_our_node_id());
745                 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
746                 if next_msgs.is_some() {
747                         mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
748                 } else if update_next_msgs {
749                         next_msgs = get_next_msgs!(node);
750                 } else {
751                         assert!(node.node.get_and_clear_pending_msg_events().is_empty());
752                 }
753                 if !skip_last && idx == expected_route.len() - 1 {
754                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
755                 }
756
757                 prev_node = node;
758         }
759
760         if !skip_last {
761                 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
762                 expect_payment_sent!(origin_node, our_payment_preimage);
763         }
764 }
765
766 pub fn claim_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
767         claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
768 }
769
770 pub const TEST_FINAL_CLTV: u32 = 32;
771
772 pub fn route_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
773         let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
774         assert_eq!(route.hops.len(), expected_route.len());
775         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
776                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
777         }
778
779         send_along_route(origin_node, route, expected_route, recv_value)
780 }
781
782 pub fn route_over_limit<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64)  {
783         let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
784         assert_eq!(route.hops.len(), expected_route.len());
785         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
786                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
787         }
788
789         let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
790
791         let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
792         match err {
793                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
794                 _ => panic!("Unknown error variants"),
795         };
796 }
797
798 pub fn send_payment<'a, 'b>(origin: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64, expected_value: u64)  {
799         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
800         claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
801 }
802
803 pub fn fail_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_hash: PaymentHash)  {
804         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
805         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
806         check_added_monitors!(expected_route.last().unwrap(), 1);
807
808         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
809         macro_rules! update_fail_dance {
810                 ($node: expr, $prev_node: expr, $last_node: expr) => {
811                         {
812                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
813                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
814                                 if skip_last && $last_node {
815                                         expect_pending_htlcs_forwardable!($node);
816                                 }
817                         }
818                 }
819         }
820
821         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
822         let mut prev_node = expected_route.last().unwrap();
823         for (idx, node) in expected_route.iter().rev().enumerate() {
824                 assert_eq!(expected_next_node, node.node.get_our_node_id());
825                 if next_msgs.is_some() {
826                         // We may be the "last node" for the purpose of the commitment dance if we're
827                         // skipping the last node (implying it is disconnected) and we're the
828                         // second-to-last node!
829                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
830                 }
831
832                 let events = node.node.get_and_clear_pending_msg_events();
833                 if !skip_last || idx != expected_route.len() - 1 {
834                         assert_eq!(events.len(), 1);
835                         match events[0] {
836                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
837                                         assert!(update_add_htlcs.is_empty());
838                                         assert!(update_fulfill_htlcs.is_empty());
839                                         assert_eq!(update_fail_htlcs.len(), 1);
840                                         assert!(update_fail_malformed_htlcs.is_empty());
841                                         assert!(update_fee.is_none());
842                                         expected_next_node = node_id.clone();
843                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
844                                 },
845                                 _ => panic!("Unexpected event"),
846                         }
847                 } else {
848                         assert!(events.is_empty());
849                 }
850                 if !skip_last && idx == expected_route.len() - 1 {
851                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
852                 }
853
854                 prev_node = node;
855         }
856
857         if !skip_last {
858                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
859
860                 let events = origin_node.node.get_and_clear_pending_events();
861                 assert_eq!(events.len(), 1);
862                 match events[0] {
863                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
864                                 assert_eq!(payment_hash, our_payment_hash);
865                                 assert!(rejected_by_dest);
866                         },
867                         _ => panic!("Unexpected event"),
868                 }
869         }
870 }
871
872 pub fn fail_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_hash: PaymentHash)  {
873         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
874 }
875
876 pub fn create_node_cfgs(node_count: usize) -> Vec<NodeCfg> {
877         let mut nodes = Vec::new();
878         let mut rng = thread_rng();
879
880         for i in 0..node_count {
881                 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
882                 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
883                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
884                 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
885                 let mut seed = [0; 32];
886                 rng.fill_bytes(&mut seed);
887                 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>));
888                 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone());
889                 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster, fee_estimator, chan_monitor, keys_manager, node_seed: seed });
890         }
891
892         nodes
893 }
894
895 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>> {
896         let mut chanmgrs = Vec::new();
897         for i in 0..node_count {
898                 let mut default_config = UserConfig::default();
899                 default_config.channel_options.announced_channel = true;
900                 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
901                 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator.clone(), &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster.clone(), cfgs[i].logger.clone(), cfgs[i].keys_manager.clone(), if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
902                 chanmgrs.push(node);
903         }
904
905         chanmgrs
906 }
907
908 pub fn create_network<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, chan_mgrs: &'b Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>>) -> Vec<Node<'a, 'b>> {
909         let secp_ctx = Secp256k1::new();
910         let mut nodes = Vec::new();
911         let chan_count = Rc::new(RefCell::new(0));
912         let payment_count = Rc::new(RefCell::new(0));
913
914         for i in 0..node_count {
915                 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
916                 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
917                 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
918                 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &cfgs[i].keys_manager.get_node_secret()), cfgs[i].chain_monitor.clone(), cfgs[i].logger.clone() as Arc<Logger>);
919                 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
920                                                                                  tx_broadcaster: cfgs[i].tx_broadcaster.clone(), chan_monitor: &cfgs[i].chan_monitor,
921                                                                                  keys_manager: cfgs[i].keys_manager.clone(), node: &chan_mgrs[i], router,
922                                                                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
923                                                                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
924                 })
925         }
926
927         nodes
928 }
929
930 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
931 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
932
933 #[derive(PartialEq)]
934 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
935 /// Tests that the given node has broadcast transactions for the given Channel
936 ///
937 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
938 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
939 /// broadcast and the revoked outputs were claimed.
940 ///
941 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
942 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
943 ///
944 /// All broadcast transactions must be accounted for in one of the above three types of we'll
945 /// also fail.
946 pub fn test_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction>  {
947         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
948         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
949
950         let mut res = Vec::with_capacity(2);
951         node_txn.retain(|tx| {
952                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
953                         check_spends!(tx, chan.3.clone());
954                         if commitment_tx.is_none() {
955                                 res.push(tx.clone());
956                         }
957                         false
958                 } else { true }
959         });
960         if let Some(explicit_tx) = commitment_tx {
961                 res.push(explicit_tx.clone());
962         }
963
964         assert_eq!(res.len(), 1);
965
966         if has_htlc_tx != HTLCType::NONE {
967                 node_txn.retain(|tx| {
968                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
969                                 check_spends!(tx, res[0].clone());
970                                 if has_htlc_tx == HTLCType::TIMEOUT {
971                                         assert!(tx.lock_time != 0);
972                                 } else {
973                                         assert!(tx.lock_time == 0);
974                                 }
975                                 res.push(tx.clone());
976                                 false
977                         } else { true }
978                 });
979                 assert!(res.len() == 2 || res.len() == 3);
980                 if res.len() == 3 {
981                         assert_eq!(res[1], res[2]);
982                 }
983         }
984
985         assert!(node_txn.is_empty());
986         res
987 }
988
989 /// Tests that the given node has broadcast a claim transaction against the provided revoked
990 /// HTLC transaction.
991 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
992         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
993         // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
994         // but sometimes not as feerate is too-low
995         if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
996         node_txn.retain(|tx| {
997                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
998                         check_spends!(tx, revoked_tx);
999                         false
1000                 } else { true }
1001         });
1002         node_txn.retain(|tx| {
1003                 check_spends!(tx, commitment_revoked_tx);
1004                 false
1005         });
1006         assert!(node_txn.is_empty());
1007 }
1008
1009 pub fn check_preimage_claim<'a, 'b>(node: &Node<'a, 'b>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1010         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1011
1012         assert!(node_txn.len() >= 1);
1013         assert_eq!(node_txn[0].input.len(), 1);
1014         let mut found_prev = false;
1015
1016         for tx in prev_txn {
1017                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1018                         check_spends!(node_txn[0], tx.clone());
1019                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1020                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1021
1022                         found_prev = true;
1023                         break;
1024                 }
1025         }
1026         assert!(found_prev);
1027
1028         let mut res = Vec::new();
1029         mem::swap(&mut *node_txn, &mut res);
1030         res
1031 }
1032
1033 pub fn get_announce_close_broadcast_events<'a, 'b>(nodes: &Vec<Node<'a, 'b>>, a: usize, b: usize)  {
1034         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1035         assert_eq!(events_1.len(), 1);
1036         let as_update = match events_1[0] {
1037                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1038                         msg.clone()
1039                 },
1040                 _ => panic!("Unexpected event"),
1041         };
1042
1043         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1044         assert_eq!(events_2.len(), 1);
1045         let bs_update = match events_2[0] {
1046                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1047                         msg.clone()
1048                 },
1049                 _ => panic!("Unexpected event"),
1050         };
1051
1052         for node in nodes {
1053                 node.router.handle_channel_update(&as_update).unwrap();
1054                 node.router.handle_channel_update(&bs_update).unwrap();
1055         }
1056 }
1057
1058 macro_rules! get_channel_value_stat {
1059         ($node: expr, $channel_id: expr) => {{
1060                 let chan_lock = $node.node.channel_state.lock().unwrap();
1061                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1062                 chan.get_value_stat()
1063         }}
1064 }
1065
1066 macro_rules! get_chan_reestablish_msgs {
1067         ($src_node: expr, $dst_node: expr) => {
1068                 {
1069                         let mut res = Vec::with_capacity(1);
1070                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1071                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1072                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1073                                         res.push(msg.clone());
1074                                 } else {
1075                                         panic!("Unexpected event")
1076                                 }
1077                         }
1078                         res
1079                 }
1080         }
1081 }
1082
1083 macro_rules! handle_chan_reestablish_msgs {
1084         ($src_node: expr, $dst_node: expr) => {
1085                 {
1086                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1087                         let mut idx = 0;
1088                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1089                                 idx += 1;
1090                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1091                                 Some(msg.clone())
1092                         } else {
1093                                 None
1094                         };
1095
1096                         let mut revoke_and_ack = None;
1097                         let mut commitment_update = None;
1098                         let order = if let Some(ev) = msg_events.get(idx) {
1099                                 idx += 1;
1100                                 match ev {
1101                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1102                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1103                                                 revoke_and_ack = Some(msg.clone());
1104                                                 RAACommitmentOrder::RevokeAndACKFirst
1105                                         },
1106                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1107                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1108                                                 commitment_update = Some(updates.clone());
1109                                                 RAACommitmentOrder::CommitmentFirst
1110                                         },
1111                                         _ => panic!("Unexpected event"),
1112                                 }
1113                         } else {
1114                                 RAACommitmentOrder::CommitmentFirst
1115                         };
1116
1117                         if let Some(ev) = msg_events.get(idx) {
1118                                 match ev {
1119                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1120                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1121                                                 assert!(revoke_and_ack.is_none());
1122                                                 revoke_and_ack = Some(msg.clone());
1123                                         },
1124                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1125                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1126                                                 assert!(commitment_update.is_none());
1127                                                 commitment_update = Some(updates.clone());
1128                                         },
1129                                         _ => panic!("Unexpected event"),
1130                                 }
1131                         }
1132
1133                         (funding_locked, revoke_and_ack, commitment_update, order)
1134                 }
1135         }
1136 }
1137
1138 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1139 /// for claims/fails they are separated out.
1140 pub fn reconnect_nodes<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
1141         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1142         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1143         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1144         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1145
1146         if send_funding_locked.0 {
1147                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1148                 // from b
1149                 for reestablish in reestablish_1.iter() {
1150                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1151                 }
1152         }
1153         if send_funding_locked.1 {
1154                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1155                 // from a
1156                 for reestablish in reestablish_2.iter() {
1157                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1158                 }
1159         }
1160         if send_funding_locked.0 || send_funding_locked.1 {
1161                 // If we expect any funding_locked's, both sides better have set
1162                 // next_local_commitment_number to 1
1163                 for reestablish in reestablish_1.iter() {
1164                         assert_eq!(reestablish.next_local_commitment_number, 1);
1165                 }
1166                 for reestablish in reestablish_2.iter() {
1167                         assert_eq!(reestablish.next_local_commitment_number, 1);
1168                 }
1169         }
1170
1171         let mut resp_1 = Vec::new();
1172         for msg in reestablish_1 {
1173                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1174                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1175         }
1176         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1177                 check_added_monitors!(node_b, 1);
1178         } else {
1179                 check_added_monitors!(node_b, 0);
1180         }
1181
1182         let mut resp_2 = Vec::new();
1183         for msg in reestablish_2 {
1184                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1185                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1186         }
1187         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1188                 check_added_monitors!(node_a, 1);
1189         } else {
1190                 check_added_monitors!(node_a, 0);
1191         }
1192
1193         // We don't yet support both needing updates, as that would require a different commitment dance:
1194         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1195                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1196
1197         for chan_msgs in resp_1.drain(..) {
1198                 if send_funding_locked.0 {
1199                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1200                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1201                         if !announcement_event.is_empty() {
1202                                 assert_eq!(announcement_event.len(), 1);
1203                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1204                                         //TODO: Test announcement_sigs re-sending
1205                                 } else { panic!("Unexpected event!"); }
1206                         }
1207                 } else {
1208                         assert!(chan_msgs.0.is_none());
1209                 }
1210                 if pending_raa.0 {
1211                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1212                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1213                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1214                         check_added_monitors!(node_a, 1);
1215                 } else {
1216                         assert!(chan_msgs.1.is_none());
1217                 }
1218                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1219                         let commitment_update = chan_msgs.2.unwrap();
1220                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1221                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1222                         } else {
1223                                 assert!(commitment_update.update_add_htlcs.is_empty());
1224                         }
1225                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1226                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1227                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1228                         for update_add in commitment_update.update_add_htlcs {
1229                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1230                         }
1231                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1232                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1233                         }
1234                         for update_fail in commitment_update.update_fail_htlcs {
1235                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1236                         }
1237
1238                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1239                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1240                         } else {
1241                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1242                                 check_added_monitors!(node_a, 1);
1243                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1244                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1245                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1246                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1247                                 check_added_monitors!(node_b, 1);
1248                         }
1249                 } else {
1250                         assert!(chan_msgs.2.is_none());
1251                 }
1252         }
1253
1254         for chan_msgs in resp_2.drain(..) {
1255                 if send_funding_locked.1 {
1256                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1257                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1258                         if !announcement_event.is_empty() {
1259                                 assert_eq!(announcement_event.len(), 1);
1260                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1261                                         //TODO: Test announcement_sigs re-sending
1262                                 } else { panic!("Unexpected event!"); }
1263                         }
1264                 } else {
1265                         assert!(chan_msgs.0.is_none());
1266                 }
1267                 if pending_raa.1 {
1268                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1269                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1270                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1271                         check_added_monitors!(node_b, 1);
1272                 } else {
1273                         assert!(chan_msgs.1.is_none());
1274                 }
1275                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1276                         let commitment_update = chan_msgs.2.unwrap();
1277                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1278                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1279                         }
1280                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1281                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1282                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1283                         for update_add in commitment_update.update_add_htlcs {
1284                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1285                         }
1286                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1287                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1288                         }
1289                         for update_fail in commitment_update.update_fail_htlcs {
1290                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1291                         }
1292
1293                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1294                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1295                         } else {
1296                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1297                                 check_added_monitors!(node_b, 1);
1298                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1299                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1300                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1301                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1302                                 check_added_monitors!(node_a, 1);
1303                         }
1304                 } else {
1305                         assert!(chan_msgs.2.is_none());
1306                 }
1307         }
1308 }