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