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