_ 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!(a_events.len() >= 2);
 619
 620         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 621         let mut found_ann_1 = false;
 622         for event in a_events.iter() {
 623                 match event {
 624                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 625                                 if msg == ann { found_ann_1 = true; }
 626                         },
 627                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 628                         _ => panic!("Unexpected event {:?}", event),
 629                 }
 630         }
 631         assert!(found_ann_1);
 632
 633         let a_node_announcement = match a_events.last().unwrap() {
 634                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 635                         (*msg).clone()
 636                 },
 637                 _ => panic!("Unexpected event"),
 638         };
 639
 640         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
 641         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
 642         assert!(b_events.len() >= 2);
 643
 644         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 645         let mut found_ann_2 = false;
 646         for event in b_events.iter() {
 647                 match event {
 648                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 649                                 if msg == ann { found_ann_2 = true; }
 650                         },
 651                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 652                         _ => panic!("Unexpected event"),
 653                 }
 654         }
 655         assert!(found_ann_2);
 656
 657         let b_node_announcement = match b_events.last().unwrap() {
 658                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 659                         (*msg).clone()
 660                 },
 661                 _ => panic!("Unexpected event"),
 662         };
 663
 664         for node in nodes {
 665                 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
 666                 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
 667                 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
 668                 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
 669                 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
 670         }
 671 }
 672
 673 macro_rules! check_spends {
 674         ($tx: expr, $($spends_txn: expr),*) => {
 675                 {
 676                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 677                                 $(
 678                                         if out_point.txid == $spends_txn.txid() {
 679                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 680                                         }
 681                                 )*
 682                                 None
 683                         };
 684                         let mut total_value_in = 0;
 685                         for input in $tx.input.iter() {
 686                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 687                         }
 688                         let mut total_value_out = 0;
 689                         for output in $tx.output.iter() {
 690                                 total_value_out += output.value;
 691                         }
 692                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 693                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 694                         assert!(total_value_out + min_fee <= total_value_in);
 695                         $tx.verify(get_output).unwrap();
 696                 }
 697         }
 698 }
 699
 700 macro_rules! get_closing_signed_broadcast {
 701         ($node: expr, $dest_pubkey: expr) => {
 702                 {
 703                         let events = $node.get_and_clear_pending_msg_events();
 704                         assert!(events.len() == 1 || events.len() == 2);
 705                         (match events[events.len() - 1] {
 706                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 707                                         assert_eq!(msg.contents.flags & 2, 2);
 708                                         msg.clone()
 709                                 },
 710                                 _ => panic!("Unexpected event"),
 711                         }, if events.len() == 2 {
 712                                 match events[0] {
 713                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 714                                                 assert_eq!(*node_id, $dest_pubkey);
 715                                                 Some(msg.clone())
 716                                         },
 717                                         _ => panic!("Unexpected event"),
 718                                 }
 719                         } else { None })
 720                 }
 721         }
 722 }
 723
 724 /// Check that a channel's closing channel update has been broadcasted, and optionally
 725 /// check whether an error message event has occurred.
 726 #[macro_export]
 727 macro_rules! check_closed_broadcast {
 728         ($node: expr, $with_error_msg: expr) => {{
 729                 let events = $node.node.get_and_clear_pending_msg_events();
 730                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
 731                 match events[0] {
 732                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 733                                 assert_eq!(msg.contents.flags & 2, 2);
 734                         },
 735                         _ => panic!("Unexpected event"),
 736                 }
 737                 if $with_error_msg {
 738                         match events[1] {
 739                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 740                                         // TODO: Check node_id
 741                                         Some(msg.clone())
 742                                 },
 743                                 _ => panic!("Unexpected event"),
 744                         }
 745                 } else { None }
 746         }}
 747 }
 748
 749 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) {
 750         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) };
 751         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 752         let (tx_a, tx_b);
 753
 754         node_a.close_channel(channel_id).unwrap();
 755         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()));
 756
 757         let events_1 = node_b.get_and_clear_pending_msg_events();
 758         assert!(events_1.len() >= 1);
 759         let shutdown_b = match events_1[0] {
 760                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 761                         assert_eq!(node_id, &node_a.get_our_node_id());
 762                         msg.clone()
 763                 },
 764                 _ => panic!("Unexpected event"),
 765         };
 766
 767         let closing_signed_b = if !close_inbound_first {
 768                 assert_eq!(events_1.len(), 1);
 769                 None
 770         } else {
 771                 Some(match events_1[1] {
 772                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 773                                 assert_eq!(node_id, &node_a.get_our_node_id());
 774                                 msg.clone()
 775                         },
 776                         _ => panic!("Unexpected event"),
 777                 })
 778         };
 779
 780         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 781         let (as_update, bs_update) = if close_inbound_first {
 782                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 783                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 784                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 785                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 786                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 787
 788                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 789                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 790                 assert!(none_b.is_none());
 791                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 792                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 793                 (as_update, bs_update)
 794         } else {
 795                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 796
 797                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 798                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 799                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 800                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 801
 802                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 803                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 804                 assert!(none_a.is_none());
 805                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 806                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 807                 (as_update, bs_update)
 808         };
 809         assert_eq!(tx_a, tx_b);
 810         check_spends!(tx_a, funding_tx);
 811
 812         (as_update, bs_update, tx_a)
 813 }
 814
 815 pub struct SendEvent {
 816         pub node_id: PublicKey,
 817         pub msgs: Vec<msgs::UpdateAddHTLC>,
 818         pub commitment_msg: msgs::CommitmentSigned,
 819 }
 820 impl SendEvent {
 821         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 822                 assert!(updates.update_fulfill_htlcs.is_empty());
 823                 assert!(updates.update_fail_htlcs.is_empty());
 824                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 825                 assert!(updates.update_fee.is_none());
 826                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 827         }
 828
 829         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 830                 match event {
 831                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 832                         _ => panic!("Unexpected event type!"),
 833                 }
 834         }
 835
 836         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 837                 let mut events = node.node.get_and_clear_pending_msg_events();
 838                 assert_eq!(events.len(), 1);
 839                 SendEvent::from_event(events.pop().unwrap())
 840         }
 841 }
 842
 843 macro_rules! commitment_signed_dance {
 844         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 845                 {
 846                         check_added_monitors!($node_a, 0);
 847                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 848                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 849                         check_added_monitors!($node_a, 1);
 850                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 851                 }
 852         };
 853         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 854                 {
 855                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 856                         check_added_monitors!($node_b, 0);
 857                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 858                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 859                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 860                         check_added_monitors!($node_b, 1);
 861                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 862                         let (bs_revoke_and_ack, extra_msg_option) = {
 863                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 864                                 assert!(events.len() <= 2);
 865                                 (match events[0] {
 866                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 867                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 868                                                 (*msg).clone()
 869                                         },
 870                                         _ => panic!("Unexpected event"),
 871                                 }, events.get(1).map(|e| e.clone()))
 872                         };
 873                         check_added_monitors!($node_b, 1);
 874                         if $fail_backwards {
 875                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 876                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 877                         }
 878                         (extra_msg_option, bs_revoke_and_ack)
 879                 }
 880         };
 881         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 882                 {
 883                         check_added_monitors!($node_a, 0);
 884                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 885                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 886                         check_added_monitors!($node_a, 1);
 887                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 888                         assert!(extra_msg_option.is_none());
 889                         bs_revoke_and_ack
 890                 }
 891         };
 892         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 893                 {
 894                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 895                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 896                         check_added_monitors!($node_a, 1);
 897                         extra_msg_option
 898                 }
 899         };
 900         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 901                 {
 902                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 903                 }
 904         };
 905         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 906                 {
 907                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 908                         if $fail_backwards {
 909                                 expect_pending_htlcs_forwardable!($node_a);
 910                                 check_added_monitors!($node_a, 1);
 911
 912                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 913                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 914                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 915                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 916                                 } else { panic!("Unexpected event"); }
 917                         } else {
 918                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 919                         }
 920                 }
 921         }
 922 }
 923
 924 /// Get a payment preimage and hash.
 925 #[macro_export]
 926 macro_rules! get_payment_preimage_hash {
 927         ($dest_node: expr) => {
 928                 {
 929                         let payment_preimage = PaymentPreimage([*$dest_node.network_payment_count.borrow(); 32]);
 930                         *$dest_node.network_payment_count.borrow_mut() += 1;
 931                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 932                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
 933                         (payment_preimage, payment_hash, payment_secret)
 934                 }
 935         }
 936 }
 937
 938 #[cfg(test)]
 939 macro_rules! get_route_and_payment_hash {
 940         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
 941                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node);
 942                 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 943                 let route = get_route(&$send_node.node.get_our_node_id(),
 944                         &net_graph_msg_handler.network_graph.read().unwrap(),
 945                         &$recv_node.node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, $send_node.logger).unwrap();
 946                 (route, payment_hash, payment_preimage, payment_secret)
 947         }}
 948 }
 949
 950 macro_rules! expect_pending_htlcs_forwardable_ignore {
 951         ($node: expr) => {{
 952                 let events = $node.node.get_and_clear_pending_events();
 953                 assert_eq!(events.len(), 1);
 954                 match events[0] {
 955                         Event::PendingHTLCsForwardable { .. } => { },
 956                         _ => panic!("Unexpected event"),
 957                 };
 958         }}
 959 }
 960
 961 macro_rules! expect_pending_htlcs_forwardable {
 962         ($node: expr) => {{
 963                 expect_pending_htlcs_forwardable_ignore!($node);
 964                 $node.node.process_pending_htlc_forwards();
 965         }}
 966 }
 967
 968 #[cfg(any(test, feature = "unstable"))]
 969 macro_rules! expect_payment_received {
 970         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
 971                 let events = $node.node.get_and_clear_pending_events();
 972                 assert_eq!(events.len(), 1);
 973                 match events[0] {
 974                         Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
 975                                 assert_eq!($expected_payment_hash, *payment_hash);
 976                                 assert!(payment_preimage.is_none());
 977                                 assert_eq!($expected_payment_secret, *payment_secret);
 978                                 assert_eq!($expected_recv_value, amt);
 979                         },
 980                         _ => panic!("Unexpected event"),
 981                 }
 982         }
 983 }
 984
 985 macro_rules! expect_payment_sent {
 986         ($node: expr, $expected_payment_preimage: expr) => {
 987                 let events = $node.node.get_and_clear_pending_events();
 988                 assert_eq!(events.len(), 1);
 989                 match events[0] {
 990                         Event::PaymentSent { ref payment_preimage } => {
 991                                 assert_eq!($expected_payment_preimage, *payment_preimage);
 992                         },
 993                         _ => panic!("Unexpected event"),
 994                 }
 995         }
 996 }
 997
 998 #[cfg(test)]
 999 macro_rules! expect_payment_failed {
1000         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1001                 let events = $node.node.get_and_clear_pending_events();
1002                 assert_eq!(events.len(), 1);
1003                 match events[0] {
1004                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
1005                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1006                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1007                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1008                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1009                                 $(
1010                                         assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1011                                         assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1012                                 )*
1013                         },
1014                         _ => panic!("Unexpected event"),
1015                 }
1016         }
1017 }
1018
1019 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) {
1020         origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1021         check_added_monitors!(origin_node, expected_paths.len());
1022         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1023 }
1024
1025 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) {
1026         let mut payment_event = SendEvent::from_event(ev);
1027         let mut prev_node = origin_node;
1028
1029         for (idx, &node) in expected_path.iter().enumerate() {
1030                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1031
1032                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1033                 check_added_monitors!(node, 0);
1034                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1035
1036                 expect_pending_htlcs_forwardable!(node);
1037
1038                 if idx == expected_path.len() - 1 {
1039                         let events_2 = node.node.get_and_clear_pending_events();
1040                         if payment_received_expected {
1041                                 assert_eq!(events_2.len(), 1);
1042                                 match events_2[0] {
1043                                         Event::PaymentReceived { ref payment_hash, ref payment_preimage, ref payment_secret, amt, user_payment_id: _ } => {
1044                                                 assert_eq!(our_payment_hash, *payment_hash);
1045                                                 assert!(payment_preimage.is_none());
1046                                                 assert_eq!(our_payment_secret, *payment_secret);
1047                                                 assert_eq!(amt, recv_value);
1048                                         },
1049                                         _ => panic!("Unexpected event"),
1050                                 }
1051                         } else {
1052                                 assert!(events_2.is_empty());
1053                         }
1054                 } else {
1055                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1056                         assert_eq!(events_2.len(), 1);
1057                         check_added_monitors!(node, 1);
1058                         payment_event = SendEvent::from_event(events_2.remove(0));
1059                         assert_eq!(payment_event.msgs.len(), 1);
1060                 }
1061
1062                 prev_node = node;
1063         }
1064 }
1065
1066 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) {
1067         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1068         assert_eq!(events.len(), expected_route.len());
1069         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1070                 // Once we've gotten through all the HTLCs, the last one should result in a
1071                 // PaymentReceived (but each previous one should not!), .
1072                 let expect_payment = path_idx == expected_route.len() - 1;
1073                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
1074         }
1075 }
1076
1077 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) {
1078         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1079         send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1080         (our_payment_preimage, our_payment_hash, our_payment_secret)
1081 }
1082
1083 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) {
1084         for path in expected_paths.iter() {
1085                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1086         }
1087         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1088         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1089
1090         macro_rules! msgs_from_ev {
1091                 ($ev: expr) => {
1092                         match $ev {
1093                                 &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 } } => {
1094                                         assert!(update_add_htlcs.is_empty());
1095                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1096                                         assert!(update_fail_htlcs.is_empty());
1097                                         assert!(update_fail_malformed_htlcs.is_empty());
1098                                         assert!(update_fee.is_none());
1099                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1100                                 },
1101                                 _ => panic!("Unexpected event"),
1102                         }
1103                 }
1104         }
1105         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1106         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1107         assert_eq!(events.len(), expected_paths.len());
1108         for ev in events.iter() {
1109                 per_path_msgs.push(msgs_from_ev!(ev));
1110         }
1111
1112         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1113                 let mut next_msgs = Some(path_msgs);
1114                 let mut expected_next_node = next_hop;
1115
1116                 macro_rules! last_update_fulfill_dance {
1117                         ($node: expr, $prev_node: expr) => {
1118                                 {
1119                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1120                                         check_added_monitors!($node, 0);
1121                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1122                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1123                                 }
1124                         }
1125                 }
1126                 macro_rules! mid_update_fulfill_dance {
1127                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1128                                 {
1129                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1130                                         check_added_monitors!($node, 1);
1131                                         let new_next_msgs = if $new_msgs {
1132                                                 let events = $node.node.get_and_clear_pending_msg_events();
1133                                                 assert_eq!(events.len(), 1);
1134                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1135                                                 expected_next_node = nexthop;
1136                                                 Some(res)
1137                                         } else {
1138                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1139                                                 None
1140                                         };
1141                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1142                                         next_msgs = new_next_msgs;
1143                                 }
1144                         }
1145                 }
1146
1147                 let mut prev_node = expected_route.last().unwrap();
1148                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1149                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1150                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1151                         if next_msgs.is_some() {
1152                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1153                         } else {
1154                                 assert!(!update_next_msgs);
1155                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1156                         }
1157                         if !skip_last && idx == expected_route.len() - 1 {
1158                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1159                         }
1160
1161                         prev_node = node;
1162                 }
1163
1164                 if !skip_last {
1165                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1166                         expect_payment_sent!(origin_node, our_payment_preimage);
1167                 }
1168         }
1169 }
1170
1171 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1172         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1173 }
1174
1175 pub const TEST_FINAL_CLTV: u32 = 70;
1176
1177 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) {
1178         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1179         let logger = test_utils::TestLogger::new();
1180         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();
1181         assert_eq!(route.paths.len(), 1);
1182         assert_eq!(route.paths[0].len(), expected_route.len());
1183         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1184                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1185         }
1186
1187         send_along_route(origin_node, route, expected_route, recv_value)
1188 }
1189
1190 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1191         let logger = test_utils::TestLogger::new();
1192         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1193         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();
1194         assert_eq!(route.paths.len(), 1);
1195         assert_eq!(route.paths[0].len(), expected_route.len());
1196         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1197                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1198         }
1199
1200         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1201         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1202                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1203 }
1204
1205 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1206         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1207         claim_payment(&origin, expected_route, our_payment_preimage);
1208 }
1209
1210 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)  {
1211         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1212         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1213         check_added_monitors!(expected_route.last().unwrap(), 1);
1214
1215         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1216         macro_rules! update_fail_dance {
1217                 ($node: expr, $prev_node: expr, $last_node: expr) => {
1218                         {
1219                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1220                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1221                                 if skip_last && $last_node {
1222                                         expect_pending_htlcs_forwardable!($node);
1223                                 }
1224                         }
1225                 }
1226         }
1227
1228         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1229         let mut prev_node = expected_route.last().unwrap();
1230         for (idx, node) in expected_route.iter().rev().enumerate() {
1231                 assert_eq!(expected_next_node, node.node.get_our_node_id());
1232                 if next_msgs.is_some() {
1233                         // We may be the "last node" for the purpose of the commitment dance if we're
1234                         // skipping the last node (implying it is disconnected) and we're the
1235                         // second-to-last node!
1236                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1237                 }
1238
1239                 let events = node.node.get_and_clear_pending_msg_events();
1240                 if !skip_last || idx != expected_route.len() - 1 {
1241                         assert_eq!(events.len(), 1);
1242                         match events[0] {
1243                                 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 } } => {
1244                                         assert!(update_add_htlcs.is_empty());
1245                                         assert!(update_fulfill_htlcs.is_empty());
1246                                         assert_eq!(update_fail_htlcs.len(), 1);
1247                                         assert!(update_fail_malformed_htlcs.is_empty());
1248                                         assert!(update_fee.is_none());
1249                                         expected_next_node = node_id.clone();
1250                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1251                                 },
1252                                 _ => panic!("Unexpected event"),
1253                         }
1254                 } else {
1255                         assert!(events.is_empty());
1256                 }
1257                 if !skip_last && idx == expected_route.len() - 1 {
1258                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1259                 }
1260
1261                 prev_node = node;
1262         }
1263
1264         if !skip_last {
1265                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1266
1267                 let events = origin_node.node.get_and_clear_pending_events();
1268                 assert_eq!(events.len(), 1);
1269                 match events[0] {
1270                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1271                                 assert_eq!(payment_hash, our_payment_hash);
1272                                 assert!(rejected_by_dest);
1273                         },
1274                         _ => panic!("Unexpected event"),
1275                 }
1276         }
1277 }
1278
1279 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1280         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1281 }
1282
1283 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1284         let mut chan_mon_cfgs = Vec::new();
1285         for i in 0..node_count {
1286                 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1287                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1288                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1289                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1290                 let persister = test_utils::TestPersister::new();
1291                 let seed = [i as u8; 32];
1292                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1293
1294                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1295         }
1296
1297         chan_mon_cfgs
1298 }
1299
1300 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1301         let mut nodes = Vec::new();
1302
1303         for i in 0..node_count {
1304                 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);
1305                 let seed = [i as u8; 32];
1306                 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 });
1307         }
1308
1309         nodes
1310 }
1311
1312 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>> {
1313         let mut chanmgrs = Vec::new();
1314         for i in 0..node_count {
1315                 let mut default_config = UserConfig::default();
1316                 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1317                 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1318                 default_config.channel_options.cltv_expiry_delta = 6*6;
1319                 default_config.channel_options.announced_channel = true;
1320                 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1321                 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
1322                 let network = Network::Testnet;
1323                 let params = ChainParameters {
1324                         network,
1325                         best_block: BestBlock::from_genesis(network),
1326                 };
1327                 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);
1328                 chanmgrs.push(node);
1329         }
1330
1331         chanmgrs
1332 }
1333
1334 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>> {
1335         let mut nodes = Vec::new();
1336         let chan_count = Rc::new(RefCell::new(0));
1337         let payment_count = Rc::new(RefCell::new(0));
1338         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1339
1340         for i in 0..node_count {
1341                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1342                 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1343                                  tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1344                                  keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1345                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1346                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1347                                  blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)]),
1348                                  connect_style: Rc::clone(&connect_style),
1349                 })
1350         }
1351
1352         nodes
1353 }
1354
1355 // Note that the following only works for CLTV values up to 128
1356 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1357 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1358
1359 #[derive(PartialEq)]
1360 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1361 /// Tests that the given node has broadcast transactions for the given Channel
1362 ///
1363 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1364 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1365 /// broadcast and the revoked outputs were claimed.
1366 ///
1367 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1368 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1369 ///
1370 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1371 /// also fail.
1372 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>  {
1373         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1374         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1375
1376         let mut res = Vec::with_capacity(2);
1377         node_txn.retain(|tx| {
1378                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1379                         check_spends!(tx, chan.3);
1380                         if commitment_tx.is_none() {
1381                                 res.push(tx.clone());
1382                         }
1383                         false
1384                 } else { true }
1385         });
1386         if let Some(explicit_tx) = commitment_tx {
1387                 res.push(explicit_tx.clone());
1388         }
1389
1390         assert_eq!(res.len(), 1);
1391
1392         if has_htlc_tx != HTLCType::NONE {
1393                 node_txn.retain(|tx| {
1394                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1395                                 check_spends!(tx, res[0]);
1396                                 if has_htlc_tx == HTLCType::TIMEOUT {
1397                                         assert!(tx.lock_time != 0);
1398                                 } else {
1399                                         assert!(tx.lock_time == 0);
1400                                 }
1401                                 res.push(tx.clone());
1402                                 false
1403                         } else { true }
1404                 });
1405                 assert!(res.len() == 2 || res.len() == 3);
1406                 if res.len() == 3 {
1407                         assert_eq!(res[1], res[2]);
1408                 }
1409         }
1410
1411         assert!(node_txn.is_empty());
1412         res
1413 }
1414
1415 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1416 /// HTLC transaction.
1417 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1418         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1419         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1420         // for revoked htlc outputs
1421         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1422         node_txn.retain(|tx| {
1423                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1424                         check_spends!(tx, revoked_tx);
1425                         false
1426                 } else { true }
1427         });
1428         node_txn.retain(|tx| {
1429                 check_spends!(tx, commitment_revoked_tx);
1430                 false
1431         });
1432         assert!(node_txn.is_empty());
1433 }
1434
1435 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1436         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1437
1438         assert!(node_txn.len() >= 1);
1439         assert_eq!(node_txn[0].input.len(), 1);
1440         let mut found_prev = false;
1441
1442         for tx in prev_txn {
1443                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1444                         check_spends!(node_txn[0], tx);
1445                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1446                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1447
1448                         found_prev = true;
1449                         break;
1450                 }
1451         }
1452         assert!(found_prev);
1453
1454         let mut res = Vec::new();
1455         mem::swap(&mut *node_txn, &mut res);
1456         res
1457 }
1458
1459 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)  {
1460         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1461         assert_eq!(events_1.len(), 2);
1462         let as_update = match events_1[0] {
1463                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1464                         msg.clone()
1465                 },
1466                 _ => panic!("Unexpected event"),
1467         };
1468         match events_1[1] {
1469                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1470                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
1471                         assert_eq!(msg.data, expected_error);
1472                         if needs_err_handle {
1473                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1474                         }
1475                 },
1476                 _ => panic!("Unexpected event"),
1477         }
1478
1479         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1480         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1481         let bs_update = match events_2[0] {
1482                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1483                         msg.clone()
1484                 },
1485                 _ => panic!("Unexpected event"),
1486         };
1487         if !needs_err_handle {
1488                 match events_2[1] {
1489                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1490                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1491                                 assert_eq!(msg.data, expected_error);
1492                         },
1493                         _ => panic!("Unexpected event"),
1494                 }
1495         }
1496
1497         for node in nodes {
1498                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1499                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1500         }
1501 }
1502
1503 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1504         handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1505 }
1506
1507 #[cfg(test)]
1508 macro_rules! get_channel_value_stat {
1509         ($node: expr, $channel_id: expr) => {{
1510                 let chan_lock = $node.node.channel_state.lock().unwrap();
1511                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1512                 chan.get_value_stat()
1513         }}
1514 }
1515
1516 macro_rules! get_chan_reestablish_msgs {
1517         ($src_node: expr, $dst_node: expr) => {
1518                 {
1519                         let mut res = Vec::with_capacity(1);
1520                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1521                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1522                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1523                                         res.push(msg.clone());
1524                                 } else {
1525                                         panic!("Unexpected event")
1526                                 }
1527                         }
1528                         res
1529                 }
1530         }
1531 }
1532
1533 macro_rules! handle_chan_reestablish_msgs {
1534         ($src_node: expr, $dst_node: expr) => {
1535                 {
1536                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1537                         let mut idx = 0;
1538                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1539                                 idx += 1;
1540                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1541                                 Some(msg.clone())
1542                         } else {
1543                                 None
1544                         };
1545
1546                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1547                                 idx += 1;
1548                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1549                         }
1550
1551                         let mut revoke_and_ack = None;
1552                         let mut commitment_update = None;
1553                         let order = if let Some(ev) = msg_events.get(idx) {
1554                                 idx += 1;
1555                                 match ev {
1556                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1557                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1558                                                 revoke_and_ack = Some(msg.clone());
1559                                                 RAACommitmentOrder::RevokeAndACKFirst
1560                                         },
1561                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1562                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1563                                                 commitment_update = Some(updates.clone());
1564                                                 RAACommitmentOrder::CommitmentFirst
1565                                         },
1566                                         _ => panic!("Unexpected event"),
1567                                 }
1568                         } else {
1569                                 RAACommitmentOrder::CommitmentFirst
1570                         };
1571
1572                         if let Some(ev) = msg_events.get(idx) {
1573                                 match ev {
1574                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1575                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1576                                                 assert!(revoke_and_ack.is_none());
1577                                                 revoke_and_ack = Some(msg.clone());
1578                                         },
1579                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1580                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1581                                                 assert!(commitment_update.is_none());
1582                                                 commitment_update = Some(updates.clone());
1583                                         },
1584                                         _ => panic!("Unexpected event"),
1585                                 }
1586                         }
1587
1588                         (funding_locked, revoke_and_ack, commitment_update, order)
1589                 }
1590         }
1591 }
1592
1593 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1594 /// for claims/fails they are separated out.
1595 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))  {
1596         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1597         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1598         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1599         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1600
1601         if send_funding_locked.0 {
1602                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1603                 // from b
1604                 for reestablish in reestablish_1.iter() {
1605                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1606                 }
1607         }
1608         if send_funding_locked.1 {
1609                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1610                 // from a
1611                 for reestablish in reestablish_2.iter() {
1612                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1613                 }
1614         }
1615         if send_funding_locked.0 || send_funding_locked.1 {
1616                 // If we expect any funding_locked's, both sides better have set
1617                 // next_holder_commitment_number to 1
1618                 for reestablish in reestablish_1.iter() {
1619                         assert_eq!(reestablish.next_local_commitment_number, 1);
1620                 }
1621                 for reestablish in reestablish_2.iter() {
1622                         assert_eq!(reestablish.next_local_commitment_number, 1);
1623                 }
1624         }
1625
1626         let mut resp_1 = Vec::new();
1627         for msg in reestablish_1 {
1628                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1629                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1630         }
1631         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1632                 check_added_monitors!(node_b, 1);
1633         } else {
1634                 check_added_monitors!(node_b, 0);
1635         }
1636
1637         let mut resp_2 = Vec::new();
1638         for msg in reestablish_2 {
1639                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1640                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1641         }
1642         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1643                 check_added_monitors!(node_a, 1);
1644         } else {
1645                 check_added_monitors!(node_a, 0);
1646         }
1647
1648         // We don't yet support both needing updates, as that would require a different commitment dance:
1649         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1650                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1651
1652         for chan_msgs in resp_1.drain(..) {
1653                 if send_funding_locked.0 {
1654                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1655                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1656                         if !announcement_event.is_empty() {
1657                                 assert_eq!(announcement_event.len(), 1);
1658                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1659                                         //TODO: Test announcement_sigs re-sending
1660                                 } else { panic!("Unexpected event!"); }
1661                         }
1662                 } else {
1663                         assert!(chan_msgs.0.is_none());
1664                 }
1665                 if pending_raa.0 {
1666                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1667                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1668                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1669                         check_added_monitors!(node_a, 1);
1670                 } else {
1671                         assert!(chan_msgs.1.is_none());
1672                 }
1673                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1674                         let commitment_update = chan_msgs.2.unwrap();
1675                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1676                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1677                         } else {
1678                                 assert!(commitment_update.update_add_htlcs.is_empty());
1679                         }
1680                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1681                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1682                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1683                         for update_add in commitment_update.update_add_htlcs {
1684                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1685                         }
1686                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1687                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1688                         }
1689                         for update_fail in commitment_update.update_fail_htlcs {
1690                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1691                         }
1692
1693                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1694                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1695                         } else {
1696                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1697                                 check_added_monitors!(node_a, 1);
1698                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1699                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1700                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1701                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1702                                 check_added_monitors!(node_b, 1);
1703                         }
1704                 } else {
1705                         assert!(chan_msgs.2.is_none());
1706                 }
1707         }
1708
1709         for chan_msgs in resp_2.drain(..) {
1710                 if send_funding_locked.1 {
1711                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1712                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1713                         if !announcement_event.is_empty() {
1714                                 assert_eq!(announcement_event.len(), 1);
1715                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1716                                         //TODO: Test announcement_sigs re-sending
1717                                 } else { panic!("Unexpected event!"); }
1718                         }
1719                 } else {
1720                         assert!(chan_msgs.0.is_none());
1721                 }
1722                 if pending_raa.1 {
1723                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1724                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1725                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1726                         check_added_monitors!(node_b, 1);
1727                 } else {
1728                         assert!(chan_msgs.1.is_none());
1729                 }
1730                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1731                         let commitment_update = chan_msgs.2.unwrap();
1732                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1733                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1734                         }
1735                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1736                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1737                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1738                         for update_add in commitment_update.update_add_htlcs {
1739                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1740                         }
1741                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1742                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1743                         }
1744                         for update_fail in commitment_update.update_fail_htlcs {
1745                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1746                         }
1747
1748                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1749                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1750                         } else {
1751                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1752                                 check_added_monitors!(node_b, 1);
1753                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1754                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1755                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1756                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1757                                 check_added_monitors!(node_a, 1);
1758                         }
1759                 } else {
1760                         assert!(chan_msgs.2.is_none());
1761                 }
1762         }
1763 }