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