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