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