_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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