Merge pull request #1311 from TheBlueMatt/2022-02-0conf-part-1
[rust-lightning] / lightning / src / ln / functional_test_utils.rs
1 // This file is Copyright its original authors, visible in version control
2 // history.
3 //
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
8 // licenses.
9
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
12
13 use chain::{BestBlock, Confirm, Listen, Watch, keysinterface::KeysInterface};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{PaymentParameters, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
21 use ln::msgs;
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
24 use util::test_utils;
25 use util::test_utils::{panicking, TestChainMonitor};
26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
30
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
35
36 use bitcoin::hash_types::BlockHash;
37
38 use bitcoin::secp256k1::key::PublicKey;
39
40 use io;
41 use prelude::*;
42 use core::cell::RefCell;
43 use alloc::rc::Rc;
44 use sync::{Arc, Mutex};
45 use core::mem;
46
47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
48
49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
52         confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
53         connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
54 }
55 /// Mine a signle block containing the given transaction
56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
57         let height = node.best_block_info().1 + 1;
58         confirm_transaction_at(node, tx, height);
59 }
60 /// Mine the given transaction at the given height, mining blocks as required to build to that
61 /// height
62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
63         let first_connect_height = node.best_block_info().1 + 1;
64         assert!(first_connect_height <= conf_height);
65         if conf_height > first_connect_height {
66                 connect_blocks(node, conf_height - first_connect_height);
67         }
68         let mut block = Block {
69                 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
70                 txdata: Vec::new(),
71         };
72         for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
73                 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
74         }
75         block.txdata.push(tx.clone());
76         connect_block(node, &block);
77 }
78
79 /// The possible ways we may notify a ChannelManager of a new block
80 #[derive(Clone, Copy, PartialEq)]
81 pub enum ConnectStyle {
82         /// Calls best_block_updated first, detecting transactions in the block only after receiving the
83         /// header and height information.
84         BestBlockFirst,
85         /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
86         /// make a single best_block_updated call.
87         BestBlockFirstSkippingBlocks,
88         /// Calls transactions_confirmed first, detecting transactions in the block before updating the
89         /// header and height information.
90         TransactionsFirst,
91         /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
92         /// make a single best_block_updated call.
93         TransactionsFirstSkippingBlocks,
94         /// Provides the full block via the chain::Listen interface. In the current code this is
95         /// equivalent to TransactionsFirst with some additional assertions.
96         FullBlockViaListen,
97 }
98
99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
100         let skip_intermediaries = match *node.connect_style.borrow() {
101                 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
102                 _ => false,
103         };
104
105         let height = node.best_block_info().1 + 1;
106         let mut block = Block {
107                 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
108                 txdata: vec![],
109         };
110         assert!(depth >= 1);
111         for i in 1..depth {
112                 do_connect_block(node, &block, skip_intermediaries);
113                 block = Block {
114                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
115                         txdata: vec![],
116                 };
117         }
118         connect_block(node, &block);
119         block.header.block_hash()
120 }
121
122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
123         do_connect_block(node, block, false);
124 }
125
126 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
127         // Ensure `get_claimable_balances`' self-tests never panic
128         for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
129                 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
130         }
131 }
132
133 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
134         call_claimable_balances(node);
135         let height = node.best_block_info().1 + 1;
136         if !skip_intermediaries {
137                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
138                 match *node.connect_style.borrow() {
139                         ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
140                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
141                                 call_claimable_balances(node);
142                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
143                                 node.node.best_block_updated(&block.header, height);
144                                 node.node.transactions_confirmed(&block.header, &txdata, height);
145                         },
146                         ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
147                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
148                                 call_claimable_balances(node);
149                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
150                                 node.node.transactions_confirmed(&block.header, &txdata, height);
151                                 node.node.best_block_updated(&block.header, height);
152                         },
153                         ConnectStyle::FullBlockViaListen => {
154                                 node.chain_monitor.chain_monitor.block_connected(&block, height);
155                                 node.node.block_connected(&block, height);
156                         }
157                 }
158         }
159         call_claimable_balances(node);
160         node.node.test_process_background_events();
161         node.blocks.lock().unwrap().push((block.header, height));
162 }
163
164 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
165         call_claimable_balances(node);
166         for i in 0..count {
167                 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
168                 assert!(orig_header.1 > 0); // Cannot disconnect genesis
169                 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
170
171                 match *node.connect_style.borrow() {
172                         ConnectStyle::FullBlockViaListen => {
173                                 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
174                                 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
175                         },
176                         ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
177                                 if i == count - 1 {
178                                         node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
179                                         node.node.best_block_updated(&prev_header.0, prev_header.1);
180                                 }
181                         },
182                         _ => {
183                                 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
184                                 node.node.best_block_updated(&prev_header.0, prev_header.1);
185                         },
186                 }
187                 call_claimable_balances(node);
188         }
189 }
190
191 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
192         let count = node.blocks.lock().unwrap().len() as u32 - 1;
193         disconnect_blocks(node, count);
194 }
195
196 pub struct TestChanMonCfg {
197         pub tx_broadcaster: test_utils::TestBroadcaster,
198         pub fee_estimator: test_utils::TestFeeEstimator,
199         pub chain_source: test_utils::TestChainSource,
200         pub persister: test_utils::TestPersister,
201         pub logger: test_utils::TestLogger,
202         pub keys_manager: test_utils::TestKeysInterface,
203         pub network_graph: NetworkGraph,
204 }
205
206 pub struct NodeCfg<'a> {
207         pub chain_source: &'a test_utils::TestChainSource,
208         pub tx_broadcaster: &'a test_utils::TestBroadcaster,
209         pub fee_estimator: &'a test_utils::TestFeeEstimator,
210         pub chain_monitor: test_utils::TestChainMonitor<'a>,
211         pub keys_manager: &'a test_utils::TestKeysInterface,
212         pub logger: &'a test_utils::TestLogger,
213         pub network_graph: &'a NetworkGraph,
214         pub node_seed: [u8; 32],
215         pub features: InitFeatures,
216 }
217
218 pub struct Node<'a, 'b: 'a, 'c: 'b> {
219         pub chain_source: &'c test_utils::TestChainSource,
220         pub tx_broadcaster: &'c test_utils::TestBroadcaster,
221         pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
222         pub keys_manager: &'b test_utils::TestKeysInterface,
223         pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
224         pub network_graph: &'c NetworkGraph,
225         pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
226         pub node_seed: [u8; 32],
227         pub network_payment_count: Rc<RefCell<u8>>,
228         pub network_chan_count: Rc<RefCell<u32>>,
229         pub logger: &'c test_utils::TestLogger,
230         pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
231         pub connect_style: Rc<RefCell<ConnectStyle>>,
232 }
233 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
234         pub fn best_block_hash(&self) -> BlockHash {
235                 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
236         }
237         pub fn best_block_info(&self) -> (BlockHash, u32) {
238                 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
239         }
240         pub fn get_block_header(&self, height: u32) -> BlockHeader {
241                 self.blocks.lock().unwrap()[height as usize].0
242         }
243 }
244
245 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
246         fn drop(&mut self) {
247                 if !panicking() {
248                         // Check that we processed all pending events
249                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
250                         assert!(self.node.get_and_clear_pending_events().is_empty());
251                         assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
252
253                         // Check that if we serialize the Router, we can deserialize it again.
254                         {
255                                 let mut w = test_utils::TestVecWriter(Vec::new());
256                                 self.network_graph.write(&mut w).unwrap();
257                                 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
258                                 assert!(network_graph_deser == *self.network_graph);
259                                 let net_graph_msg_handler = NetGraphMsgHandler::new(
260                                         &network_graph_deser, Some(self.chain_source), self.logger
261                                 );
262                                 let mut chan_progress = 0;
263                                 loop {
264                                         let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
265                                         let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
266                                         assert!(orig_announcements == deserialized_announcements);
267                                         chan_progress = match orig_announcements.last() {
268                                                 Some(announcement) => announcement.0.contents.short_channel_id + 1,
269                                                 None => break,
270                                         };
271                                 }
272                                 let mut node_progress = None;
273                                 loop {
274                                         let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
275                                         let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
276                                         assert!(orig_announcements == deserialized_announcements);
277                                         node_progress = match orig_announcements.last() {
278                                                 Some(announcement) => Some(announcement.contents.node_id),
279                                                 None => break,
280                                         };
281                                 }
282                         }
283
284                         // Check that if we serialize and then deserialize all our channel monitors we get the
285                         // same set of outputs to watch for on chain as we have now. Note that if we write
286                         // tests that fully close channels and remove the monitors at some point this may break.
287                         let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
288                         let mut deserialized_monitors = Vec::new();
289                         {
290                                 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
291                                         let mut w = test_utils::TestVecWriter(Vec::new());
292                                         self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
293                                         let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
294                                                 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
295                                         deserialized_monitors.push(deserialized_monitor);
296                                 }
297                         }
298
299                         // Before using all the new monitors to check the watch outpoints, use the full set of
300                         // them to ensure we can write and reload our ChannelManager.
301                         {
302                                 let mut channel_monitors = HashMap::new();
303                                 for monitor in deserialized_monitors.iter_mut() {
304                                         channel_monitors.insert(monitor.get_funding_txo().0, monitor);
305                                 }
306
307                                 let mut w = test_utils::TestVecWriter(Vec::new());
308                                 self.node.write(&mut w).unwrap();
309                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
310                                         default_config: *self.node.get_current_default_configuration(),
311                                         keys_manager: self.keys_manager,
312                                         fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
313                                         chain_monitor: self.chain_monitor,
314                                         tx_broadcaster: &test_utils::TestBroadcaster {
315                                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
316                                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
317                                         },
318                                         logger: &self.logger,
319                                         channel_monitors,
320                                 }).unwrap();
321                         }
322
323                         let persister = test_utils::TestPersister::new();
324                         let broadcaster = test_utils::TestBroadcaster {
325                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
326                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
327                         };
328                         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
329                         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
330                         for deserialized_monitor in deserialized_monitors.drain(..) {
331                                 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
332                                         panic!();
333                                 }
334                         }
335                         assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
336                         assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
337                 }
338         }
339 }
340
341 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) {
342         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
343 }
344
345 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) {
346         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);
347         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
348         (announcement, as_update, bs_update, channel_id, tx)
349 }
350
351 #[macro_export]
352 /// Gets an RAA and CS which were sent in response to a commitment update
353 macro_rules! get_revoke_commit_msgs {
354         ($node: expr, $node_id: expr) => {
355                 {
356                         use $crate::util::events::MessageSendEvent;
357                         let events = $node.node.get_and_clear_pending_msg_events();
358                         assert_eq!(events.len(), 2);
359                         (match events[0] {
360                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
361                                         assert_eq!(*node_id, $node_id);
362                                         (*msg).clone()
363                                 },
364                                 _ => panic!("Unexpected event"),
365                         }, match events[1] {
366                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
367                                         assert_eq!(*node_id, $node_id);
368                                         assert!(updates.update_add_htlcs.is_empty());
369                                         assert!(updates.update_fulfill_htlcs.is_empty());
370                                         assert!(updates.update_fail_htlcs.is_empty());
371                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
372                                         assert!(updates.update_fee.is_none());
373                                         updates.commitment_signed.clone()
374                                 },
375                                 _ => panic!("Unexpected event"),
376                         })
377                 }
378         }
379 }
380
381 /// Get an specific event message from the pending events queue.
382 #[macro_export]
383 macro_rules! get_event_msg {
384         ($node: expr, $event_type: path, $node_id: expr) => {
385                 {
386                         let events = $node.node.get_and_clear_pending_msg_events();
387                         assert_eq!(events.len(), 1);
388                         match events[0] {
389                                 $event_type { ref node_id, ref msg } => {
390                                         assert_eq!(*node_id, $node_id);
391                                         (*msg).clone()
392                                 },
393                                 _ => panic!("Unexpected event"),
394                         }
395                 }
396         }
397 }
398
399 /// Get a specific event from the pending events queue.
400 #[macro_export]
401 macro_rules! get_event {
402         ($node: expr, $event_type: path) => {
403                 {
404                         let mut events = $node.node.get_and_clear_pending_events();
405                         assert_eq!(events.len(), 1);
406                         let ev = events.pop().unwrap();
407                         match ev {
408                                 $event_type { .. } => {
409                                         ev
410                                 },
411                                 _ => panic!("Unexpected event"),
412                         }
413                 }
414         }
415 }
416
417 #[macro_export]
418 /// Gets an UpdateHTLCs MessageSendEvent
419 macro_rules! get_htlc_update_msgs {
420         ($node: expr, $node_id: expr) => {
421                 {
422                         let events = $node.node.get_and_clear_pending_msg_events();
423                         assert_eq!(events.len(), 1);
424                         match events[0] {
425                                 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
426                                         assert_eq!(*node_id, $node_id);
427                                         (*updates).clone()
428                                 },
429                                 _ => panic!("Unexpected event"),
430                         }
431                 }
432         }
433 }
434
435 #[cfg(test)]
436 macro_rules! get_channel_ref {
437         ($node: expr, $lock: ident, $channel_id: expr) => {
438                 {
439                         $lock = $node.node.channel_state.lock().unwrap();
440                         $lock.by_id.get_mut(&$channel_id).unwrap()
441                 }
442         }
443 }
444
445 #[cfg(test)]
446 macro_rules! get_feerate {
447         ($node: expr, $channel_id: expr) => {
448                 {
449                         let mut lock;
450                         let chan = get_channel_ref!($node, lock, $channel_id);
451                         chan.get_feerate()
452                 }
453         }
454 }
455
456 #[cfg(test)]
457 macro_rules! get_opt_anchors {
458         ($node: expr, $channel_id: expr) => {
459                 {
460                         let mut lock;
461                         let chan = get_channel_ref!($node, lock, $channel_id);
462                         chan.opt_anchors()
463                 }
464         }
465 }
466
467 /// Returns a channel monitor given a channel id, making some naive assumptions
468 #[macro_export]
469 macro_rules! get_monitor {
470         ($node: expr, $channel_id: expr) => {
471                 {
472                         use bitcoin::hashes::Hash;
473                         let mut monitor = None;
474                         // Assume funding vout is either 0 or 1 blindly
475                         for index in 0..2 {
476                                 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
477                                         $crate::chain::transaction::OutPoint {
478                                                 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
479                                         })
480                                 {
481                                         monitor = Some(mon);
482                                         break;
483                                 }
484                         }
485                         monitor.unwrap()
486                 }
487         }
488 }
489
490 /// Returns any local commitment transactions for the channel.
491 #[macro_export]
492 macro_rules! get_local_commitment_txn {
493         ($node: expr, $channel_id: expr) => {
494                 {
495                         $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
496                 }
497         }
498 }
499
500 /// Check the error from attempting a payment.
501 #[macro_export]
502 macro_rules! unwrap_send_err {
503         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
504                 match &$res {
505                         &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
506                                 assert_eq!(fails.len(), 1);
507                                 match fails[0] {
508                                         $type => { $check },
509                                         _ => panic!(),
510                                 }
511                         },
512                         &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
513                                 assert_eq!(results.len(), 1);
514                                 match results[0] {
515                                         Err($type) => { $check },
516                                         _ => panic!(),
517                                 }
518                         },
519                         _ => panic!(),
520                 }
521         }
522 }
523
524 /// Check whether N channel monitor(s) have been added.
525 #[macro_export]
526 macro_rules! check_added_monitors {
527         ($node: expr, $count: expr) => {
528                 {
529                         let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
530                         assert_eq!(added_monitors.len(), $count);
531                         added_monitors.clear();
532                 }
533         }
534 }
535
536 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) {
537         let chan_id = *node.network_chan_count.borrow();
538
539         let events = node.node.get_and_clear_pending_events();
540         assert_eq!(events.len(), 1);
541         match events[0] {
542                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
543                         assert_eq!(*channel_value_satoshis, expected_chan_value);
544                         assert_eq!(user_channel_id, expected_user_chan_id);
545
546                         let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
547                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
548                         }]};
549                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
550                         (*temporary_channel_id, tx, funding_outpoint)
551                 },
552                 _ => panic!("Unexpected event"),
553         }
554 }
555 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
556         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
557         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
558
559         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
560         check_added_monitors!(node_a, 0);
561
562         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
563         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
564         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
565         {
566                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
567                 assert_eq!(added_monitors.len(), 1);
568                 assert_eq!(added_monitors[0].0, funding_output);
569                 added_monitors.clear();
570         }
571
572         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()));
573         {
574                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
575                 assert_eq!(added_monitors.len(), 1);
576                 assert_eq!(added_monitors[0].0, funding_output);
577                 added_monitors.clear();
578         }
579
580         let events_4 = node_a.node.get_and_clear_pending_events();
581         assert_eq!(events_4.len(), 0);
582
583         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
584         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
585         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
586
587         // Ensure that funding_transaction_generated is idempotent.
588         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
589         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
590         check_added_monitors!(node_a, 0);
591
592         tx
593 }
594
595 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 {
596         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
597         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
598         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
599         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
600         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
601         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
602         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
603
604         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
605 }
606
607 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, conf_height: u32) {
608         confirm_transaction_at(node_conf, tx, conf_height);
609         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
610         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()));
611 }
612
613 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]) {
614         let channel_id;
615         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
616         assert_eq!(events_6.len(), 3);
617         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
618                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
619                 2
620         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
621                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
622                 1
623         } else { panic!("Unexpected event: {:?}", events_6[1]); };
624         ((match events_6[0] {
625                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
626                         channel_id = msg.channel_id.clone();
627                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
628                         msg.clone()
629                 },
630                 _ => panic!("Unexpected event"),
631         }, match events_6[announcement_sigs_idx] {
632                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
633                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
634                         msg.clone()
635                 },
636                 _ => panic!("Unexpected event"),
637         }), channel_id)
638 }
639
640 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]) {
641         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
642         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
643         confirm_transaction_at(node_a, tx, conf_height);
644         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
645         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
646 }
647
648 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) {
649         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
650         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
651         (msgs, chan_id, tx)
652 }
653
654 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) {
655         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
656         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
657         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
658
659         let events_7 = node_b.node.get_and_clear_pending_msg_events();
660         assert_eq!(events_7.len(), 1);
661         let (announcement, bs_update) = match events_7[0] {
662                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
663                         (msg, update_msg)
664                 },
665                 _ => panic!("Unexpected event"),
666         };
667
668         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
669         let events_8 = node_a.node.get_and_clear_pending_msg_events();
670         assert_eq!(events_8.len(), 1);
671         let as_update = match events_8[0] {
672                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
673                         assert!(*announcement == *msg);
674                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
675                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
676                         update_msg
677                 },
678                 _ => panic!("Unexpected event"),
679         };
680
681         *node_a.network_chan_count.borrow_mut() += 1;
682
683         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
684 }
685
686 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) {
687         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
688 }
689
690 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) {
691         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
692         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
693         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
694 }
695
696 pub fn create_unannounced_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::FundingLocked, Transaction) {
697         let mut no_announce_cfg = test_default_channel_config();
698         no_announce_cfg.channel_options.announced_channel = false;
699         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
700         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
701         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
702         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
703         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
704
705         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], channel_value, 42);
706         nodes[a].node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
707         nodes[b].node.handle_funding_created(&nodes[a].node.get_our_node_id(), &get_event_msg!(nodes[a], MessageSendEvent::SendFundingCreated, nodes[b].node.get_our_node_id()));
708         check_added_monitors!(nodes[b], 1);
709
710         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
711         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
712         check_added_monitors!(nodes[a], 1);
713
714         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
715         confirm_transaction_at(&nodes[a], &tx, conf_height);
716         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
717         confirm_transaction_at(&nodes[b], &tx, conf_height);
718         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
719         let as_funding_locked = get_event_msg!(nodes[a], MessageSendEvent::SendFundingLocked, nodes[b].node.get_our_node_id());
720         nodes[a].node.handle_funding_locked(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendFundingLocked, nodes[a].node.get_our_node_id()));
721         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
722         nodes[b].node.handle_funding_locked(&nodes[a].node.get_our_node_id(), &as_funding_locked);
723         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
724
725         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
726         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
727
728         let mut found_a = false;
729         for chan in nodes[a].node.list_usable_channels() {
730                 if chan.channel_id == as_funding_locked.channel_id {
731                         assert!(!found_a);
732                         found_a = true;
733                         assert!(!chan.is_public);
734                 }
735         }
736         assert!(found_a);
737
738         let mut found_b = false;
739         for chan in nodes[b].node.list_usable_channels() {
740                 if chan.channel_id == as_funding_locked.channel_id {
741                         assert!(!found_b);
742                         found_b = true;
743                         assert!(!chan.is_public);
744                 }
745         }
746         assert!(found_b);
747
748         (as_funding_locked, tx)
749 }
750
751 pub fn update_nodes_with_chan_announce<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, ann: &msgs::ChannelAnnouncement, upd_1: &msgs::ChannelUpdate, upd_2: &msgs::ChannelUpdate) {
752         nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
753         let a_events = nodes[a].node.get_and_clear_pending_msg_events();
754         assert!(a_events.len() >= 2);
755
756         // ann should be re-generated by broadcast_node_announcement - check that we have it.
757         let mut found_ann_1 = false;
758         for event in a_events.iter() {
759                 match event {
760                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
761                                 if msg == ann { found_ann_1 = true; }
762                         },
763                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
764                         _ => panic!("Unexpected event {:?}", event),
765                 }
766         }
767         assert!(found_ann_1);
768
769         let a_node_announcement = match a_events.last().unwrap() {
770                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
771                         (*msg).clone()
772                 },
773                 _ => panic!("Unexpected event"),
774         };
775
776         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
777         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
778         assert!(b_events.len() >= 2);
779
780         // ann should be re-generated by broadcast_node_announcement - check that we have it.
781         let mut found_ann_2 = false;
782         for event in b_events.iter() {
783                 match event {
784                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
785                                 if msg == ann { found_ann_2 = true; }
786                         },
787                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
788                         _ => panic!("Unexpected event"),
789                 }
790         }
791         assert!(found_ann_2);
792
793         let b_node_announcement = match b_events.last().unwrap() {
794                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
795                         (*msg).clone()
796                 },
797                 _ => panic!("Unexpected event"),
798         };
799
800         for node in nodes {
801                 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
802                 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
803                 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
804                 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
805                 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
806
807                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
808                 // forwarding info for local channels even if its not accepted in the network graph.
809                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
810                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
811         }
812 }
813
814 #[macro_export]
815 macro_rules! check_spends {
816         ($tx: expr, $($spends_txn: expr),*) => {
817                 {
818                         $(
819                         for outp in $spends_txn.output.iter() {
820                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
821                         }
822                         )*
823                         for outp in $tx.output.iter() {
824                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
825                         }
826                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
827                                 $(
828                                         if out_point.txid == $spends_txn.txid() {
829                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
830                                         }
831                                 )*
832                                 None
833                         };
834                         let mut total_value_in = 0;
835                         for input in $tx.input.iter() {
836                                 total_value_in += get_output(&input.previous_output).unwrap().value;
837                         }
838                         let mut total_value_out = 0;
839                         for output in $tx.output.iter() {
840                                 total_value_out += output.value;
841                         }
842                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
843                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
844                         assert!(total_value_out + min_fee <= total_value_in);
845                         $tx.verify(get_output).unwrap();
846                 }
847         }
848 }
849
850 macro_rules! get_closing_signed_broadcast {
851         ($node: expr, $dest_pubkey: expr) => {
852                 {
853                         let events = $node.get_and_clear_pending_msg_events();
854                         assert!(events.len() == 1 || events.len() == 2);
855                         (match events[events.len() - 1] {
856                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
857                                         assert_eq!(msg.contents.flags & 2, 2);
858                                         msg.clone()
859                                 },
860                                 _ => panic!("Unexpected event"),
861                         }, if events.len() == 2 {
862                                 match events[0] {
863                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
864                                                 assert_eq!(*node_id, $dest_pubkey);
865                                                 Some(msg.clone())
866                                         },
867                                         _ => panic!("Unexpected event"),
868                                 }
869                         } else { None })
870                 }
871         }
872 }
873
874 #[cfg(test)]
875 macro_rules! check_warn_msg {
876         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
877                 let msg_events = $node.node.get_and_clear_pending_msg_events();
878                 assert_eq!(msg_events.len(), 1);
879                 match msg_events[0] {
880                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
881                                 assert_eq!(node_id, $recipient_node_id);
882                                 assert_eq!(msg.channel_id, $chan_id);
883                                 msg.data.clone()
884                         },
885                         _ => panic!("Unexpected event"),
886                 }
887         }}
888 }
889
890 /// Check that a channel's closing channel update has been broadcasted, and optionally
891 /// check whether an error message event has occurred.
892 #[macro_export]
893 macro_rules! check_closed_broadcast {
894         ($node: expr, $with_error_msg: expr) => {{
895                 use $crate::util::events::MessageSendEvent;
896                 use $crate::ln::msgs::ErrorAction;
897
898                 let msg_events = $node.node.get_and_clear_pending_msg_events();
899                 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
900                 match msg_events[0] {
901                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
902                                 assert_eq!(msg.contents.flags & 2, 2);
903                         },
904                         _ => panic!("Unexpected event"),
905                 }
906                 if $with_error_msg {
907                         match msg_events[1] {
908                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
909                                         // TODO: Check node_id
910                                         Some(msg.clone())
911                                 },
912                                 _ => panic!("Unexpected event"),
913                         }
914                 } else { None }
915         }}
916 }
917
918 /// Check that a channel's closing channel events has been issued
919 #[macro_export]
920 macro_rules! check_closed_event {
921         ($node: expr, $events: expr, $reason: expr) => {
922                 check_closed_event!($node, $events, $reason, false);
923         };
924         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
925                 use $crate::util::events::Event;
926
927                 let events = $node.node.get_and_clear_pending_events();
928                 assert_eq!(events.len(), $events);
929                 let expected_reason = $reason;
930                 let mut issues_discard_funding = false;
931                 for event in events {
932                         match event {
933                                 Event::ChannelClosed { ref reason, .. } => {
934                                         assert_eq!(*reason, expected_reason);
935                                 },
936                                 Event::DiscardFunding { .. } => {
937                                         issues_discard_funding = true;
938                                 }
939                                 _ => panic!("Unexpected event"),
940                         }
941                 }
942                 assert_eq!($is_check_discard_funding, issues_discard_funding);
943         }}
944 }
945
946 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) {
947         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) };
948         let (node_b, broadcaster_b, struct_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) } else { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) };
949         let (tx_a, tx_b);
950
951         node_a.close_channel(channel_id).unwrap();
952         node_b.handle_shutdown(&node_a.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
953
954         let events_1 = node_b.get_and_clear_pending_msg_events();
955         assert!(events_1.len() >= 1);
956         let shutdown_b = match events_1[0] {
957                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
958                         assert_eq!(node_id, &node_a.get_our_node_id());
959                         msg.clone()
960                 },
961                 _ => panic!("Unexpected event"),
962         };
963
964         let closing_signed_b = if !close_inbound_first {
965                 assert_eq!(events_1.len(), 1);
966                 None
967         } else {
968                 Some(match events_1[1] {
969                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
970                                 assert_eq!(node_id, &node_a.get_our_node_id());
971                                 msg.clone()
972                         },
973                         _ => panic!("Unexpected event"),
974                 })
975         };
976
977         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
978         let (as_update, bs_update) = if close_inbound_first {
979                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
980                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
981
982                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
983                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
984                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
985                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
986
987                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
988                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
989                 assert!(none_a.is_none());
990                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
991                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
992                 (as_update, bs_update)
993         } else {
994                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
995
996                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
997                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
998
999                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1000                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1001                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1002
1003                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1004                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1005                 assert!(none_b.is_none());
1006                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1007                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1008                 (as_update, bs_update)
1009         };
1010         assert_eq!(tx_a, tx_b);
1011         check_spends!(tx_a, funding_tx);
1012
1013         (as_update, bs_update, tx_a)
1014 }
1015
1016 pub struct SendEvent {
1017         pub node_id: PublicKey,
1018         pub msgs: Vec<msgs::UpdateAddHTLC>,
1019         pub commitment_msg: msgs::CommitmentSigned,
1020 }
1021 impl SendEvent {
1022         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1023                 assert!(updates.update_fulfill_htlcs.is_empty());
1024                 assert!(updates.update_fail_htlcs.is_empty());
1025                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1026                 assert!(updates.update_fee.is_none());
1027                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1028         }
1029
1030         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1031                 match event {
1032                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1033                         _ => panic!("Unexpected event type!"),
1034                 }
1035         }
1036
1037         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1038                 let mut events = node.node.get_and_clear_pending_msg_events();
1039                 assert_eq!(events.len(), 1);
1040                 SendEvent::from_event(events.pop().unwrap())
1041         }
1042 }
1043
1044 #[macro_export]
1045 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1046 /// commitment update.
1047 macro_rules! commitment_signed_dance {
1048         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1049                 {
1050                         check_added_monitors!($node_a, 0);
1051                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1052                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1053                         check_added_monitors!($node_a, 1);
1054                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1055                 }
1056         };
1057         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1058                 {
1059                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1060                         check_added_monitors!($node_b, 0);
1061                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1062                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1063                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1064                         check_added_monitors!($node_b, 1);
1065                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1066                         let (bs_revoke_and_ack, extra_msg_option) = {
1067                                 let events = $node_b.node.get_and_clear_pending_msg_events();
1068                                 assert!(events.len() <= 2);
1069                                 (match events[0] {
1070                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1071                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1072                                                 (*msg).clone()
1073                                         },
1074                                         _ => panic!("Unexpected event"),
1075                                 }, events.get(1).map(|e| e.clone()))
1076                         };
1077                         check_added_monitors!($node_b, 1);
1078                         if $fail_backwards {
1079                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1080                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1081                         }
1082                         (extra_msg_option, bs_revoke_and_ack)
1083                 }
1084         };
1085         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1086                 {
1087                         check_added_monitors!($node_a, 0);
1088                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1089                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1090                         check_added_monitors!($node_a, 1);
1091                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1092                         assert!(extra_msg_option.is_none());
1093                         bs_revoke_and_ack
1094                 }
1095         };
1096         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1097                 {
1098                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1099                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1100                         check_added_monitors!($node_a, 1);
1101                         extra_msg_option
1102                 }
1103         };
1104         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1105                 {
1106                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1107                 }
1108         };
1109         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1110                 {
1111                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1112                         if $fail_backwards {
1113                                 $crate::expect_pending_htlcs_forwardable!($node_a);
1114                                 check_added_monitors!($node_a, 1);
1115
1116                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
1117                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
1118                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1119                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
1120                                 } else { panic!("Unexpected event"); }
1121                         } else {
1122                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1123                         }
1124                 }
1125         }
1126 }
1127
1128 /// Get a payment preimage and hash.
1129 #[macro_export]
1130 macro_rules! get_payment_preimage_hash {
1131         ($dest_node: expr) => {
1132                 {
1133                         get_payment_preimage_hash!($dest_node, None)
1134                 }
1135         };
1136         ($dest_node: expr, $min_value_msat: expr) => {
1137                 {
1138                         use bitcoin::hashes::Hash as _;
1139                         let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1140                         let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1141                         *payment_count += 1;
1142                         let payment_hash = $crate::ln::PaymentHash(
1143                                 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1144                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1145                         (payment_preimage, payment_hash, payment_secret)
1146                 }
1147         }
1148 }
1149
1150 #[cfg(test)]
1151 #[macro_export]
1152 macro_rules! get_route_and_payment_hash {
1153         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1154                 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1155         }};
1156         ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1157                 use $crate::chain::keysinterface::KeysInterface;
1158                 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1159                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1160                         .with_features($crate::ln::features::InvoiceFeatures::known())
1161                         .with_route_hints($last_hops);
1162                 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1163                 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1164                 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1165                 let route = $crate::routing::router::get_route(
1166                         &$send_node.node.get_our_node_id(), &payment_params, &$send_node.network_graph.read_only(),
1167                         Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1168                         $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1169                 ).unwrap();
1170                 (route, payment_hash, payment_preimage, payment_secret)
1171         }}
1172 }
1173
1174 #[macro_export]
1175 /// Clears (and ignores) a PendingHTLCsForwardable event
1176 macro_rules! expect_pending_htlcs_forwardable_ignore {
1177         ($node: expr) => {{
1178                 let events = $node.node.get_and_clear_pending_events();
1179                 assert_eq!(events.len(), 1);
1180                 match events[0] {
1181                         $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1182                         _ => panic!("Unexpected event"),
1183                 };
1184         }}
1185 }
1186
1187 #[macro_export]
1188 /// Handles a PendingHTLCsForwardable event
1189 macro_rules! expect_pending_htlcs_forwardable {
1190         ($node: expr) => {{
1191                 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1192                 $node.node.process_pending_htlc_forwards();
1193
1194                 // Ensure process_pending_htlc_forwards is idempotent.
1195                 $node.node.process_pending_htlc_forwards();
1196         }}
1197 }
1198
1199 #[cfg(test)]
1200 macro_rules! expect_pending_htlcs_forwardable_from_events {
1201         ($node: expr, $events: expr, $ignore: expr) => {{
1202                 assert_eq!($events.len(), 1);
1203                 match $events[0] {
1204                         Event::PendingHTLCsForwardable { .. } => { },
1205                         _ => panic!("Unexpected event"),
1206                 };
1207                 if $ignore {
1208                         $node.node.process_pending_htlc_forwards();
1209
1210                         // Ensure process_pending_htlc_forwards is idempotent.
1211                         $node.node.process_pending_htlc_forwards();
1212                 }
1213         }}
1214 }
1215
1216 #[macro_export]
1217 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1218 macro_rules! expect_payment_received {
1219         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1220                 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1221         };
1222         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1223                 let events = $node.node.get_and_clear_pending_events();
1224                 assert_eq!(events.len(), 1);
1225                 match events[0] {
1226                         $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1227                                 assert_eq!($expected_payment_hash, *payment_hash);
1228                                 assert_eq!($expected_recv_value, amt);
1229                                 match purpose {
1230                                         $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1231                                                 assert_eq!(&$expected_payment_preimage, payment_preimage);
1232                                                 assert_eq!($expected_payment_secret, *payment_secret);
1233                                         },
1234                                         _ => {},
1235                                 }
1236                         },
1237                         _ => panic!("Unexpected event"),
1238                 }
1239         }
1240 }
1241
1242 #[cfg(test)]
1243 #[macro_export]
1244 macro_rules! expect_payment_sent_without_paths {
1245         ($node: expr, $expected_payment_preimage: expr) => {
1246                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1247         };
1248         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1249                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1250         }
1251 }
1252
1253 #[macro_export]
1254 macro_rules! expect_payment_sent {
1255         ($node: expr, $expected_payment_preimage: expr) => {
1256                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1257         };
1258         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1259                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1260         };
1261         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1262                 use bitcoin::hashes::Hash as _;
1263                 let events = $node.node.get_and_clear_pending_events();
1264                 let expected_payment_hash = $crate::ln::PaymentHash(
1265                         bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1266                 if $expect_paths {
1267                         assert!(events.len() > 1);
1268                 } else {
1269                         assert_eq!(events.len(), 1);
1270                 }
1271                 let expected_payment_id = match events[0] {
1272                         $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1273                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1274                                 assert_eq!(expected_payment_hash, *payment_hash);
1275                                 assert!(fee_paid_msat.is_some());
1276                                 if $expected_fee_msat_opt.is_some() {
1277                                         assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1278                                 }
1279                                 payment_id.unwrap()
1280                         },
1281                         _ => panic!("Unexpected event"),
1282                 };
1283                 if $expect_paths {
1284                         for i in 1..events.len() {
1285                                 match events[i] {
1286                                         $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1287                                                 assert_eq!(payment_id, expected_payment_id);
1288                                                 assert_eq!(payment_hash, Some(expected_payment_hash));
1289                                         },
1290                                         _ => panic!("Unexpected event"),
1291                                 }
1292                         }
1293                 }
1294         } }
1295 }
1296
1297 #[cfg(test)]
1298 #[macro_export]
1299 macro_rules! expect_payment_path_successful {
1300         ($node: expr) => {
1301                 let events = $node.node.get_and_clear_pending_events();
1302                 assert_eq!(events.len(), 1);
1303                 match events[0] {
1304                         $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1305                         _ => panic!("Unexpected event"),
1306                 }
1307         }
1308 }
1309
1310 macro_rules! expect_payment_forwarded {
1311         ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1312                 let events = $node.node.get_and_clear_pending_events();
1313                 assert_eq!(events.len(), 1);
1314                 match events[0] {
1315                         Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1316                                 assert_eq!(fee_earned_msat, $expected_fee);
1317                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1318                         },
1319                         _ => panic!("Unexpected event"),
1320                 }
1321         }
1322 }
1323
1324 pub struct PaymentFailedConditions<'a> {
1325         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1326         pub(crate) expected_blamed_scid: Option<u64>,
1327         pub(crate) expected_blamed_chan_closed: Option<bool>,
1328         pub(crate) expected_mpp_parts_remain: bool,
1329 }
1330
1331 impl<'a> PaymentFailedConditions<'a> {
1332         pub fn new() -> Self {
1333                 Self {
1334                         expected_htlc_error_data: None,
1335                         expected_blamed_scid: None,
1336                         expected_blamed_chan_closed: None,
1337                         expected_mpp_parts_remain: false,
1338                 }
1339         }
1340         pub fn mpp_parts_remain(mut self) -> Self {
1341                 self.expected_mpp_parts_remain = true;
1342                 self
1343         }
1344         pub fn blamed_scid(mut self, scid: u64) -> Self {
1345                 self.expected_blamed_scid = Some(scid);
1346                 self
1347         }
1348         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1349                 self.expected_blamed_chan_closed = Some(closed);
1350                 self
1351         }
1352         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1353                 self.expected_htlc_error_data = Some((code, data));
1354                 self
1355         }
1356 }
1357
1358 #[cfg(test)]
1359 macro_rules! expect_payment_failed_with_update {
1360         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1361                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1362                         $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1363         }
1364 }
1365
1366 #[cfg(test)]
1367 macro_rules! expect_payment_failed {
1368         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1369                 #[allow(unused_mut)]
1370                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1371                 $(
1372                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1373                 )*
1374                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1375         };
1376 }
1377
1378 #[cfg(test)]
1379 macro_rules! expect_payment_failed_conditions {
1380         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1381                 let events = $node.node.get_and_clear_pending_events();
1382                 assert_eq!(events.len(), 1);
1383                 let expected_payment_id = match events[0] {
1384                         Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1385                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1386                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1387                                 assert!(retry.is_some(), "expected retry.is_some()");
1388                                 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1389                                 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1390
1391                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1392                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1393                                 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1394                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
1395                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1396                                 }
1397
1398                                 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1399                                         match network_update {
1400                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1401                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1402                                                                 assert_eq!(msg.contents.short_channel_id, scid);
1403                                                         }
1404                                                         assert_eq!(msg.contents.flags & 2, 0);
1405                                                 },
1406                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1407                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1408                                                                 assert_eq!(short_channel_id, scid);
1409                                                         }
1410                                                         assert!(is_permanent);
1411                                                 },
1412                                                 Some(_) => panic!("Unexpected update type"),
1413                                                 None => panic!("Expected update"),
1414                                         }
1415                                 }
1416
1417                                 payment_id.unwrap()
1418                         },
1419                         _ => panic!("Unexpected event"),
1420                 };
1421                 if !$conditions.expected_mpp_parts_remain {
1422                         $node.node.abandon_payment(expected_payment_id);
1423                         let events = $node.node.get_and_clear_pending_events();
1424                         assert_eq!(events.len(), 1);
1425                         match events[0] {
1426                                 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1427                                         assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1428                                         assert_eq!(*payment_id, expected_payment_id);
1429                                 }
1430                                 _ => panic!("Unexpected second event"),
1431                         }
1432                 }
1433         }
1434 }
1435
1436 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: PaymentSecret) -> PaymentId {
1437         let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1438         check_added_monitors!(origin_node, expected_paths.len());
1439         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1440         payment_id
1441 }
1442
1443 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, expected_preimage: Option<PaymentPreimage>) {
1444         let mut payment_event = SendEvent::from_event(ev);
1445         let mut prev_node = origin_node;
1446
1447         for (idx, &node) in expected_path.iter().enumerate() {
1448                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1449
1450                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1451                 check_added_monitors!(node, 0);
1452                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1453
1454                 expect_pending_htlcs_forwardable!(node);
1455
1456                 if idx == expected_path.len() - 1 {
1457                         let events_2 = node.node.get_and_clear_pending_events();
1458                         if payment_received_expected {
1459                                 assert_eq!(events_2.len(), 1);
1460                                 match events_2[0] {
1461                                         Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1462                                                 assert_eq!(our_payment_hash, *payment_hash);
1463                                                 match &purpose {
1464                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1465                                                                 assert_eq!(expected_preimage, *payment_preimage);
1466                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1467                                                         },
1468                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1469                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1470                                                                 assert!(our_payment_secret.is_none());
1471                                                         },
1472                                                 }
1473                                                 assert_eq!(amt, recv_value);
1474                                         },
1475                                         _ => panic!("Unexpected event"),
1476                                 }
1477                         } else {
1478                                 assert!(events_2.is_empty());
1479                         }
1480                 } else {
1481                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1482                         assert_eq!(events_2.len(), 1);
1483                         check_added_monitors!(node, 1);
1484                         payment_event = SendEvent::from_event(events_2.remove(0));
1485                         assert_eq!(payment_event.msgs.len(), 1);
1486                 }
1487
1488                 prev_node = node;
1489         }
1490 }
1491
1492 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: PaymentSecret) {
1493         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1494         assert_eq!(events.len(), expected_route.len());
1495         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1496                 // Once we've gotten through all the HTLCs, the last one should result in a
1497                 // PaymentReceived (but each previous one should not!), .
1498                 let expect_payment = path_idx == expected_route.len() - 1;
1499                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1500         }
1501 }
1502
1503 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, PaymentSecret, PaymentId) {
1504         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1505         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1506         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1507 }
1508
1509 pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) -> u64 {
1510         for path in expected_paths.iter() {
1511                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1512         }
1513         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1514         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1515
1516         let mut expected_total_fee_msat = 0;
1517
1518         macro_rules! msgs_from_ev {
1519                 ($ev: expr) => {
1520                         match $ev {
1521                                 &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 } } => {
1522                                         assert!(update_add_htlcs.is_empty());
1523                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1524                                         assert!(update_fail_htlcs.is_empty());
1525                                         assert!(update_fail_malformed_htlcs.is_empty());
1526                                         assert!(update_fee.is_none());
1527                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1528                                 },
1529                                 _ => panic!("Unexpected event"),
1530                         }
1531                 }
1532         }
1533         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1534         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1535         assert_eq!(events.len(), expected_paths.len());
1536         for ev in events.iter() {
1537                 per_path_msgs.push(msgs_from_ev!(ev));
1538         }
1539
1540         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1541                 let mut next_msgs = Some(path_msgs);
1542                 let mut expected_next_node = next_hop;
1543
1544                 macro_rules! last_update_fulfill_dance {
1545                         ($node: expr, $prev_node: expr) => {
1546                                 {
1547                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1548                                         check_added_monitors!($node, 0);
1549                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1550                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1551                                 }
1552                         }
1553                 }
1554                 macro_rules! mid_update_fulfill_dance {
1555                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1556                                 {
1557                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1558                                         let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1559                                         expect_payment_forwarded!($node, Some(fee as u64), false);
1560                                         expected_total_fee_msat += fee as u64;
1561                                         check_added_monitors!($node, 1);
1562                                         let new_next_msgs = if $new_msgs {
1563                                                 let events = $node.node.get_and_clear_pending_msg_events();
1564                                                 assert_eq!(events.len(), 1);
1565                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1566                                                 expected_next_node = nexthop;
1567                                                 Some(res)
1568                                         } else {
1569                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1570                                                 None
1571                                         };
1572                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1573                                         next_msgs = new_next_msgs;
1574                                 }
1575                         }
1576                 }
1577
1578                 let mut prev_node = expected_route.last().unwrap();
1579                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1580                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1581                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1582                         if next_msgs.is_some() {
1583                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1584                         } else {
1585                                 assert!(!update_next_msgs);
1586                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1587                         }
1588                         if !skip_last && idx == expected_route.len() - 1 {
1589                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1590                         }
1591
1592                         prev_node = node;
1593                 }
1594
1595                 if !skip_last {
1596                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1597                 }
1598         }
1599
1600         // Ensure that claim_funds is idempotent.
1601         assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1602         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1603         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1604
1605         expected_total_fee_msat
1606 }
1607 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) {
1608         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1609         if !skip_last {
1610                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1611         }
1612 }
1613
1614 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1615         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1616 }
1617
1618 pub const TEST_FINAL_CLTV: u32 = 70;
1619
1620 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1621         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1622                 .with_features(InvoiceFeatures::known());
1623         let network_graph = origin_node.network_graph.read_only();
1624         let scorer = test_utils::TestScorer::with_penalty(0);
1625         let seed = [0u8; 32];
1626         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1627         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1628         let route = get_route(
1629                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1630                 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1631                 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1632         assert_eq!(route.paths.len(), 1);
1633         assert_eq!(route.paths[0].len(), expected_route.len());
1634         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1635                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1636         }
1637
1638         let res = send_along_route(origin_node, route, expected_route, recv_value);
1639         (res.0, res.1, res.2)
1640 }
1641
1642 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1643         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1644                 .with_features(InvoiceFeatures::known());
1645         let network_graph = origin_node.network_graph.read_only();
1646         let scorer = test_utils::TestScorer::with_penalty(0);
1647         let seed = [0u8; 32];
1648         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1649         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1650         let route = get_route(
1651                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1652                 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1653         assert_eq!(route.paths.len(), 1);
1654         assert_eq!(route.paths[0].len(), expected_route.len());
1655         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1656                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1657         }
1658
1659         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1660         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1661                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1662 }
1663
1664 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1665         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1666         claim_payment(&origin, expected_route, our_payment_preimage);
1667 }
1668
1669 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash)  {
1670         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1671         for path in expected_paths.iter() {
1672                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1673         }
1674         assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1675         expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1676         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1677
1678         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1679         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1680         assert_eq!(events.len(), expected_paths.len());
1681         for ev in events.iter() {
1682                 let (update_fail, commitment_signed, node_id) = match ev {
1683                         &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 } } => {
1684                                 assert!(update_add_htlcs.is_empty());
1685                                 assert!(update_fulfill_htlcs.is_empty());
1686                                 assert_eq!(update_fail_htlcs.len(), 1);
1687                                 assert!(update_fail_malformed_htlcs.is_empty());
1688                                 assert!(update_fee.is_none());
1689                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1690                         },
1691                         _ => panic!("Unexpected event"),
1692                 };
1693                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1694         }
1695         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1696         expected_paths.sort_unstable_by(|path_a, path_b| path_a[path_a.len() - 2].node.get_our_node_id().cmp(&path_b[path_b.len() - 2].node.get_our_node_id()));
1697
1698         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1699                 let mut next_msgs = Some(path_msgs);
1700                 let mut expected_next_node = next_hop;
1701                 let mut prev_node = expected_route.last().unwrap();
1702
1703                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1704                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1705                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
1706                         if next_msgs.is_some() {
1707                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1708                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1709                                 if !update_next_node {
1710                                         expect_pending_htlcs_forwardable!(node);
1711                                 }
1712                         }
1713                         let events = node.node.get_and_clear_pending_msg_events();
1714                         if update_next_node {
1715                                 assert_eq!(events.len(), 1);
1716                                 match events[0] {
1717                                         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 } } => {
1718                                                 assert!(update_add_htlcs.is_empty());
1719                                                 assert!(update_fulfill_htlcs.is_empty());
1720                                                 assert_eq!(update_fail_htlcs.len(), 1);
1721                                                 assert!(update_fail_malformed_htlcs.is_empty());
1722                                                 assert!(update_fee.is_none());
1723                                                 expected_next_node = node_id.clone();
1724                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1725                                         },
1726                                         _ => panic!("Unexpected event"),
1727                                 }
1728                         } else {
1729                                 assert!(events.is_empty());
1730                         }
1731                         if !skip_last && idx == expected_route.len() - 1 {
1732                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1733                         }
1734
1735                         prev_node = node;
1736                 }
1737
1738                 if !skip_last {
1739                         let prev_node = expected_route.first().unwrap();
1740                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1741                         check_added_monitors!(origin_node, 0);
1742                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1743                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1744                         let events = origin_node.node.get_and_clear_pending_events();
1745                         assert_eq!(events.len(), 1);
1746                         let expected_payment_id = match events[0] {
1747                                 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1748                                         assert_eq!(payment_hash, our_payment_hash);
1749                                         assert!(rejected_by_dest);
1750                                         assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1751                                         for (idx, hop) in expected_route.iter().enumerate() {
1752                                                 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1753                                         }
1754                                         payment_id.unwrap()
1755                                 },
1756                                 _ => panic!("Unexpected event"),
1757                         };
1758                         if i == expected_paths.len() - 1 {
1759                                 origin_node.node.abandon_payment(expected_payment_id);
1760                                 let events = origin_node.node.get_and_clear_pending_events();
1761                                 assert_eq!(events.len(), 1);
1762                                 match events[0] {
1763                                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1764                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1765                                                 assert_eq!(*payment_id, expected_payment_id);
1766                                         }
1767                                         _ => panic!("Unexpected second event"),
1768                                 }
1769                         }
1770                 }
1771         }
1772
1773         // Ensure that fail_htlc_backwards is idempotent.
1774         assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1775         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1776         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1777         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1778 }
1779
1780 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1781         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1782 }
1783
1784 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1785         let mut chan_mon_cfgs = Vec::new();
1786         for i in 0..node_count {
1787                 let tx_broadcaster = test_utils::TestBroadcaster {
1788                         txn_broadcasted: Mutex::new(Vec::new()),
1789                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1790                 };
1791                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1792                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1793                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1794                 let persister = test_utils::TestPersister::new();
1795                 let seed = [i as u8; 32];
1796                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1797                 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1798
1799                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1800         }
1801
1802         chan_mon_cfgs
1803 }
1804
1805 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1806         let mut nodes = Vec::new();
1807
1808         for i in 0..node_count {
1809                 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
1810                 let seed = [i as u8; 32];
1811                 nodes.push(NodeCfg {
1812                         chain_source: &chanmon_cfgs[i].chain_source,
1813                         logger: &chanmon_cfgs[i].logger,
1814                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1815                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
1816                         chain_monitor,
1817                         keys_manager: &chanmon_cfgs[i].keys_manager,
1818                         node_seed: seed,
1819                         features: InitFeatures::known(),
1820                         network_graph: &chanmon_cfgs[i].network_graph,
1821                 });
1822         }
1823
1824         nodes
1825 }
1826
1827 pub fn test_default_channel_config() -> UserConfig {
1828         let mut default_config = UserConfig::default();
1829         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1830         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1831         default_config.channel_options.cltv_expiry_delta = 6*6;
1832         default_config.channel_options.announced_channel = true;
1833         default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1834         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1835         // It now defaults to 1, so we simply set it to the expected value here.
1836         default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1837         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1838         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1839         default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1840         default_config
1841 }
1842
1843 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1844         let mut chanmgrs = Vec::new();
1845         for i in 0..node_count {
1846                 let network = Network::Testnet;
1847                 let params = ChainParameters {
1848                         network,
1849                         best_block: BestBlock::from_genesis(network),
1850                 };
1851                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1852                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1853                 chanmgrs.push(node);
1854         }
1855
1856         chanmgrs
1857 }
1858
1859 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1860         let mut nodes = Vec::new();
1861         let chan_count = Rc::new(RefCell::new(0));
1862         let payment_count = Rc::new(RefCell::new(0));
1863         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1864
1865         for i in 0..node_count {
1866                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1867                 nodes.push(Node{
1868                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1869                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1870                         node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1871                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1872                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1873                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1874                         connect_style: Rc::clone(&connect_style),
1875                 })
1876         }
1877
1878         for i in 0..node_count {
1879                 for j in (i+1)..node_count {
1880                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1881                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1882                 }
1883         }
1884
1885         nodes
1886 }
1887
1888 // Note that the following only works for CLTV values up to 128
1889 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1890 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1891
1892 #[derive(PartialEq)]
1893 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1894 /// Tests that the given node has broadcast transactions for the given Channel
1895 ///
1896 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1897 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1898 /// broadcast and the revoked outputs were claimed.
1899 ///
1900 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1901 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1902 ///
1903 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1904 /// also fail.
1905 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>  {
1906         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1907         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1908
1909         let mut res = Vec::with_capacity(2);
1910         node_txn.retain(|tx| {
1911                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1912                         check_spends!(tx, chan.3);
1913                         if commitment_tx.is_none() {
1914                                 res.push(tx.clone());
1915                         }
1916                         false
1917                 } else { true }
1918         });
1919         if let Some(explicit_tx) = commitment_tx {
1920                 res.push(explicit_tx.clone());
1921         }
1922
1923         assert_eq!(res.len(), 1);
1924
1925         if has_htlc_tx != HTLCType::NONE {
1926                 node_txn.retain(|tx| {
1927                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1928                                 check_spends!(tx, res[0]);
1929                                 if has_htlc_tx == HTLCType::TIMEOUT {
1930                                         assert!(tx.lock_time != 0);
1931                                 } else {
1932                                         assert!(tx.lock_time == 0);
1933                                 }
1934                                 res.push(tx.clone());
1935                                 false
1936                         } else { true }
1937                 });
1938                 assert!(res.len() == 2 || res.len() == 3);
1939                 if res.len() == 3 {
1940                         assert_eq!(res[1], res[2]);
1941                 }
1942         }
1943
1944         assert!(node_txn.is_empty());
1945         res
1946 }
1947
1948 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1949 /// HTLC transaction.
1950 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1951         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1952         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1953         // for revoked htlc outputs
1954         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1955         node_txn.retain(|tx| {
1956                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1957                         check_spends!(tx, revoked_tx);
1958                         false
1959                 } else { true }
1960         });
1961         node_txn.retain(|tx| {
1962                 check_spends!(tx, commitment_revoked_tx);
1963                 false
1964         });
1965         assert!(node_txn.is_empty());
1966 }
1967
1968 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1969         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1970
1971         assert!(node_txn.len() >= 1);
1972         assert_eq!(node_txn[0].input.len(), 1);
1973         let mut found_prev = false;
1974
1975         for tx in prev_txn {
1976                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1977                         check_spends!(node_txn[0], tx);
1978                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1979                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1980
1981                         found_prev = true;
1982                         break;
1983                 }
1984         }
1985         assert!(found_prev);
1986
1987         let mut res = Vec::new();
1988         mem::swap(&mut *node_txn, &mut res);
1989         res
1990 }
1991
1992 pub fn handle_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize, needs_err_handle: bool, expected_error: &str)  {
1993         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1994         assert_eq!(events_1.len(), 2);
1995         let as_update = match events_1[0] {
1996                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1997                         msg.clone()
1998                 },
1999                 _ => panic!("Unexpected event"),
2000         };
2001         match events_1[1] {
2002                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2003                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2004                         assert_eq!(msg.data, expected_error);
2005                         if needs_err_handle {
2006                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2007                         }
2008                 },
2009                 _ => panic!("Unexpected event"),
2010         }
2011
2012         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2013         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2014         let bs_update = match events_2[0] {
2015                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2016                         msg.clone()
2017                 },
2018                 _ => panic!("Unexpected event"),
2019         };
2020         if !needs_err_handle {
2021                 match events_2[1] {
2022                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2023                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2024                                 assert_eq!(msg.data, expected_error);
2025                         },
2026                         _ => panic!("Unexpected event"),
2027                 }
2028         }
2029
2030         for node in nodes {
2031                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
2032                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
2033         }
2034 }
2035
2036 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2037         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2038 }
2039
2040 #[cfg(test)]
2041 macro_rules! get_channel_value_stat {
2042         ($node: expr, $channel_id: expr) => {{
2043                 let chan_lock = $node.node.channel_state.lock().unwrap();
2044                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2045                 chan.get_value_stat()
2046         }}
2047 }
2048
2049 macro_rules! get_chan_reestablish_msgs {
2050         ($src_node: expr, $dst_node: expr) => {
2051                 {
2052                         let mut res = Vec::with_capacity(1);
2053                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2054                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2055                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2056                                         res.push(msg.clone());
2057                                 } else {
2058                                         panic!("Unexpected event")
2059                                 }
2060                         }
2061                         res
2062                 }
2063         }
2064 }
2065
2066 macro_rules! handle_chan_reestablish_msgs {
2067         ($src_node: expr, $dst_node: expr) => {
2068                 {
2069                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2070                         let mut idx = 0;
2071                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
2072                                 idx += 1;
2073                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2074                                 Some(msg.clone())
2075                         } else {
2076                                 None
2077                         };
2078
2079                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2080                                 idx += 1;
2081                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2082                         }
2083
2084                         let mut revoke_and_ack = None;
2085                         let mut commitment_update = None;
2086                         let order = if let Some(ev) = msg_events.get(idx) {
2087                                 match ev {
2088                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2089                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2090                                                 revoke_and_ack = Some(msg.clone());
2091                                                 idx += 1;
2092                                                 RAACommitmentOrder::RevokeAndACKFirst
2093                                         },
2094                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2095                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2096                                                 commitment_update = Some(updates.clone());
2097                                                 idx += 1;
2098                                                 RAACommitmentOrder::CommitmentFirst
2099                                         },
2100                                         _ => RAACommitmentOrder::CommitmentFirst,
2101                                 }
2102                         } else {
2103                                 RAACommitmentOrder::CommitmentFirst
2104                         };
2105
2106                         if let Some(ev) = msg_events.get(idx) {
2107                                 match ev {
2108                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2109                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2110                                                 assert!(revoke_and_ack.is_none());
2111                                                 revoke_and_ack = Some(msg.clone());
2112                                                 idx += 1;
2113                                         },
2114                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2115                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2116                                                 assert!(commitment_update.is_none());
2117                                                 commitment_update = Some(updates.clone());
2118                                                 idx += 1;
2119                                         },
2120                                         _ => {},
2121                                 }
2122                         }
2123
2124                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2125                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2126                                 idx += 1;
2127                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2128                         }
2129
2130                         assert_eq!(msg_events.len(), idx);
2131
2132                         (funding_locked, revoke_and_ack, commitment_update, order)
2133                 }
2134         }
2135 }
2136
2137 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2138 /// for claims/fails they are separated out.
2139 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_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
2140         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2141         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2142         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2143         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2144
2145         if send_funding_locked.0 {
2146                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2147                 // from b
2148                 for reestablish in reestablish_1.iter() {
2149                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2150                 }
2151         }
2152         if send_funding_locked.1 {
2153                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2154                 // from a
2155                 for reestablish in reestablish_2.iter() {
2156                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2157                 }
2158         }
2159         if send_funding_locked.0 || send_funding_locked.1 {
2160                 // If we expect any funding_locked's, both sides better have set
2161                 // next_holder_commitment_number to 1
2162                 for reestablish in reestablish_1.iter() {
2163                         assert_eq!(reestablish.next_local_commitment_number, 1);
2164                 }
2165                 for reestablish in reestablish_2.iter() {
2166                         assert_eq!(reestablish.next_local_commitment_number, 1);
2167                 }
2168         }
2169
2170         let mut resp_1 = Vec::new();
2171         for msg in reestablish_1 {
2172                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2173                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2174         }
2175         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2176                 check_added_monitors!(node_b, 1);
2177         } else {
2178                 check_added_monitors!(node_b, 0);
2179         }
2180
2181         let mut resp_2 = Vec::new();
2182         for msg in reestablish_2 {
2183                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2184                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2185         }
2186         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2187                 check_added_monitors!(node_a, 1);
2188         } else {
2189                 check_added_monitors!(node_a, 0);
2190         }
2191
2192         // We don't yet support both needing updates, as that would require a different commitment dance:
2193         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2194                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2195                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2196                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2197
2198         for chan_msgs in resp_1.drain(..) {
2199                 if send_funding_locked.0 {
2200                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2201                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2202                         if !announcement_event.is_empty() {
2203                                 assert_eq!(announcement_event.len(), 1);
2204                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2205                                         //TODO: Test announcement_sigs re-sending
2206                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2207                         }
2208                 } else {
2209                         assert!(chan_msgs.0.is_none());
2210                 }
2211                 if pending_raa.0 {
2212                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2213                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2214                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2215                         check_added_monitors!(node_a, 1);
2216                 } else {
2217                         assert!(chan_msgs.1.is_none());
2218                 }
2219                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2220                         let commitment_update = chan_msgs.2.unwrap();
2221                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2222                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2223                         } else {
2224                                 assert!(commitment_update.update_add_htlcs.is_empty());
2225                         }
2226                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2227                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2228                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2229                         for update_add in commitment_update.update_add_htlcs {
2230                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2231                         }
2232                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2233                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2234                         }
2235                         for update_fail in commitment_update.update_fail_htlcs {
2236                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2237                         }
2238
2239                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2240                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2241                         } else {
2242                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2243                                 check_added_monitors!(node_a, 1);
2244                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2245                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2246                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2247                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2248                                 check_added_monitors!(node_b, 1);
2249                         }
2250                 } else {
2251                         assert!(chan_msgs.2.is_none());
2252                 }
2253         }
2254
2255         for chan_msgs in resp_2.drain(..) {
2256                 if send_funding_locked.1 {
2257                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2258                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2259                         if !announcement_event.is_empty() {
2260                                 assert_eq!(announcement_event.len(), 1);
2261                                 match announcement_event[0] {
2262                                         MessageSendEvent::SendChannelUpdate { .. } => {},
2263                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2264                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2265                                 }
2266                         }
2267                 } else {
2268                         assert!(chan_msgs.0.is_none());
2269                 }
2270                 if pending_raa.1 {
2271                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2272                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2273                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2274                         check_added_monitors!(node_b, 1);
2275                 } else {
2276                         assert!(chan_msgs.1.is_none());
2277                 }
2278                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2279                         let commitment_update = chan_msgs.2.unwrap();
2280                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2281                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2282                         }
2283                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2284                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2285                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2286                         for update_add in commitment_update.update_add_htlcs {
2287                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2288                         }
2289                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2290                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2291                         }
2292                         for update_fail in commitment_update.update_fail_htlcs {
2293                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2294                         }
2295
2296                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2297                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2298                         } else {
2299                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2300                                 check_added_monitors!(node_b, 1);
2301                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2302                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2303                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2304                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2305                                 check_added_monitors!(node_a, 1);
2306                         }
2307                 } else {
2308                         assert!(chan_msgs.2.is_none());
2309                 }
2310         }
2311 }