_ Git - rust-lightning/blob - 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};
  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};
  18 use routing::router::{Route, get_route};
  19 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
  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::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::hashes::sha256::Hash as Sha256;
  37 use bitcoin::hashes::Hash;
  38 use bitcoin::hash_types::BlockHash;
  39
  40 use bitcoin::secp256k1::key::PublicKey;
  41
  42 use io;
  43 use prelude::*;
  44 use core::cell::RefCell;
  45 use std::rc::Rc;
  46 use sync::{Arc, Mutex};
  47 use core::mem;
  48
  49 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
  50
  51 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
  52 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
  53 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
  54         confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
  55         connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
  56 }
  57 /// Mine a signle block containing the given transaction
  58 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
  59         let height = node.best_block_info().1 + 1;
  60         confirm_transaction_at(node, tx, height);
  61 }
  62 /// Mine the given transaction at the given height, mining blocks as required to build to that
  63 /// height
  64 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
  65         let first_connect_height = node.best_block_info().1 + 1;
  66         assert!(first_connect_height <= conf_height);
  67         if conf_height > first_connect_height {
  68                 connect_blocks(node, conf_height - first_connect_height);
  69         }
  70         let mut block = Block {
  71                 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
  72                 txdata: Vec::new(),
  73         };
  74         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
  75                 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
  76         }
  77         block.txdata.push(tx.clone());
  78         connect_block(node, &block);
  79 }
  80
  81 /// The possible ways we may notify a ChannelManager of a new block
  82 #[derive(Clone, Copy, PartialEq)]
  83 pub enum ConnectStyle {
  84         /// Calls best_block_updated first, detecting transactions in the block only after receiving the
  85         /// header and height information.
  86         BestBlockFirst,
  87         /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
  88         /// make a single best_block_updated call.
  89         BestBlockFirstSkippingBlocks,
  90         /// Calls transactions_confirmed first, detecting transactions in the block before updating the
  91         /// header and height information.
  92         TransactionsFirst,
  93         /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
  94         /// make a single best_block_updated call.
  95         TransactionsFirstSkippingBlocks,
  96         /// Provides the full block via the chain::Listen interface. In the current code this is
  97         /// equivalent to TransactionsFirst with some additional assertions.
  98         FullBlockViaListen,
  99 }
 100
 101 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
 102         let skip_intermediaries = match *node.connect_style.borrow() {
 103                 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
 104                 _ => false,
 105         };
 106
 107         let height = node.best_block_info().1 + 1;
 108         let mut block = Block {
 109                 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
 110                 txdata: vec![],
 111         };
 112         assert!(depth >= 1);
 113         for i in 1..depth {
 114                 do_connect_block(node, &block, skip_intermediaries);
 115                 block = Block {
 116                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
 117                         txdata: vec![],
 118                 };
 119         }
 120         connect_block(node, &block);
 121         block.header.block_hash()
 122 }
 123
 124 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
 125         do_connect_block(node, block, false);
 126 }
 127
 128 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
 129         let height = node.best_block_info().1 + 1;
 130         if !skip_intermediaries {
 131                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
 132                 match *node.connect_style.borrow() {
 133                         ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
 134                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
 135                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
 136                                 node.node.best_block_updated(&block.header, height);
 137                                 node.node.transactions_confirmed(&block.header, &txdata, height);
 138                         },
 139                         ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
 140                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
 141                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
 142                                 node.node.transactions_confirmed(&block.header, &txdata, height);
 143                                 node.node.best_block_updated(&block.header, height);
 144                         },
 145                         ConnectStyle::FullBlockViaListen => {
 146                                 node.chain_monitor.chain_monitor.block_connected(&block, height);
 147                                 node.node.block_connected(&block, height);
 148                         }
 149                 }
 150         }
 151         node.node.test_process_background_events();
 152         node.blocks.lock().unwrap().push((block.header, height));
 153 }
 154
 155 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
 156         for i in 0..count {
 157                 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
 158                 assert!(orig_header.1 > 0); // Cannot disconnect genesis
 159                 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
 160
 161                 match *node.connect_style.borrow() {
 162                         ConnectStyle::FullBlockViaListen => {
 163                                 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
 164                                 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
 165                         },
 166                         ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
 167                                 if i == count - 1 {
 168                                         node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
 169                                         node.node.best_block_updated(&prev_header.0, prev_header.1);
 170                                 }
 171                         },
 172                         _ => {
 173                                 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
 174                                 node.node.best_block_updated(&prev_header.0, prev_header.1);
 175                         },
 176                 }
 177         }
 178 }
 179
 180 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
 181         let count = node.blocks.lock().unwrap().len() as u32 - 1;
 182         disconnect_blocks(node, count);
 183 }
 184
 185 pub struct TestChanMonCfg {
 186         pub tx_broadcaster: test_utils::TestBroadcaster,
 187         pub fee_estimator: test_utils::TestFeeEstimator,
 188         pub chain_source: test_utils::TestChainSource,
 189         pub persister: test_utils::TestPersister,
 190         pub logger: test_utils::TestLogger,
 191         pub keys_manager: test_utils::TestKeysInterface,
 192 }
 193
 194 pub struct NodeCfg<'a> {
 195         pub chain_source: &'a test_utils::TestChainSource,
 196         pub tx_broadcaster: &'a test_utils::TestBroadcaster,
 197         pub fee_estimator: &'a test_utils::TestFeeEstimator,
 198         pub chain_monitor: test_utils::TestChainMonitor<'a>,
 199         pub keys_manager: &'a test_utils::TestKeysInterface,
 200         pub logger: &'a test_utils::TestLogger,
 201         pub node_seed: [u8; 32],
 202         pub features: InitFeatures,
 203 }
 204
 205 pub struct Node<'a, 'b: 'a, 'c: 'b> {
 206         pub chain_source: &'c test_utils::TestChainSource,
 207         pub tx_broadcaster: &'c test_utils::TestBroadcaster,
 208         pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
 209         pub keys_manager: &'b test_utils::TestKeysInterface,
 210         pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
 211         pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
 212         pub node_seed: [u8; 32],
 213         pub network_payment_count: Rc<RefCell<u8>>,
 214         pub network_chan_count: Rc<RefCell<u32>>,
 215         pub logger: &'c test_utils::TestLogger,
 216         pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
 217         pub connect_style: Rc<RefCell<ConnectStyle>>,
 218 }
 219 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
 220         pub fn best_block_hash(&self) -> BlockHash {
 221                 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
 222         }
 223         pub fn best_block_info(&self) -> (BlockHash, u32) {
 224                 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
 225         }
 226         pub fn get_block_header(&self, height: u32) -> BlockHeader {
 227                 self.blocks.lock().unwrap()[height as usize].0
 228         }
 229 }
 230
 231 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
 232         fn drop(&mut self) {
 233                 if !::std::thread::panicking() {
 234                         // Check that we processed all pending events
 235                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
 236                         assert!(self.node.get_and_clear_pending_events().is_empty());
 237                         assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
 238
 239                         // Check that if we serialize the Router, we can deserialize it again.
 240                         {
 241                                 let mut w = test_utils::TestVecWriter(Vec::new());
 242                                 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
 243                                 network_graph_ser.write(&mut w).unwrap();
 244                                 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
 245                                 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
 246                                 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
 247                                         Some(self.chain_source), self.logger, network_graph_deser
 248                                 );
 249                                 let mut chan_progress = 0;
 250                                 loop {
 251                                         let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 252                                         let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 253                                         assert!(orig_announcements == deserialized_announcements);
 254                                         chan_progress = match orig_announcements.last() {
 255                                                 Some(announcement) => announcement.0.contents.short_channel_id + 1,
 256                                                 None => break,
 257                                         };
 258                                 }
 259                                 let mut node_progress = None;
 260                                 loop {
 261                                         let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 262                                         let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 263                                         assert!(orig_announcements == deserialized_announcements);
 264                                         node_progress = match orig_announcements.last() {
 265                                                 Some(announcement) => Some(announcement.contents.node_id),
 266                                                 None => break,
 267                                         };
 268                                 }
 269                         }
 270
 271                         // Check that if we serialize and then deserialize all our channel monitors we get the
 272                         // same set of outputs to watch for on chain as we have now. Note that if we write
 273                         // tests that fully close channels and remove the monitors at some point this may break.
 274                         let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
 275                         let mut deserialized_monitors = Vec::new();
 276                         {
 277                                 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
 278                                 for (_, old_monitor) in old_monitors.iter() {
 279                                         let mut w = test_utils::TestVecWriter(Vec::new());
 280                                         old_monitor.write(&mut w).unwrap();
 281                                         let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 282                                                 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
 283                                         deserialized_monitors.push(deserialized_monitor);
 284                                 }
 285                         }
 286
 287                         // Before using all the new monitors to check the watch outpoints, use the full set of
 288                         // them to ensure we can write and reload our ChannelManager.
 289                         {
 290                                 let mut channel_monitors = HashMap::new();
 291                                 for monitor in deserialized_monitors.iter_mut() {
 292                                         channel_monitors.insert(monitor.get_funding_txo().0, monitor);
 293                                 }
 294
 295                                 let mut w = test_utils::TestVecWriter(Vec::new());
 296                                 self.node.write(&mut w).unwrap();
 297                                 <(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 {
 298                                         default_config: *self.node.get_current_default_configuration(),
 299                                         keys_manager: self.keys_manager,
 300                                         fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
 301                                         chain_monitor: self.chain_monitor,
 302                                         tx_broadcaster: &test_utils::TestBroadcaster {
 303                                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
 304                                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
 305                                         },
 306                                         logger: &test_utils::TestLogger::new(),
 307                                         channel_monitors,
 308                                 }).unwrap();
 309                         }
 310
 311                         let persister = test_utils::TestPersister::new();
 312                         let broadcaster = test_utils::TestBroadcaster {
 313                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
 314                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
 315                         };
 316                         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
 317                         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
 318                         for deserialized_monitor in deserialized_monitors.drain(..) {
 319                                 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
 320                                         panic!();
 321                                 }
 322                         }
 323                         assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
 324                         assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
 325                 }
 326         }
 327 }
 328
 329 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) {
 330         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
 331 }
 332
 333 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) {
 334         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);
 335         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
 336         (announcement, as_update, bs_update, channel_id, tx)
 337 }
 338
 339 macro_rules! get_revoke_commit_msgs {
 340         ($node: expr, $node_id: expr) => {
 341                 {
 342                         let events = $node.node.get_and_clear_pending_msg_events();
 343                         assert_eq!(events.len(), 2);
 344                         (match events[0] {
 345                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 346                                         assert_eq!(*node_id, $node_id);
 347                                         (*msg).clone()
 348                                 },
 349                                 _ => panic!("Unexpected event"),
 350                         }, match events[1] {
 351                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 352                                         assert_eq!(*node_id, $node_id);
 353                                         assert!(updates.update_add_htlcs.is_empty());
 354                                         assert!(updates.update_fulfill_htlcs.is_empty());
 355                                         assert!(updates.update_fail_htlcs.is_empty());
 356                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 357                                         assert!(updates.update_fee.is_none());
 358                                         updates.commitment_signed.clone()
 359                                 },
 360                                 _ => panic!("Unexpected event"),
 361                         })
 362                 }
 363         }
 364 }
 365
 366 /// Get an specific event message from the pending events queue.
 367 #[macro_export]
 368 macro_rules! get_event_msg {
 369         ($node: expr, $event_type: path, $node_id: expr) => {
 370                 {
 371                         let events = $node.node.get_and_clear_pending_msg_events();
 372                         assert_eq!(events.len(), 1);
 373                         match events[0] {
 374                                 $event_type { ref node_id, ref msg } => {
 375                                         assert_eq!(*node_id, $node_id);
 376                                         (*msg).clone()
 377                                 },
 378                                 _ => panic!("Unexpected event"),
 379                         }
 380                 }
 381         }
 382 }
 383
 384 /// Get a specific event from the pending events queue.
 385 #[macro_export]
 386 macro_rules! get_event {
 387         ($node: expr, $event_type: path) => {
 388                 {
 389                         let mut events = $node.node.get_and_clear_pending_events();
 390                         assert_eq!(events.len(), 1);
 391                         let ev = events.pop().unwrap();
 392                         match ev {
 393                                 $event_type { .. } => {
 394                                         ev
 395                                 },
 396                                 _ => panic!("Unexpected event"),
 397                         }
 398                 }
 399         }
 400 }
 401
 402 #[cfg(test)]
 403 macro_rules! get_htlc_update_msgs {
 404         ($node: expr, $node_id: expr) => {
 405                 {
 406                         let events = $node.node.get_and_clear_pending_msg_events();
 407                         assert_eq!(events.len(), 1);
 408                         match events[0] {
 409                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 410                                         assert_eq!(*node_id, $node_id);
 411                                         (*updates).clone()
 412                                 },
 413                                 _ => panic!("Unexpected event"),
 414                         }
 415                 }
 416         }
 417 }
 418
 419 #[cfg(test)]
 420 macro_rules! get_feerate {
 421         ($node: expr, $channel_id: expr) => {
 422                 {
 423                         let chan_lock = $node.node.channel_state.lock().unwrap();
 424                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
 425                         chan.get_feerate()
 426                 }
 427         }
 428 }
 429
 430 /// Returns any local commitment transactions for the channel.
 431 #[macro_export]
 432 macro_rules! get_local_commitment_txn {
 433         ($node: expr, $channel_id: expr) => {
 434                 {
 435                         let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
 436                         let mut commitment_txn = None;
 437                         for (funding_txo, monitor) in monitors.iter() {
 438                                 if funding_txo.to_channel_id() == $channel_id {
 439                                         commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
 440                                         break;
 441                                 }
 442                         }
 443                         commitment_txn.unwrap()
 444                 }
 445         }
 446 }
 447
 448 /// Check the error from attempting a payment.
 449 #[macro_export]
 450 macro_rules! unwrap_send_err {
 451         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
 452                 match &$res {
 453                         &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
 454                                 assert_eq!(fails.len(), 1);
 455                                 match fails[0] {
 456                                         $type => { $check },
 457                                         _ => panic!(),
 458                                 }
 459                         },
 460                         &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
 461                                 assert_eq!(fails.len(), 1);
 462                                 match fails[0] {
 463                                         Err($type) => { $check },
 464                                         _ => panic!(),
 465                                 }
 466                         },
 467                         _ => panic!(),
 468                 }
 469         }
 470 }
 471
 472 /// Check whether N channel monitor(s) have been added.
 473 #[macro_export]
 474 macro_rules! check_added_monitors {
 475         ($node: expr, $count: expr) => {
 476                 {
 477                         let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
 478                         assert_eq!(added_monitors.len(), $count);
 479                         added_monitors.clear();
 480                 }
 481         }
 482 }
 483
 484 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) {
 485         let chan_id = *node.network_chan_count.borrow();
 486
 487         let events = node.node.get_and_clear_pending_events();
 488         assert_eq!(events.len(), 1);
 489         match events[0] {
 490                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 491                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 492                         assert_eq!(user_channel_id, expected_user_chan_id);
 493
 494                         let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 495                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 496                         }]};
 497                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
 498                         (*temporary_channel_id, tx, funding_outpoint)
 499                 },
 500                 _ => panic!("Unexpected event"),
 501         }
 502 }
 503
 504 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 {
 505         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 506         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
 507         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
 508
 509         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
 510
 511         node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
 512         check_added_monitors!(node_a, 0);
 513
 514         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
 515         {
 516                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
 517                 assert_eq!(added_monitors.len(), 1);
 518                 assert_eq!(added_monitors[0].0, funding_output);
 519                 added_monitors.clear();
 520         }
 521
 522         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()));
 523         {
 524                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
 525                 assert_eq!(added_monitors.len(), 1);
 526                 assert_eq!(added_monitors[0].0, funding_output);
 527                 added_monitors.clear();
 528         }
 529
 530         let events_4 = node_a.node.get_and_clear_pending_events();
 531         assert_eq!(events_4.len(), 0);
 532
 533         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 534         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
 535         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 536
 537         tx
 538 }
 539
 540 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) {
 541         confirm_transaction_at(node_conf, tx, conf_height);
 542         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
 543         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()));
 544 }
 545
 546 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]) {
 547         let channel_id;
 548         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 549         assert_eq!(events_6.len(), 2);
 550         ((match events_6[0] {
 551                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 552                         channel_id = msg.channel_id.clone();
 553                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 554                         msg.clone()
 555                 },
 556                 _ => panic!("Unexpected event"),
 557         }, match events_6[1] {
 558                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 559                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 560                         msg.clone()
 561                 },
 562                 _ => panic!("Unexpected event"),
 563         }), channel_id)
 564 }
 565
 566 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]) {
 567         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
 568         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
 569         confirm_transaction_at(node_a, tx, conf_height);
 570         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
 571         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 572 }
 573
 574 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) {
 575         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 576         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 577         (msgs, chan_id, tx)
 578 }
 579
 580 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) {
 581         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 582         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 583         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 584
 585         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 586         assert_eq!(events_7.len(), 1);
 587         let (announcement, bs_update) = match events_7[0] {
 588                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 589                         (msg, update_msg)
 590                 },
 591                 _ => panic!("Unexpected event"),
 592         };
 593
 594         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 595         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 596         assert_eq!(events_8.len(), 1);
 597         let as_update = match events_8[0] {
 598                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 599                         assert!(*announcement == *msg);
 600                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 601                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 602                         update_msg
 603                 },
 604                 _ => panic!("Unexpected event"),
 605         };
 606
 607         *node_a.network_chan_count.borrow_mut() += 1;
 608
 609         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 610 }
 611
 612 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) {
 613         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 614 }
 615
 616 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) {
 617         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 618         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
 619         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 620 }
 621
 622 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) {
 623         nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
 624         let a_events = nodes[a].node.get_and_clear_pending_msg_events();
 625         assert!(a_events.len() >= 2);
 626
 627         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 628         let mut found_ann_1 = false;
 629         for event in a_events.iter() {
 630                 match event {
 631                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 632                                 if msg == ann { found_ann_1 = true; }
 633                         },
 634                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 635                         _ => panic!("Unexpected event {:?}", event),
 636                 }
 637         }
 638         assert!(found_ann_1);
 639
 640         let a_node_announcement = match a_events.last().unwrap() {
 641                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 642                         (*msg).clone()
 643                 },
 644                 _ => panic!("Unexpected event"),
 645         };
 646
 647         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
 648         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
 649         assert!(b_events.len() >= 2);
 650
 651         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 652         let mut found_ann_2 = false;
 653         for event in b_events.iter() {
 654                 match event {
 655                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 656                                 if msg == ann { found_ann_2 = true; }
 657                         },
 658                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 659                         _ => panic!("Unexpected event"),
 660                 }
 661         }
 662         assert!(found_ann_2);
 663
 664         let b_node_announcement = match b_events.last().unwrap() {
 665                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 666                         (*msg).clone()
 667                 },
 668                 _ => panic!("Unexpected event"),
 669         };
 670
 671         for node in nodes {
 672                 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
 673                 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
 674                 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
 675                 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
 676                 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
 677         }
 678 }
 679
 680 macro_rules! check_spends {
 681         ($tx: expr, $($spends_txn: expr),*) => {
 682                 {
 683                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 684                                 $(
 685                                         if out_point.txid == $spends_txn.txid() {
 686                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 687                                         }
 688                                 )*
 689                                 None
 690                         };
 691                         let mut total_value_in = 0;
 692                         for input in $tx.input.iter() {
 693                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 694                         }
 695                         let mut total_value_out = 0;
 696                         for output in $tx.output.iter() {
 697                                 total_value_out += output.value;
 698                         }
 699                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 700                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 701                         assert!(total_value_out + min_fee <= total_value_in);
 702                         $tx.verify(get_output).unwrap();
 703                 }
 704         }
 705 }
 706
 707 macro_rules! get_closing_signed_broadcast {
 708         ($node: expr, $dest_pubkey: expr) => {
 709                 {
 710                         let events = $node.get_and_clear_pending_msg_events();
 711                         assert!(events.len() == 1 || events.len() == 2);
 712                         (match events[events.len() - 1] {
 713                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 714                                         assert_eq!(msg.contents.flags & 2, 2);
 715                                         msg.clone()
 716                                 },
 717                                 _ => panic!("Unexpected event"),
 718                         }, if events.len() == 2 {
 719                                 match events[0] {
 720                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 721                                                 assert_eq!(*node_id, $dest_pubkey);
 722                                                 Some(msg.clone())
 723                                         },
 724                                         _ => panic!("Unexpected event"),
 725                                 }
 726                         } else { None })
 727                 }
 728         }
 729 }
 730
 731 /// Check that a channel's closing channel update has been broadcasted, and optionally
 732 /// check whether an error message event has occurred.
 733 #[macro_export]
 734 macro_rules! check_closed_broadcast {
 735         ($node: expr, $with_error_msg: expr) => {{
 736                 let events = $node.node.get_and_clear_pending_msg_events();
 737                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
 738                 match events[0] {
 739                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 740                                 assert_eq!(msg.contents.flags & 2, 2);
 741                         },
 742                         _ => panic!("Unexpected event"),
 743                 }
 744                 if $with_error_msg {
 745                         match events[1] {
 746                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 747                                         // TODO: Check node_id
 748                                         Some(msg.clone())
 749                                 },
 750                                 _ => panic!("Unexpected event"),
 751                         }
 752                 } else { None }
 753         }}
 754 }
 755
 756 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) {
 757         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) };
 758         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 759         let (tx_a, tx_b);
 760
 761         node_a.close_channel(channel_id).unwrap();
 762         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()));
 763
 764         let events_1 = node_b.get_and_clear_pending_msg_events();
 765         assert!(events_1.len() >= 1);
 766         let shutdown_b = match events_1[0] {
 767                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 768                         assert_eq!(node_id, &node_a.get_our_node_id());
 769                         msg.clone()
 770                 },
 771                 _ => panic!("Unexpected event"),
 772         };
 773
 774         let closing_signed_b = if !close_inbound_first {
 775                 assert_eq!(events_1.len(), 1);
 776                 None
 777         } else {
 778                 Some(match events_1[1] {
 779                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 780                                 assert_eq!(node_id, &node_a.get_our_node_id());
 781                                 msg.clone()
 782                         },
 783                         _ => panic!("Unexpected event"),
 784                 })
 785         };
 786
 787         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 788         let (as_update, bs_update) = if close_inbound_first {
 789                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 790                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 791                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 792                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 793                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 794
 795                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 796                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 797                 assert!(none_b.is_none());
 798                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 799                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 800                 (as_update, bs_update)
 801         } else {
 802                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 803
 804                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 805                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 806                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 807                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 808
 809                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 810                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 811                 assert!(none_a.is_none());
 812                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 813                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 814                 (as_update, bs_update)
 815         };
 816         assert_eq!(tx_a, tx_b);
 817         check_spends!(tx_a, funding_tx);
 818
 819         (as_update, bs_update, tx_a)
 820 }
 821
 822 pub struct SendEvent {
 823         pub node_id: PublicKey,
 824         pub msgs: Vec<msgs::UpdateAddHTLC>,
 825         pub commitment_msg: msgs::CommitmentSigned,
 826 }
 827 impl SendEvent {
 828         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 829                 assert!(updates.update_fulfill_htlcs.is_empty());
 830                 assert!(updates.update_fail_htlcs.is_empty());
 831                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 832                 assert!(updates.update_fee.is_none());
 833                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 834         }
 835
 836         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 837                 match event {
 838                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 839                         _ => panic!("Unexpected event type!"),
 840                 }
 841         }
 842
 843         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 844                 let mut events = node.node.get_and_clear_pending_msg_events();
 845                 assert_eq!(events.len(), 1);
 846                 SendEvent::from_event(events.pop().unwrap())
 847         }
 848 }
 849
 850 macro_rules! commitment_signed_dance {
 851         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 852                 {
 853                         check_added_monitors!($node_a, 0);
 854                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 855                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 856                         check_added_monitors!($node_a, 1);
 857                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 858                 }
 859         };
 860         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 861                 {
 862                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 863                         check_added_monitors!($node_b, 0);
 864                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 865                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 866                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 867                         check_added_monitors!($node_b, 1);
 868                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 869                         let (bs_revoke_and_ack, extra_msg_option) = {
 870                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 871                                 assert!(events.len() <= 2);
 872                                 (match events[0] {
 873                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 874                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 875                                                 (*msg).clone()
 876                                         },
 877                                         _ => panic!("Unexpected event"),
 878                                 }, events.get(1).map(|e| e.clone()))
 879                         };
 880                         check_added_monitors!($node_b, 1);
 881                         if $fail_backwards {
 882                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 883                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 884                         }
 885                         (extra_msg_option, bs_revoke_and_ack)
 886                 }
 887         };
 888         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 889                 {
 890                         check_added_monitors!($node_a, 0);
 891                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 892                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 893                         check_added_monitors!($node_a, 1);
 894                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 895                         assert!(extra_msg_option.is_none());
 896                         bs_revoke_and_ack
 897                 }
 898         };
 899         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 900                 {
 901                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 902                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 903                         check_added_monitors!($node_a, 1);
 904                         extra_msg_option
 905                 }
 906         };
 907         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 908                 {
 909                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 910                 }
 911         };
 912         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 913                 {
 914                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 915                         if $fail_backwards {
 916                                 expect_pending_htlcs_forwardable!($node_a);
 917                                 check_added_monitors!($node_a, 1);
 918
 919                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 920                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 921                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 922                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 923                                 } else { panic!("Unexpected event"); }
 924                         } else {
 925                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 926                         }
 927                 }
 928         }
 929 }
 930
 931 /// Get a payment preimage and hash.
 932 #[macro_export]
 933 macro_rules! get_payment_preimage_hash {
 934         ($dest_node: expr) => {
 935                 {
 936                         let payment_preimage = PaymentPreimage([*$dest_node.network_payment_count.borrow(); 32]);
 937                         *$dest_node.network_payment_count.borrow_mut() += 1;
 938                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 939                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
 940                         (payment_preimage, payment_hash, payment_secret)
 941                 }
 942         }
 943 }
 944
 945 #[cfg(test)]
 946 macro_rules! get_route_and_payment_hash {
 947         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
 948                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node);
 949                 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 950                 let route = get_route(&$send_node.node.get_our_node_id(),
 951                         &net_graph_msg_handler.network_graph.read().unwrap(),
 952                         &$recv_node.node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, $send_node.logger).unwrap();
 953                 (route, payment_hash, payment_preimage, payment_secret)
 954         }}
 955 }
 956
 957 macro_rules! expect_pending_htlcs_forwardable_ignore {
 958         ($node: expr) => {{
 959                 let events = $node.node.get_and_clear_pending_events();
 960                 assert_eq!(events.len(), 1);
 961                 match events[0] {
 962                         Event::PendingHTLCsForwardable { .. } => { },
 963                         _ => panic!("Unexpected event"),
 964                 };
 965         }}
 966 }
 967
 968 macro_rules! expect_pending_htlcs_forwardable {
 969         ($node: expr) => {{
 970                 expect_pending_htlcs_forwardable_ignore!($node);
 971                 $node.node.process_pending_htlc_forwards();
 972         }}
 973 }
 974
 975 #[cfg(any(test, feature = "unstable"))]
 976 macro_rules! expect_payment_received {
 977         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
 978                 let events = $node.node.get_and_clear_pending_events();
 979                 assert_eq!(events.len(), 1);
 980                 match events[0] {
 981                         Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
 982                                 assert_eq!($expected_payment_hash, *payment_hash);
 983                                 assert_eq!($expected_recv_value, amt);
 984                                 match purpose {
 985                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
 986                                                 assert!(payment_preimage.is_none());
 987                                                 assert_eq!($expected_payment_secret, *payment_secret);
 988                                         },
 989                                         _ => {},
 990                                 }
 991                         },
 992                         _ => panic!("Unexpected event"),
 993                 }
 994         }
 995 }
 996
 997 macro_rules! expect_payment_sent {
 998         ($node: expr, $expected_payment_preimage: expr) => {
 999                 let events = $node.node.get_and_clear_pending_events();
1000                 assert_eq!(events.len(), 1);
1001                 match events[0] {
1002                         Event::PaymentSent { ref payment_preimage } => {
1003                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1004                         },
1005                         _ => panic!("Unexpected event"),
1006                 }
1007         }
1008 }
1009
1010 macro_rules! expect_payment_forwarded {
1011         ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1012                 let events = $node.node.get_and_clear_pending_events();
1013                 assert_eq!(events.len(), 1);
1014                 match events[0] {
1015                         Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1016                                 assert_eq!(fee_earned_msat, $expected_fee);
1017                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1018                         },
1019                         _ => panic!("Unexpected event"),
1020                 }
1021         }
1022 }
1023
1024 #[cfg(test)]
1025 macro_rules! expect_payment_failure_chan_update {
1026         ($node: expr, $scid: expr, $chan_closed: expr) => {
1027                 let events = $node.node.get_and_clear_pending_msg_events();
1028                 assert_eq!(events.len(), 1);
1029                 match events[0] {
1030                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
1031                                 match update {
1032                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg } if !$chan_closed => {
1033                                                 assert_eq!(msg.contents.short_channel_id, $scid);
1034                                                 assert_eq!(msg.contents.flags & 2, 0);
1035                                         },
1036                                         &HTLCFailChannelUpdate::ChannelClosed { short_channel_id, is_permanent } if $chan_closed => {
1037                                                 assert_eq!(short_channel_id, $scid);
1038                                                 assert!(is_permanent);
1039                                         },
1040                                         _ => panic!("Unexpected update type"),
1041                                 }
1042                         },
1043                         _ => panic!("Unexpected event"),
1044                 }
1045         }
1046 }
1047
1048 #[cfg(test)]
1049 macro_rules! expect_payment_failed {
1050         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1051                 let events = $node.node.get_and_clear_pending_events();
1052                 assert_eq!(events.len(), 1);
1053                 match events[0] {
1054                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
1055                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1056                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1057                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1058                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1059                                 $(
1060                                         assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1061                                         assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1062                                 )*
1063                         },
1064                         _ => panic!("Unexpected event"),
1065                 }
1066         }
1067 }
1068
1069 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) {
1070         origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1071         check_added_monitors!(origin_node, expected_paths.len());
1072         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1073 }
1074
1075 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>) {
1076         let mut payment_event = SendEvent::from_event(ev);
1077         let mut prev_node = origin_node;
1078
1079         for (idx, &node) in expected_path.iter().enumerate() {
1080                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1081
1082                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1083                 check_added_monitors!(node, 0);
1084                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1085
1086                 expect_pending_htlcs_forwardable!(node);
1087
1088                 if idx == expected_path.len() - 1 {
1089                         let events_2 = node.node.get_and_clear_pending_events();
1090                         if payment_received_expected {
1091                                 assert_eq!(events_2.len(), 1);
1092                                 match events_2[0] {
1093                                         Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1094                                                 assert_eq!(our_payment_hash, *payment_hash);
1095                                                 match &purpose {
1096                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1097                                                                 assert_eq!(expected_preimage, *payment_preimage);
1098                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1099                                                         },
1100                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1101                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1102                                                                 assert!(our_payment_secret.is_none());
1103                                                         },
1104                                                 }
1105                                                 assert_eq!(amt, recv_value);
1106                                         },
1107                                         _ => panic!("Unexpected event"),
1108                                 }
1109                         } else {
1110                                 assert!(events_2.is_empty());
1111                         }
1112                 } else {
1113                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1114                         assert_eq!(events_2.len(), 1);
1115                         check_added_monitors!(node, 1);
1116                         payment_event = SendEvent::from_event(events_2.remove(0));
1117                         assert_eq!(payment_event.msgs.len(), 1);
1118                 }
1119
1120                 prev_node = node;
1121         }
1122 }
1123
1124 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) {
1125         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1126         assert_eq!(events.len(), expected_route.len());
1127         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1128                 // Once we've gotten through all the HTLCs, the last one should result in a
1129                 // PaymentReceived (but each previous one should not!), .
1130                 let expect_payment = path_idx == expected_route.len() - 1;
1131                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1132         }
1133 }
1134
1135 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) {
1136         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1137         send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1138         (our_payment_preimage, our_payment_hash, our_payment_secret)
1139 }
1140
1141 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) {
1142         for path in expected_paths.iter() {
1143                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1144         }
1145         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1146         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1147
1148         macro_rules! msgs_from_ev {
1149                 ($ev: expr) => {
1150                         match $ev {
1151                                 &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 } } => {
1152                                         assert!(update_add_htlcs.is_empty());
1153                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1154                                         assert!(update_fail_htlcs.is_empty());
1155                                         assert!(update_fail_malformed_htlcs.is_empty());
1156                                         assert!(update_fee.is_none());
1157                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1158                                 },
1159                                 _ => panic!("Unexpected event"),
1160                         }
1161                 }
1162         }
1163         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1164         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1165         assert_eq!(events.len(), expected_paths.len());
1166         for ev in events.iter() {
1167                 per_path_msgs.push(msgs_from_ev!(ev));
1168         }
1169
1170         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1171                 let mut next_msgs = Some(path_msgs);
1172                 let mut expected_next_node = next_hop;
1173
1174                 macro_rules! last_update_fulfill_dance {
1175                         ($node: expr, $prev_node: expr) => {
1176                                 {
1177                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1178                                         check_added_monitors!($node, 0);
1179                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1180                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1181                                 }
1182                         }
1183                 }
1184                 macro_rules! mid_update_fulfill_dance {
1185                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1186                                 {
1187                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1188                                         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;
1189                                         expect_payment_forwarded!($node, Some(fee as u64), false);
1190                                         check_added_monitors!($node, 1);
1191                                         let new_next_msgs = if $new_msgs {
1192                                                 let events = $node.node.get_and_clear_pending_msg_events();
1193                                                 assert_eq!(events.len(), 1);
1194                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1195                                                 expected_next_node = nexthop;
1196                                                 Some(res)
1197                                         } else {
1198                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1199                                                 None
1200                                         };
1201                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1202                                         next_msgs = new_next_msgs;
1203                                 }
1204                         }
1205                 }
1206
1207                 let mut prev_node = expected_route.last().unwrap();
1208                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1209                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1210                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1211                         if next_msgs.is_some() {
1212                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1213                         } else {
1214                                 assert!(!update_next_msgs);
1215                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1216                         }
1217                         if !skip_last && idx == expected_route.len() - 1 {
1218                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1219                         }
1220
1221                         prev_node = node;
1222                 }
1223
1224                 if !skip_last {
1225                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1226                         expect_payment_sent!(origin_node, our_payment_preimage);
1227                 }
1228         }
1229 }
1230
1231 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1232         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1233 }
1234
1235 pub const TEST_FINAL_CLTV: u32 = 70;
1236
1237 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) {
1238         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1239         let logger = test_utils::TestLogger::new();
1240         let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(),
1241                 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
1242                 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
1243                 recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1244         assert_eq!(route.paths.len(), 1);
1245         assert_eq!(route.paths[0].len(), expected_route.len());
1246         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1247                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1248         }
1249
1250         send_along_route(origin_node, route, expected_route, recv_value)
1251 }
1252
1253 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1254         let logger = test_utils::TestLogger::new();
1255         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1256         let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1257         assert_eq!(route.paths.len(), 1);
1258         assert_eq!(route.paths[0].len(), expected_route.len());
1259         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1260                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1261         }
1262
1263         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1264         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1265                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1266 }
1267
1268 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1269         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1270         claim_payment(&origin, expected_route, our_payment_preimage);
1271 }
1272
1273 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_hash: PaymentHash)  {
1274         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1275         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1276         check_added_monitors!(expected_route.last().unwrap(), 1);
1277
1278         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1279         macro_rules! update_fail_dance {
1280                 ($node: expr, $prev_node: expr, $last_node: expr) => {
1281                         {
1282                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1283                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1284                                 if skip_last && $last_node {
1285                                         expect_pending_htlcs_forwardable!($node);
1286                                 }
1287                         }
1288                 }
1289         }
1290
1291         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1292         let mut prev_node = expected_route.last().unwrap();
1293         for (idx, node) in expected_route.iter().rev().enumerate() {
1294                 assert_eq!(expected_next_node, node.node.get_our_node_id());
1295                 if next_msgs.is_some() {
1296                         // We may be the "last node" for the purpose of the commitment dance if we're
1297                         // skipping the last node (implying it is disconnected) and we're the
1298                         // second-to-last node!
1299                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1300                 }
1301
1302                 let events = node.node.get_and_clear_pending_msg_events();
1303                 if !skip_last || idx != expected_route.len() - 1 {
1304                         assert_eq!(events.len(), 1);
1305                         match events[0] {
1306                                 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 } } => {
1307                                         assert!(update_add_htlcs.is_empty());
1308                                         assert!(update_fulfill_htlcs.is_empty());
1309                                         assert_eq!(update_fail_htlcs.len(), 1);
1310                                         assert!(update_fail_malformed_htlcs.is_empty());
1311                                         assert!(update_fee.is_none());
1312                                         expected_next_node = node_id.clone();
1313                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1314                                 },
1315                                 _ => panic!("Unexpected event"),
1316                         }
1317                 } else {
1318                         assert!(events.is_empty());
1319                 }
1320                 if !skip_last && idx == expected_route.len() - 1 {
1321                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1322                 }
1323
1324                 prev_node = node;
1325         }
1326
1327         if !skip_last {
1328                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1329
1330                 let events = origin_node.node.get_and_clear_pending_events();
1331                 assert_eq!(events.len(), 1);
1332                 match events[0] {
1333                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1334                                 assert_eq!(payment_hash, our_payment_hash);
1335                                 assert!(rejected_by_dest);
1336                         },
1337                         _ => panic!("Unexpected event"),
1338                 }
1339         }
1340 }
1341
1342 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1343         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1344 }
1345
1346 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1347         let mut chan_mon_cfgs = Vec::new();
1348         for i in 0..node_count {
1349                 let tx_broadcaster = test_utils::TestBroadcaster {
1350                         txn_broadcasted: Mutex::new(Vec::new()),
1351                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1352                 };
1353                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1354                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1355                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1356                 let persister = test_utils::TestPersister::new();
1357                 let seed = [i as u8; 32];
1358                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1359
1360                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1361         }
1362
1363         chan_mon_cfgs
1364 }
1365
1366 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1367         let mut nodes = Vec::new();
1368
1369         for i in 0..node_count {
1370                 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);
1371                 let seed = [i as u8; 32];
1372                 nodes.push(NodeCfg {
1373                         chain_source: &chanmon_cfgs[i].chain_source,
1374                         logger: &chanmon_cfgs[i].logger,
1375                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1376                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
1377                         chain_monitor,
1378                         keys_manager: &chanmon_cfgs[i].keys_manager,
1379                         node_seed: seed,
1380                         features: InitFeatures::known(),
1381                 });
1382         }
1383
1384         nodes
1385 }
1386
1387 pub fn test_default_channel_config() -> UserConfig {
1388         let mut default_config = UserConfig::default();
1389         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1390         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1391         default_config.channel_options.cltv_expiry_delta = 6*6;
1392         default_config.channel_options.announced_channel = true;
1393         default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1394         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1395         // It now defaults to 1, so we simply set it to the expected value here.
1396         default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1397         default_config
1398 }
1399
1400 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>> {
1401         let mut chanmgrs = Vec::new();
1402         for i in 0..node_count {
1403                 let network = Network::Testnet;
1404                 let params = ChainParameters {
1405                         network,
1406                         best_block: BestBlock::from_genesis(network),
1407                 };
1408                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1409                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1410                 chanmgrs.push(node);
1411         }
1412
1413         chanmgrs
1414 }
1415
1416 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>> {
1417         let mut nodes = Vec::new();
1418         let chan_count = Rc::new(RefCell::new(0));
1419         let payment_count = Rc::new(RefCell::new(0));
1420         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1421
1422         for i in 0..node_count {
1423                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1424                 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1425                                  tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1426                                  keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1427                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1428                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1429                                  blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1430                                  connect_style: Rc::clone(&connect_style),
1431                 })
1432         }
1433
1434         for i in 0..node_count {
1435                 for j in (i+1)..node_count {
1436                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1437                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1438                 }
1439         }
1440
1441         nodes
1442 }
1443
1444 // Note that the following only works for CLTV values up to 128
1445 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1446 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1447
1448 #[derive(PartialEq)]
1449 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1450 /// Tests that the given node has broadcast transactions for the given Channel
1451 ///
1452 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1453 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1454 /// broadcast and the revoked outputs were claimed.
1455 ///
1456 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1457 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1458 ///
1459 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1460 /// also fail.
1461 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>  {
1462         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1463         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1464
1465         let mut res = Vec::with_capacity(2);
1466         node_txn.retain(|tx| {
1467                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1468                         check_spends!(tx, chan.3);
1469                         if commitment_tx.is_none() {
1470                                 res.push(tx.clone());
1471                         }
1472                         false
1473                 } else { true }
1474         });
1475         if let Some(explicit_tx) = commitment_tx {
1476                 res.push(explicit_tx.clone());
1477         }
1478
1479         assert_eq!(res.len(), 1);
1480
1481         if has_htlc_tx != HTLCType::NONE {
1482                 node_txn.retain(|tx| {
1483                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1484                                 check_spends!(tx, res[0]);
1485                                 if has_htlc_tx == HTLCType::TIMEOUT {
1486                                         assert!(tx.lock_time != 0);
1487                                 } else {
1488                                         assert!(tx.lock_time == 0);
1489                                 }
1490                                 res.push(tx.clone());
1491                                 false
1492                         } else { true }
1493                 });
1494                 assert!(res.len() == 2 || res.len() == 3);
1495                 if res.len() == 3 {
1496                         assert_eq!(res[1], res[2]);
1497                 }
1498         }
1499
1500         assert!(node_txn.is_empty());
1501         res
1502 }
1503
1504 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1505 /// HTLC transaction.
1506 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1507         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1508         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1509         // for revoked htlc outputs
1510         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1511         node_txn.retain(|tx| {
1512                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1513                         check_spends!(tx, revoked_tx);
1514                         false
1515                 } else { true }
1516         });
1517         node_txn.retain(|tx| {
1518                 check_spends!(tx, commitment_revoked_tx);
1519                 false
1520         });
1521         assert!(node_txn.is_empty());
1522 }
1523
1524 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1525         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1526
1527         assert!(node_txn.len() >= 1);
1528         assert_eq!(node_txn[0].input.len(), 1);
1529         let mut found_prev = false;
1530
1531         for tx in prev_txn {
1532                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1533                         check_spends!(node_txn[0], tx);
1534                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1535                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1536
1537                         found_prev = true;
1538                         break;
1539                 }
1540         }
1541         assert!(found_prev);
1542
1543         let mut res = Vec::new();
1544         mem::swap(&mut *node_txn, &mut res);
1545         res
1546 }
1547
1548 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)  {
1549         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1550         assert_eq!(events_1.len(), 2);
1551         let as_update = match events_1[0] {
1552                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1553                         msg.clone()
1554                 },
1555                 _ => panic!("Unexpected event"),
1556         };
1557         match events_1[1] {
1558                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1559                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
1560                         assert_eq!(msg.data, expected_error);
1561                         if needs_err_handle {
1562                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1563                         }
1564                 },
1565                 _ => panic!("Unexpected event"),
1566         }
1567
1568         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1569         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1570         let bs_update = match events_2[0] {
1571                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1572                         msg.clone()
1573                 },
1574                 _ => panic!("Unexpected event"),
1575         };
1576         if !needs_err_handle {
1577                 match events_2[1] {
1578                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1579                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1580                                 assert_eq!(msg.data, expected_error);
1581                         },
1582                         _ => panic!("Unexpected event"),
1583                 }
1584         }
1585
1586         for node in nodes {
1587                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1588                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1589         }
1590 }
1591
1592 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1593         handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1594 }
1595
1596 #[cfg(test)]
1597 macro_rules! get_channel_value_stat {
1598         ($node: expr, $channel_id: expr) => {{
1599                 let chan_lock = $node.node.channel_state.lock().unwrap();
1600                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1601                 chan.get_value_stat()
1602         }}
1603 }
1604
1605 macro_rules! get_chan_reestablish_msgs {
1606         ($src_node: expr, $dst_node: expr) => {
1607                 {
1608                         let mut res = Vec::with_capacity(1);
1609                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1610                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1611                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1612                                         res.push(msg.clone());
1613                                 } else {
1614                                         panic!("Unexpected event")
1615                                 }
1616                         }
1617                         res
1618                 }
1619         }
1620 }
1621
1622 macro_rules! handle_chan_reestablish_msgs {
1623         ($src_node: expr, $dst_node: expr) => {
1624                 {
1625                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1626                         let mut idx = 0;
1627                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1628                                 idx += 1;
1629                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1630                                 Some(msg.clone())
1631                         } else {
1632                                 None
1633                         };
1634
1635                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1636                                 idx += 1;
1637                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1638                         }
1639
1640                         let mut revoke_and_ack = None;
1641                         let mut commitment_update = None;
1642                         let order = if let Some(ev) = msg_events.get(idx) {
1643                                 match ev {
1644                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1645                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1646                                                 revoke_and_ack = Some(msg.clone());
1647                                                 idx += 1;
1648                                                 RAACommitmentOrder::RevokeAndACKFirst
1649                                         },
1650                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1651                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1652                                                 commitment_update = Some(updates.clone());
1653                                                 idx += 1;
1654                                                 RAACommitmentOrder::CommitmentFirst
1655                                         },
1656                                         &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1657                                         _ => panic!("Unexpected event"),
1658                                 }
1659                         } else {
1660                                 RAACommitmentOrder::CommitmentFirst
1661                         };
1662
1663                         if let Some(ev) = msg_events.get(idx) {
1664                                 match ev {
1665                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1666                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1667                                                 assert!(revoke_and_ack.is_none());
1668                                                 revoke_and_ack = Some(msg.clone());
1669                                                 idx += 1;
1670                                         },
1671                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1672                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1673                                                 assert!(commitment_update.is_none());
1674                                                 commitment_update = Some(updates.clone());
1675                                                 idx += 1;
1676                                         },
1677                                         &MessageSendEvent::SendChannelUpdate { .. } => {},
1678                                         _ => panic!("Unexpected event"),
1679                                 }
1680                         }
1681
1682                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1683                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1684                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1685                         }
1686
1687                         (funding_locked, revoke_and_ack, commitment_update, order)
1688                 }
1689         }
1690 }
1691
1692 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1693 /// for claims/fails they are separated out.
1694 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))  {
1695         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1696         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1697         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1698         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1699
1700         if send_funding_locked.0 {
1701                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1702                 // from b
1703                 for reestablish in reestablish_1.iter() {
1704                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1705                 }
1706         }
1707         if send_funding_locked.1 {
1708                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1709                 // from a
1710                 for reestablish in reestablish_2.iter() {
1711                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1712                 }
1713         }
1714         if send_funding_locked.0 || send_funding_locked.1 {
1715                 // If we expect any funding_locked's, both sides better have set
1716                 // next_holder_commitment_number to 1
1717                 for reestablish in reestablish_1.iter() {
1718                         assert_eq!(reestablish.next_local_commitment_number, 1);
1719                 }
1720                 for reestablish in reestablish_2.iter() {
1721                         assert_eq!(reestablish.next_local_commitment_number, 1);
1722                 }
1723         }
1724
1725         let mut resp_1 = Vec::new();
1726         for msg in reestablish_1 {
1727                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1728                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1729         }
1730         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1731                 check_added_monitors!(node_b, 1);
1732         } else {
1733                 check_added_monitors!(node_b, 0);
1734         }
1735
1736         let mut resp_2 = Vec::new();
1737         for msg in reestablish_2 {
1738                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1739                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1740         }
1741         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1742                 check_added_monitors!(node_a, 1);
1743         } else {
1744                 check_added_monitors!(node_a, 0);
1745         }
1746
1747         // We don't yet support both needing updates, as that would require a different commitment dance:
1748         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1749                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1750                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1751                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1752
1753         for chan_msgs in resp_1.drain(..) {
1754                 if send_funding_locked.0 {
1755                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1756                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1757                         if !announcement_event.is_empty() {
1758                                 assert_eq!(announcement_event.len(), 1);
1759                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1760                                         //TODO: Test announcement_sigs re-sending
1761                                 } else { panic!("Unexpected event!"); }
1762                         }
1763                 } else {
1764                         assert!(chan_msgs.0.is_none());
1765                 }
1766                 if pending_raa.0 {
1767                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1768                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1769                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1770                         check_added_monitors!(node_a, 1);
1771                 } else {
1772                         assert!(chan_msgs.1.is_none());
1773                 }
1774                 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 {
1775                         let commitment_update = chan_msgs.2.unwrap();
1776                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1777                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1778                         } else {
1779                                 assert!(commitment_update.update_add_htlcs.is_empty());
1780                         }
1781                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1782                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1783                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1784                         for update_add in commitment_update.update_add_htlcs {
1785                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1786                         }
1787                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1788                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1789                         }
1790                         for update_fail in commitment_update.update_fail_htlcs {
1791                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1792                         }
1793
1794                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1795                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1796                         } else {
1797                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1798                                 check_added_monitors!(node_a, 1);
1799                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1800                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1801                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1802                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1803                                 check_added_monitors!(node_b, 1);
1804                         }
1805                 } else {
1806                         assert!(chan_msgs.2.is_none());
1807                 }
1808         }
1809
1810         for chan_msgs in resp_2.drain(..) {
1811                 if send_funding_locked.1 {
1812                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1813                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1814                         if !announcement_event.is_empty() {
1815                                 assert_eq!(announcement_event.len(), 1);
1816                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1817                                         //TODO: Test announcement_sigs re-sending
1818                                 } else { panic!("Unexpected event!"); }
1819                         }
1820                 } else {
1821                         assert!(chan_msgs.0.is_none());
1822                 }
1823                 if pending_raa.1 {
1824                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1825                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1826                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1827                         check_added_monitors!(node_b, 1);
1828                 } else {
1829                         assert!(chan_msgs.1.is_none());
1830                 }
1831                 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 {
1832                         let commitment_update = chan_msgs.2.unwrap();
1833                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1834                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1835                         }
1836                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
1837                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
1838                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1839                         for update_add in commitment_update.update_add_htlcs {
1840                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1841                         }
1842                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1843                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1844                         }
1845                         for update_fail in commitment_update.update_fail_htlcs {
1846                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1847                         }
1848
1849                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1850                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1851                         } else {
1852                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1853                                 check_added_monitors!(node_b, 1);
1854                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1855                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1856                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1857                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1858                                 check_added_monitors!(node_a, 1);
1859                         }
1860                 } else {
1861                         assert!(chan_msgs.2.is_none());
1862                 }
1863         }
1864 }