_ 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::{BestBlock, Confirm, Listen, Watch};
  14 use chain::channelmonitor::ChannelMonitor;
  15 use chain::transaction::OutPoint;
  16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId};
  18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
  19 use routing::router::{Payee, Route, get_route};
  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::{panicking, TestChainMonitor};
  26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
  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::hash_types::BlockHash;
  37
  38 use bitcoin::secp256k1::key::PublicKey;
  39
  40 use io;
  41 use prelude::*;
  42 use core::cell::RefCell;
  43 use alloc::rc::Rc;
  44 use sync::{Arc, Mutex};
  45 use core::mem;
  46
  47 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
  48
  49 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
  50 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
  51 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
  52         confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
  53         connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
  54 }
  55 /// Mine a signle block containing the given transaction
  56 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
  57         let height = node.best_block_info().1 + 1;
  58         confirm_transaction_at(node, tx, height);
  59 }
  60 /// Mine the given transaction at the given height, mining blocks as required to build to that
  61 /// height
  62 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
  63         let first_connect_height = node.best_block_info().1 + 1;
  64         assert!(first_connect_height <= conf_height);
  65         if conf_height > first_connect_height {
  66                 connect_blocks(node, conf_height - first_connect_height);
  67         }
  68         let mut block = Block {
  69                 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
  70                 txdata: Vec::new(),
  71         };
  72         for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
  73                 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
  74         }
  75         block.txdata.push(tx.clone());
  76         connect_block(node, &block);
  77 }
  78
  79 /// The possible ways we may notify a ChannelManager of a new block
  80 #[derive(Clone, Copy, PartialEq)]
  81 pub enum ConnectStyle {
  82         /// Calls best_block_updated first, detecting transactions in the block only after receiving the
  83         /// header and height information.
  84         BestBlockFirst,
  85         /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
  86         /// make a single best_block_updated call.
  87         BestBlockFirstSkippingBlocks,
  88         /// Calls transactions_confirmed first, detecting transactions in the block before updating the
  89         /// header and height information.
  90         TransactionsFirst,
  91         /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
  92         /// make a single best_block_updated call.
  93         TransactionsFirstSkippingBlocks,
  94         /// Provides the full block via the chain::Listen interface. In the current code this is
  95         /// equivalent to TransactionsFirst with some additional assertions.
  96         FullBlockViaListen,
  97 }
  98
  99 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
 100         let skip_intermediaries = match *node.connect_style.borrow() {
 101                 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
 102                 _ => false,
 103         };
 104
 105         let height = node.best_block_info().1 + 1;
 106         let mut block = Block {
 107                 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
 108                 txdata: vec![],
 109         };
 110         assert!(depth >= 1);
 111         for i in 1..depth {
 112                 do_connect_block(node, &block, skip_intermediaries);
 113                 block = Block {
 114                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
 115                         txdata: vec![],
 116                 };
 117         }
 118         connect_block(node, &block);
 119         block.header.block_hash()
 120 }
 121
 122 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
 123         do_connect_block(node, block, false);
 124 }
 125
 126 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
 127         let height = node.best_block_info().1 + 1;
 128         if !skip_intermediaries {
 129                 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
 130                 match *node.connect_style.borrow() {
 131                         ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
 132                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
 133                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
 134                                 node.node.best_block_updated(&block.header, height);
 135                                 node.node.transactions_confirmed(&block.header, &txdata, height);
 136                         },
 137                         ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
 138                                 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
 139                                 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
 140                                 node.node.transactions_confirmed(&block.header, &txdata, height);
 141                                 node.node.best_block_updated(&block.header, height);
 142                         },
 143                         ConnectStyle::FullBlockViaListen => {
 144                                 node.chain_monitor.chain_monitor.block_connected(&block, height);
 145                                 node.node.block_connected(&block, height);
 146                         }
 147                 }
 148         }
 149         node.node.test_process_background_events();
 150         node.blocks.lock().unwrap().push((block.header, height));
 151 }
 152
 153 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
 154         for i in 0..count {
 155                 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
 156                 assert!(orig_header.1 > 0); // Cannot disconnect genesis
 157                 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
 158
 159                 match *node.connect_style.borrow() {
 160                         ConnectStyle::FullBlockViaListen => {
 161                                 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
 162                                 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
 163                         },
 164                         ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
 165                                 if i == count - 1 {
 166                                         node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
 167                                         node.node.best_block_updated(&prev_header.0, prev_header.1);
 168                                 }
 169                         },
 170                         _ => {
 171                                 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
 172                                 node.node.best_block_updated(&prev_header.0, prev_header.1);
 173                         },
 174                 }
 175         }
 176 }
 177
 178 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
 179         let count = node.blocks.lock().unwrap().len() as u32 - 1;
 180         disconnect_blocks(node, count);
 181 }
 182
 183 pub struct TestChanMonCfg {
 184         pub tx_broadcaster: test_utils::TestBroadcaster,
 185         pub fee_estimator: test_utils::TestFeeEstimator,
 186         pub chain_source: test_utils::TestChainSource,
 187         pub persister: test_utils::TestPersister,
 188         pub logger: test_utils::TestLogger,
 189         pub keys_manager: test_utils::TestKeysInterface,
 190         pub network_graph: NetworkGraph,
 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 network_graph: &'a NetworkGraph,
 201         pub node_seed: [u8; 32],
 202         pub features: InitFeatures,
 203 }
 204
 205 pub struct Node<'a, 'b: 'a, 'c: 'b> {
 206         pub chain_source: &'c test_utils::TestChainSource,
 207         pub tx_broadcaster: &'c test_utils::TestBroadcaster,
 208         pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
 209         pub keys_manager: &'b test_utils::TestKeysInterface,
 210         pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
 211         pub network_graph: &'c NetworkGraph,
 212         pub net_graph_msg_handler: NetGraphMsgHandler<&'c NetworkGraph, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
 213         pub node_seed: [u8; 32],
 214         pub network_payment_count: Rc<RefCell<u8>>,
 215         pub network_chan_count: Rc<RefCell<u32>>,
 216         pub logger: &'c test_utils::TestLogger,
 217         pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
 218         pub connect_style: Rc<RefCell<ConnectStyle>>,
 219 }
 220 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
 221         pub fn best_block_hash(&self) -> BlockHash {
 222                 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
 223         }
 224         pub fn best_block_info(&self) -> (BlockHash, u32) {
 225                 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
 226         }
 227         pub fn get_block_header(&self, height: u32) -> BlockHeader {
 228                 self.blocks.lock().unwrap()[height as usize].0
 229         }
 230 }
 231
 232 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
 233         fn drop(&mut self) {
 234                 if !panicking() {
 235                         // Check that we processed all pending events
 236                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
 237                         assert!(self.node.get_and_clear_pending_events().is_empty());
 238                         assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
 239
 240                         // Check that if we serialize the Router, we can deserialize it again.
 241                         {
 242                                 let mut w = test_utils::TestVecWriter(Vec::new());
 243                                 self.network_graph.write(&mut w).unwrap();
 244                                 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
 245                                 assert!(network_graph_deser == *self.network_graph);
 246                                 let net_graph_msg_handler = NetGraphMsgHandler::new(
 247                                         &network_graph_deser, Some(self.chain_source), self.logger
 248                                 );
 249                                 let mut chan_progress = 0;
 250                                 loop {
 251                                         let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 252                                         let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 253                                         assert!(orig_announcements == deserialized_announcements);
 254                                         chan_progress = match orig_announcements.last() {
 255                                                 Some(announcement) => announcement.0.contents.short_channel_id + 1,
 256                                                 None => break,
 257                                         };
 258                                 }
 259                                 let mut node_progress = None;
 260                                 loop {
 261                                         let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 262                                         let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 263                                         assert!(orig_announcements == deserialized_announcements);
 264                                         node_progress = match orig_announcements.last() {
 265                                                 Some(announcement) => Some(announcement.contents.node_id),
 266                                                 None => break,
 267                                         };
 268                                 }
 269                         }
 270
 271                         // Check that if we serialize and then deserialize all our channel monitors we get the
 272                         // same set of outputs to watch for on chain as we have now. Note that if we write
 273                         // tests that fully close channels and remove the monitors at some point this may break.
 274                         let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
 275                         let mut deserialized_monitors = Vec::new();
 276                         {
 277                                 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
 278                                         let mut w = test_utils::TestVecWriter(Vec::new());
 279                                         self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
 280                                         let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 281                                                 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
 282                                         deserialized_monitors.push(deserialized_monitor);
 283                                 }
 284                         }
 285
 286                         // Before using all the new monitors to check the watch outpoints, use the full set of
 287                         // them to ensure we can write and reload our ChannelManager.
 288                         {
 289                                 let mut channel_monitors = HashMap::new();
 290                                 for monitor in deserialized_monitors.iter_mut() {
 291                                         channel_monitors.insert(monitor.get_funding_txo().0, monitor);
 292                                 }
 293
 294                                 let mut w = test_utils::TestVecWriter(Vec::new());
 295                                 self.node.write(&mut w).unwrap();
 296                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
 297                                         default_config: *self.node.get_current_default_configuration(),
 298                                         keys_manager: self.keys_manager,
 299                                         fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
 300                                         chain_monitor: self.chain_monitor,
 301                                         tx_broadcaster: &test_utils::TestBroadcaster {
 302                                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
 303                                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
 304                                         },
 305                                         logger: &self.logger,
 306                                         channel_monitors,
 307                                 }).unwrap();
 308                         }
 309
 310                         let persister = test_utils::TestPersister::new();
 311                         let broadcaster = test_utils::TestBroadcaster {
 312                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
 313                                 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
 314                         };
 315                         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
 316                         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
 317                         for deserialized_monitor in deserialized_monitors.drain(..) {
 318                                 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
 319                                         panic!();
 320                                 }
 321                         }
 322                         assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
 323                         assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
 324                 }
 325         }
 326 }
 327
 328 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) {
 329         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
 330 }
 331
 332 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) {
 333         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);
 334         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
 335         (announcement, as_update, bs_update, channel_id, tx)
 336 }
 337
 338 #[macro_export]
 339 /// Gets an RAA and CS which were sent in response to a commitment update
 340 macro_rules! get_revoke_commit_msgs {
 341         ($node: expr, $node_id: expr) => {
 342                 {
 343                         use $crate::util::events::MessageSendEvent;
 344                         let events = $node.node.get_and_clear_pending_msg_events();
 345                         assert_eq!(events.len(), 2);
 346                         (match events[0] {
 347                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 348                                         assert_eq!(*node_id, $node_id);
 349                                         (*msg).clone()
 350                                 },
 351                                 _ => panic!("Unexpected event"),
 352                         }, match events[1] {
 353                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 354                                         assert_eq!(*node_id, $node_id);
 355                                         assert!(updates.update_add_htlcs.is_empty());
 356                                         assert!(updates.update_fulfill_htlcs.is_empty());
 357                                         assert!(updates.update_fail_htlcs.is_empty());
 358                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 359                                         assert!(updates.update_fee.is_none());
 360                                         updates.commitment_signed.clone()
 361                                 },
 362                                 _ => panic!("Unexpected event"),
 363                         })
 364                 }
 365         }
 366 }
 367
 368 /// Get an specific event message from the pending events queue.
 369 #[macro_export]
 370 macro_rules! get_event_msg {
 371         ($node: expr, $event_type: path, $node_id: expr) => {
 372                 {
 373                         let events = $node.node.get_and_clear_pending_msg_events();
 374                         assert_eq!(events.len(), 1);
 375                         match events[0] {
 376                                 $event_type { ref node_id, ref msg } => {
 377                                         assert_eq!(*node_id, $node_id);
 378                                         (*msg).clone()
 379                                 },
 380                                 _ => panic!("Unexpected event"),
 381                         }
 382                 }
 383         }
 384 }
 385
 386 /// Get a specific event from the pending events queue.
 387 #[macro_export]
 388 macro_rules! get_event {
 389         ($node: expr, $event_type: path) => {
 390                 {
 391                         let mut events = $node.node.get_and_clear_pending_events();
 392                         assert_eq!(events.len(), 1);
 393                         let ev = events.pop().unwrap();
 394                         match ev {
 395                                 $event_type { .. } => {
 396                                         ev
 397                                 },
 398                                 _ => panic!("Unexpected event"),
 399                         }
 400                 }
 401         }
 402 }
 403
 404 #[macro_export]
 405 /// Gets an UpdateHTLCs MessageSendEvent
 406 macro_rules! get_htlc_update_msgs {
 407         ($node: expr, $node_id: expr) => {
 408                 {
 409                         let events = $node.node.get_and_clear_pending_msg_events();
 410                         assert_eq!(events.len(), 1);
 411                         match events[0] {
 412                                 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 413                                         assert_eq!(*node_id, $node_id);
 414                                         (*updates).clone()
 415                                 },
 416                                 _ => panic!("Unexpected event"),
 417                         }
 418                 }
 419         }
 420 }
 421
 422 #[cfg(test)]
 423 macro_rules! get_channel_ref {
 424         ($node: expr, $lock: ident, $channel_id: expr) => {
 425                 {
 426                         $lock = $node.node.channel_state.lock().unwrap();
 427                         $lock.by_id.get_mut(&$channel_id).unwrap()
 428                 }
 429         }
 430 }
 431
 432 #[cfg(test)]
 433 macro_rules! get_feerate {
 434         ($node: expr, $channel_id: expr) => {
 435                 {
 436                         let mut lock;
 437                         let chan = get_channel_ref!($node, lock, $channel_id);
 438                         chan.get_feerate()
 439                 }
 440         }
 441 }
 442
 443 #[cfg(test)]
 444 macro_rules! get_opt_anchors {
 445         ($node: expr, $channel_id: expr) => {
 446                 {
 447                         let mut lock;
 448                         let chan = get_channel_ref!($node, lock, $channel_id);
 449                         chan.opt_anchors()
 450                 }
 451         }
 452 }
 453
 454 /// Returns a channel monitor given a channel id, making some naive assumptions
 455 #[macro_export]
 456 macro_rules! get_monitor {
 457         ($node: expr, $channel_id: expr) => {
 458                 {
 459                         use bitcoin::hashes::Hash;
 460                         let mut monitor = None;
 461                         // Assume funding vout is either 0 or 1 blindly
 462                         for index in 0..2 {
 463                                 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
 464                                         $crate::chain::transaction::OutPoint {
 465                                                 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
 466                                         })
 467                                 {
 468                                         monitor = Some(mon);
 469                                         break;
 470                                 }
 471                         }
 472                         monitor.unwrap()
 473                 }
 474         }
 475 }
 476
 477 /// Returns any local commitment transactions for the channel.
 478 #[macro_export]
 479 macro_rules! get_local_commitment_txn {
 480         ($node: expr, $channel_id: expr) => {
 481                 {
 482                         $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
 483                 }
 484         }
 485 }
 486
 487 /// Check the error from attempting a payment.
 488 #[macro_export]
 489 macro_rules! unwrap_send_err {
 490         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
 491                 match &$res {
 492                         &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
 493                                 assert_eq!(fails.len(), 1);
 494                                 match fails[0] {
 495                                         $type => { $check },
 496                                         _ => panic!(),
 497                                 }
 498                         },
 499                         &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
 500                                 assert_eq!(results.len(), 1);
 501                                 match results[0] {
 502                                         Err($type) => { $check },
 503                                         _ => panic!(),
 504                                 }
 505                         },
 506                         _ => panic!(),
 507                 }
 508         }
 509 }
 510
 511 /// Check whether N channel monitor(s) have been added.
 512 #[macro_export]
 513 macro_rules! check_added_monitors {
 514         ($node: expr, $count: expr) => {
 515                 {
 516                         let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
 517                         assert_eq!(added_monitors.len(), $count);
 518                         added_monitors.clear();
 519                 }
 520         }
 521 }
 522
 523 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) {
 524         let chan_id = *node.network_chan_count.borrow();
 525
 526         let events = node.node.get_and_clear_pending_events();
 527         assert_eq!(events.len(), 1);
 528         match events[0] {
 529                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 530                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 531                         assert_eq!(user_channel_id, expected_user_chan_id);
 532
 533                         let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 534                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 535                         }]};
 536                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
 537                         (*temporary_channel_id, tx, funding_outpoint)
 538                 },
 539                 _ => panic!("Unexpected event"),
 540         }
 541 }
 542 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
 543         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
 544         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
 545
 546         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_ok());
 547         check_added_monitors!(node_a, 0);
 548
 549         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
 550         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
 551         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
 552         {
 553                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
 554                 assert_eq!(added_monitors.len(), 1);
 555                 assert_eq!(added_monitors[0].0, funding_output);
 556                 added_monitors.clear();
 557         }
 558
 559         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()));
 560         {
 561                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
 562                 assert_eq!(added_monitors.len(), 1);
 563                 assert_eq!(added_monitors[0].0, funding_output);
 564                 added_monitors.clear();
 565         }
 566
 567         let events_4 = node_a.node.get_and_clear_pending_events();
 568         assert_eq!(events_4.len(), 0);
 569
 570         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 571         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
 572         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 573
 574         // Ensure that funding_transaction_generated is idempotent.
 575         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).is_err());
 576         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
 577         check_added_monitors!(node_a, 0);
 578
 579         tx
 580 }
 581
 582 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 {
 583         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 584         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
 585         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
 586         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
 587         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
 588         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
 589         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
 590
 591         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
 592 }
 593
 594 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) {
 595         confirm_transaction_at(node_conf, tx, conf_height);
 596         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
 597         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()));
 598 }
 599
 600 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]) {
 601         let channel_id;
 602         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 603         assert_eq!(events_6.len(), 2);
 604         ((match events_6[0] {
 605                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 606                         channel_id = msg.channel_id.clone();
 607                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 608                         msg.clone()
 609                 },
 610                 _ => panic!("Unexpected event"),
 611         }, match events_6[1] {
 612                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 613                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 614                         msg.clone()
 615                 },
 616                 _ => panic!("Unexpected event"),
 617         }), channel_id)
 618 }
 619
 620 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]) {
 621         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
 622         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
 623         confirm_transaction_at(node_a, tx, conf_height);
 624         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
 625         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 626 }
 627
 628 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) {
 629         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 630         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 631         (msgs, chan_id, tx)
 632 }
 633
 634 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) {
 635         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 636         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 637         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 638
 639         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 640         assert_eq!(events_7.len(), 1);
 641         let (announcement, bs_update) = match events_7[0] {
 642                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 643                         (msg, update_msg)
 644                 },
 645                 _ => panic!("Unexpected event"),
 646         };
 647
 648         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 649         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 650         assert_eq!(events_8.len(), 1);
 651         let as_update = match events_8[0] {
 652                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 653                         assert!(*announcement == *msg);
 654                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 655                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 656                         update_msg
 657                 },
 658                 _ => panic!("Unexpected event"),
 659         };
 660
 661         *node_a.network_chan_count.borrow_mut() += 1;
 662
 663         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 664 }
 665
 666 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) {
 667         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 668 }
 669
 670 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) {
 671         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 672         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
 673         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 674 }
 675
 676 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) {
 677         nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
 678         let a_events = nodes[a].node.get_and_clear_pending_msg_events();
 679         assert!(a_events.len() >= 2);
 680
 681         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 682         let mut found_ann_1 = false;
 683         for event in a_events.iter() {
 684                 match event {
 685                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 686                                 if msg == ann { found_ann_1 = true; }
 687                         },
 688                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 689                         _ => panic!("Unexpected event {:?}", event),
 690                 }
 691         }
 692         assert!(found_ann_1);
 693
 694         let a_node_announcement = match a_events.last().unwrap() {
 695                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 696                         (*msg).clone()
 697                 },
 698                 _ => panic!("Unexpected event"),
 699         };
 700
 701         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
 702         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
 703         assert!(b_events.len() >= 2);
 704
 705         // ann should be re-generated by broadcast_node_announcement - check that we have it.
 706         let mut found_ann_2 = false;
 707         for event in b_events.iter() {
 708                 match event {
 709                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
 710                                 if msg == ann { found_ann_2 = true; }
 711                         },
 712                         MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
 713                         _ => panic!("Unexpected event"),
 714                 }
 715         }
 716         assert!(found_ann_2);
 717
 718         let b_node_announcement = match b_events.last().unwrap() {
 719                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 720                         (*msg).clone()
 721                 },
 722                 _ => panic!("Unexpected event"),
 723         };
 724
 725         for node in nodes {
 726                 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
 727                 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
 728                 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
 729                 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
 730                 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
 731         }
 732 }
 733
 734 #[macro_export]
 735 macro_rules! check_spends {
 736         ($tx: expr, $($spends_txn: expr),*) => {
 737                 {
 738                         $(
 739                         for outp in $spends_txn.output.iter() {
 740                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
 741                         }
 742                         )*
 743                         for outp in $tx.output.iter() {
 744                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
 745                         }
 746                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 747                                 $(
 748                                         if out_point.txid == $spends_txn.txid() {
 749                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 750                                         }
 751                                 )*
 752                                 None
 753                         };
 754                         let mut total_value_in = 0;
 755                         for input in $tx.input.iter() {
 756                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 757                         }
 758                         let mut total_value_out = 0;
 759                         for output in $tx.output.iter() {
 760                                 total_value_out += output.value;
 761                         }
 762                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 763                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 764                         assert!(total_value_out + min_fee <= total_value_in);
 765                         $tx.verify(get_output).unwrap();
 766                 }
 767         }
 768 }
 769
 770 macro_rules! get_closing_signed_broadcast {
 771         ($node: expr, $dest_pubkey: expr) => {
 772                 {
 773                         let events = $node.get_and_clear_pending_msg_events();
 774                         assert!(events.len() == 1 || events.len() == 2);
 775                         (match events[events.len() - 1] {
 776                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 777                                         assert_eq!(msg.contents.flags & 2, 2);
 778                                         msg.clone()
 779                                 },
 780                                 _ => panic!("Unexpected event"),
 781                         }, if events.len() == 2 {
 782                                 match events[0] {
 783                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 784                                                 assert_eq!(*node_id, $dest_pubkey);
 785                                                 Some(msg.clone())
 786                                         },
 787                                         _ => panic!("Unexpected event"),
 788                                 }
 789                         } else { None })
 790                 }
 791         }
 792 }
 793
 794 #[cfg(test)]
 795 macro_rules! check_warn_msg {
 796         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
 797                 let msg_events = $node.node.get_and_clear_pending_msg_events();
 798                 assert_eq!(msg_events.len(), 1);
 799                 match msg_events[0] {
 800                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
 801                                 assert_eq!(node_id, $recipient_node_id);
 802                                 assert_eq!(msg.channel_id, $chan_id);
 803                                 msg.data.clone()
 804                         },
 805                         _ => panic!("Unexpected event"),
 806                 }
 807         }}
 808 }
 809
 810 /// Check that a channel's closing channel update has been broadcasted, and optionally
 811 /// check whether an error message event has occurred.
 812 #[macro_export]
 813 macro_rules! check_closed_broadcast {
 814         ($node: expr, $with_error_msg: expr) => {{
 815                 use $crate::util::events::MessageSendEvent;
 816                 use $crate::ln::msgs::ErrorAction;
 817
 818                 let msg_events = $node.node.get_and_clear_pending_msg_events();
 819                 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
 820                 match msg_events[0] {
 821                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 822                                 assert_eq!(msg.contents.flags & 2, 2);
 823                         },
 824                         _ => panic!("Unexpected event"),
 825                 }
 826                 if $with_error_msg {
 827                         match msg_events[1] {
 828                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 829                                         // TODO: Check node_id
 830                                         Some(msg.clone())
 831                                 },
 832                                 _ => panic!("Unexpected event"),
 833                         }
 834                 } else { None }
 835         }}
 836 }
 837
 838 /// Check that a channel's closing channel events has been issued
 839 #[macro_export]
 840 macro_rules! check_closed_event {
 841         ($node: expr, $events: expr, $reason: expr) => {
 842                 check_closed_event!($node, $events, $reason, false);
 843         };
 844         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
 845                 use $crate::util::events::Event;
 846
 847                 let events = $node.node.get_and_clear_pending_events();
 848                 assert_eq!(events.len(), $events);
 849                 let expected_reason = $reason;
 850                 let mut issues_discard_funding = false;
 851                 for event in events {
 852                         match event {
 853                                 Event::ChannelClosed { ref reason, .. } => {
 854                                         assert_eq!(*reason, expected_reason);
 855                                 },
 856                                 Event::DiscardFunding { .. } => {
 857                                         issues_discard_funding = true;
 858                                 }
 859                                 _ => panic!("Unexpected event"),
 860                         }
 861                 }
 862                 assert_eq!($is_check_discard_funding, issues_discard_funding);
 863         }}
 864 }
 865
 866 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) {
 867         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) };
 868         let (node_b, broadcaster_b, struct_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) } else { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) };
 869         let (tx_a, tx_b);
 870
 871         node_a.close_channel(channel_id).unwrap();
 872         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()));
 873
 874         let events_1 = node_b.get_and_clear_pending_msg_events();
 875         assert!(events_1.len() >= 1);
 876         let shutdown_b = match events_1[0] {
 877                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 878                         assert_eq!(node_id, &node_a.get_our_node_id());
 879                         msg.clone()
 880                 },
 881                 _ => panic!("Unexpected event"),
 882         };
 883
 884         let closing_signed_b = if !close_inbound_first {
 885                 assert_eq!(events_1.len(), 1);
 886                 None
 887         } else {
 888                 Some(match events_1[1] {
 889                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 890                                 assert_eq!(node_id, &node_a.get_our_node_id());
 891                                 msg.clone()
 892                         },
 893                         _ => panic!("Unexpected event"),
 894                 })
 895         };
 896
 897         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 898         let (as_update, bs_update) = if close_inbound_first {
 899                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 900                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 901
 902                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
 903                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 904                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 905                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 906
 907                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 908                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 909                 assert!(none_a.is_none());
 910                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 911                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 912                 (as_update, bs_update)
 913         } else {
 914                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 915
 916                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 917                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
 918
 919                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 920                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 921                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 922
 923                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 924                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 925                 assert!(none_b.is_none());
 926                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 927                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 928                 (as_update, bs_update)
 929         };
 930         assert_eq!(tx_a, tx_b);
 931         check_spends!(tx_a, funding_tx);
 932
 933         (as_update, bs_update, tx_a)
 934 }
 935
 936 pub struct SendEvent {
 937         pub node_id: PublicKey,
 938         pub msgs: Vec<msgs::UpdateAddHTLC>,
 939         pub commitment_msg: msgs::CommitmentSigned,
 940 }
 941 impl SendEvent {
 942         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 943                 assert!(updates.update_fulfill_htlcs.is_empty());
 944                 assert!(updates.update_fail_htlcs.is_empty());
 945                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 946                 assert!(updates.update_fee.is_none());
 947                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 948         }
 949
 950         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 951                 match event {
 952                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 953                         _ => panic!("Unexpected event type!"),
 954                 }
 955         }
 956
 957         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 958                 let mut events = node.node.get_and_clear_pending_msg_events();
 959                 assert_eq!(events.len(), 1);
 960                 SendEvent::from_event(events.pop().unwrap())
 961         }
 962 }
 963
 964 #[macro_export]
 965 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
 966 /// commitment update.
 967 macro_rules! commitment_signed_dance {
 968         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 969                 {
 970                         check_added_monitors!($node_a, 0);
 971                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 972                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 973                         check_added_monitors!($node_a, 1);
 974                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 975                 }
 976         };
 977         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 978                 {
 979                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 980                         check_added_monitors!($node_b, 0);
 981                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 982                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 983                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 984                         check_added_monitors!($node_b, 1);
 985                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 986                         let (bs_revoke_and_ack, extra_msg_option) = {
 987                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 988                                 assert!(events.len() <= 2);
 989                                 (match events[0] {
 990                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 991                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 992                                                 (*msg).clone()
 993                                         },
 994                                         _ => panic!("Unexpected event"),
 995                                 }, events.get(1).map(|e| e.clone()))
 996                         };
 997                         check_added_monitors!($node_b, 1);
 998                         if $fail_backwards {
 999                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1000                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1001                         }
1002                         (extra_msg_option, bs_revoke_and_ack)
1003                 }
1004         };
1005         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1006                 {
1007                         check_added_monitors!($node_a, 0);
1008                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1009                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1010                         check_added_monitors!($node_a, 1);
1011                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1012                         assert!(extra_msg_option.is_none());
1013                         bs_revoke_and_ack
1014                 }
1015         };
1016         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1017                 {
1018                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1019                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1020                         check_added_monitors!($node_a, 1);
1021                         extra_msg_option
1022                 }
1023         };
1024         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1025                 {
1026                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1027                 }
1028         };
1029         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1030                 {
1031                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1032                         if $fail_backwards {
1033                                 $crate::expect_pending_htlcs_forwardable!($node_a);
1034                                 check_added_monitors!($node_a, 1);
1035
1036                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
1037                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
1038                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1039                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
1040                                 } else { panic!("Unexpected event"); }
1041                         } else {
1042                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1043                         }
1044                 }
1045         }
1046 }
1047
1048 /// Get a payment preimage and hash.
1049 #[macro_export]
1050 macro_rules! get_payment_preimage_hash {
1051         ($dest_node: expr) => {
1052                 {
1053                         get_payment_preimage_hash!($dest_node, None)
1054                 }
1055         };
1056         ($dest_node: expr, $min_value_msat: expr) => {
1057                 {
1058                         use bitcoin::hashes::Hash as _;
1059                         let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1060                         let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1061                         *payment_count += 1;
1062                         let payment_hash = $crate::ln::PaymentHash(
1063                                 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1064                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1065                         (payment_preimage, payment_hash, payment_secret)
1066                 }
1067         }
1068 }
1069
1070 #[cfg(test)]
1071 #[macro_export]
1072 macro_rules! get_route_and_payment_hash {
1073         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1074                 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1075         }};
1076         ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1077                 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1078                 let payee = $crate::routing::router::Payee::from_node_id($recv_node.node.get_our_node_id())
1079                         .with_features($crate::ln::features::InvoiceFeatures::known())
1080                         .with_route_hints($last_hops);
1081                 let scorer = $crate::util::test_utils::TestScorer::with_fixed_penalty(0);
1082                 let route = $crate::routing::router::get_route(
1083                         &$send_node.node.get_our_node_id(), &payee, $send_node.network_graph,
1084                         Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1085                         $recv_value, $cltv, $send_node.logger, &scorer
1086                 ).unwrap();
1087                 (route, payment_hash, payment_preimage, payment_secret)
1088         }}
1089 }
1090
1091 #[macro_export]
1092 /// Clears (and ignores) a PendingHTLCsForwardable event
1093 macro_rules! expect_pending_htlcs_forwardable_ignore {
1094         ($node: expr) => {{
1095                 let events = $node.node.get_and_clear_pending_events();
1096                 assert_eq!(events.len(), 1);
1097                 match events[0] {
1098                         Event::PendingHTLCsForwardable { .. } => { },
1099                         _ => panic!("Unexpected event"),
1100                 };
1101         }}
1102 }
1103
1104 #[macro_export]
1105 /// Handles a PendingHTLCsForwardable event
1106 macro_rules! expect_pending_htlcs_forwardable {
1107         ($node: expr) => {{
1108                 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1109                 $node.node.process_pending_htlc_forwards();
1110
1111                 // Ensure process_pending_htlc_forwards is idempotent.
1112                 $node.node.process_pending_htlc_forwards();
1113         }}
1114 }
1115
1116 #[cfg(test)]
1117 macro_rules! expect_pending_htlcs_forwardable_from_events {
1118         ($node: expr, $events: expr, $ignore: expr) => {{
1119                 assert_eq!($events.len(), 1);
1120                 match $events[0] {
1121                         Event::PendingHTLCsForwardable { .. } => { },
1122                         _ => panic!("Unexpected event"),
1123                 };
1124                 if $ignore {
1125                         $node.node.process_pending_htlc_forwards();
1126
1127                         // Ensure process_pending_htlc_forwards is idempotent.
1128                         $node.node.process_pending_htlc_forwards();
1129                 }
1130         }}
1131 }
1132
1133 #[cfg(any(test, feature = "unstable"))]
1134 macro_rules! expect_payment_received {
1135         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1136                 let events = $node.node.get_and_clear_pending_events();
1137                 assert_eq!(events.len(), 1);
1138                 match events[0] {
1139                         Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1140                                 assert_eq!($expected_payment_hash, *payment_hash);
1141                                 assert_eq!($expected_recv_value, amt);
1142                                 match purpose {
1143                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1144                                                 assert!(payment_preimage.is_none());
1145                                                 assert_eq!($expected_payment_secret, *payment_secret);
1146                                         },
1147                                         _ => {},
1148                                 }
1149                         },
1150                         _ => panic!("Unexpected event"),
1151                 }
1152         }
1153 }
1154
1155 #[cfg(test)]
1156 #[macro_export]
1157 macro_rules! expect_payment_sent_without_paths {
1158         ($node: expr, $expected_payment_preimage: expr) => {
1159                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1160         };
1161         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1162                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1163         }
1164 }
1165
1166 #[macro_export]
1167 macro_rules! expect_payment_sent {
1168         ($node: expr, $expected_payment_preimage: expr) => {
1169                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1170         };
1171         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1172                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1173         };
1174         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1175                 use bitcoin::hashes::Hash as _;
1176                 let events = $node.node.get_and_clear_pending_events();
1177                 let expected_payment_hash = $crate::ln::PaymentHash(
1178                         bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1179                 if $expect_paths {
1180                         assert!(events.len() > 1);
1181                 } else {
1182                         assert_eq!(events.len(), 1);
1183                 }
1184                 let expected_payment_id = match events[0] {
1185                         $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1186                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1187                                 assert_eq!(expected_payment_hash, *payment_hash);
1188                                 assert!(fee_paid_msat.is_some());
1189                                 if $expected_fee_msat_opt.is_some() {
1190                                         assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1191                                 }
1192                                 payment_id.unwrap()
1193                         },
1194                         _ => panic!("Unexpected event"),
1195                 };
1196                 if $expect_paths {
1197                         for i in 1..events.len() {
1198                                 match events[i] {
1199                                         $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1200                                                 assert_eq!(payment_id, expected_payment_id);
1201                                                 assert_eq!(payment_hash, Some(expected_payment_hash));
1202                                         },
1203                                         _ => panic!("Unexpected event"),
1204                                 }
1205                         }
1206                 }
1207         } }
1208 }
1209
1210 #[cfg(test)]
1211 #[macro_export]
1212 macro_rules! expect_payment_path_successful {
1213         ($node: expr) => {
1214                 let events = $node.node.get_and_clear_pending_events();
1215                 assert_eq!(events.len(), 1);
1216                 match events[0] {
1217                         $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1218                         _ => panic!("Unexpected event"),
1219                 }
1220         }
1221 }
1222
1223 macro_rules! expect_payment_forwarded {
1224         ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1225                 let events = $node.node.get_and_clear_pending_events();
1226                 assert_eq!(events.len(), 1);
1227                 match events[0] {
1228                         Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1229                                 assert_eq!(fee_earned_msat, $expected_fee);
1230                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1231                         },
1232                         _ => panic!("Unexpected event"),
1233                 }
1234         }
1235 }
1236
1237 pub struct PaymentFailedConditions<'a> {
1238         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1239         pub(crate) expected_blamed_scid: Option<u64>,
1240         pub(crate) expected_blamed_chan_closed: Option<bool>,
1241         pub(crate) expected_mpp_parts_remain: bool,
1242 }
1243
1244 impl<'a> PaymentFailedConditions<'a> {
1245         pub fn new() -> Self {
1246                 Self {
1247                         expected_htlc_error_data: None,
1248                         expected_blamed_scid: None,
1249                         expected_blamed_chan_closed: None,
1250                         expected_mpp_parts_remain: false,
1251                 }
1252         }
1253         pub fn mpp_parts_remain(mut self) -> Self {
1254                 self.expected_mpp_parts_remain = true;
1255                 self
1256         }
1257         pub fn blamed_scid(mut self, scid: u64) -> Self {
1258                 self.expected_blamed_scid = Some(scid);
1259                 self
1260         }
1261         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1262                 self.expected_blamed_chan_closed = Some(closed);
1263                 self
1264         }
1265         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1266                 self.expected_htlc_error_data = Some((code, data));
1267                 self
1268         }
1269 }
1270
1271 #[cfg(test)]
1272 macro_rules! expect_payment_failed_with_update {
1273         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1274                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1275                         $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1276         }
1277 }
1278
1279 #[cfg(test)]
1280 macro_rules! expect_payment_failed {
1281         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1282                 #[allow(unused_mut)]
1283                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1284                 $(
1285                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1286                 )*
1287                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1288         };
1289 }
1290
1291 #[cfg(test)]
1292 macro_rules! expect_payment_failed_conditions {
1293         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1294                 let events = $node.node.get_and_clear_pending_events();
1295                 assert_eq!(events.len(), 1);
1296                 let expected_payment_id = match events[0] {
1297                         Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1298                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1299                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1300                                 assert!(retry.is_some(), "expected retry.is_some()");
1301                                 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1302                                 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1303
1304                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1305                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1306                                 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1307                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
1308                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1309                                 }
1310
1311                                 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1312                                         match network_update {
1313                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1314                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1315                                                                 assert_eq!(msg.contents.short_channel_id, scid);
1316                                                         }
1317                                                         assert_eq!(msg.contents.flags & 2, 0);
1318                                                 },
1319                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1320                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1321                                                                 assert_eq!(short_channel_id, scid);
1322                                                         }
1323                                                         assert!(is_permanent);
1324                                                 },
1325                                                 Some(_) => panic!("Unexpected update type"),
1326                                                 None => panic!("Expected update"),
1327                                         }
1328                                 }
1329
1330                                 payment_id.unwrap()
1331                         },
1332                         _ => panic!("Unexpected event"),
1333                 };
1334                 if !$conditions.expected_mpp_parts_remain {
1335                         $node.node.abandon_payment(expected_payment_id);
1336                         let events = $node.node.get_and_clear_pending_events();
1337                         assert_eq!(events.len(), 1);
1338                         match events[0] {
1339                                 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1340                                         assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1341                                         assert_eq!(*payment_id, expected_payment_id);
1342                                 }
1343                                 _ => panic!("Unexpected second event"),
1344                         }
1345                 }
1346         }
1347 }
1348
1349 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) -> PaymentId {
1350         let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1351         check_added_monitors!(origin_node, expected_paths.len());
1352         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1353         payment_id
1354 }
1355
1356 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: Option<PaymentSecret>, ev: MessageSendEvent, payment_received_expected: bool, expected_preimage: Option<PaymentPreimage>) {
1357         let mut payment_event = SendEvent::from_event(ev);
1358         let mut prev_node = origin_node;
1359
1360         for (idx, &node) in expected_path.iter().enumerate() {
1361                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1362
1363                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1364                 check_added_monitors!(node, 0);
1365                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1366
1367                 expect_pending_htlcs_forwardable!(node);
1368
1369                 if idx == expected_path.len() - 1 {
1370                         let events_2 = node.node.get_and_clear_pending_events();
1371                         if payment_received_expected {
1372                                 assert_eq!(events_2.len(), 1);
1373                                 match events_2[0] {
1374                                         Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1375                                                 assert_eq!(our_payment_hash, *payment_hash);
1376                                                 match &purpose {
1377                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1378                                                                 assert_eq!(expected_preimage, *payment_preimage);
1379                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1380                                                         },
1381                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1382                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1383                                                                 assert!(our_payment_secret.is_none());
1384                                                         },
1385                                                 }
1386                                                 assert_eq!(amt, recv_value);
1387                                         },
1388                                         _ => panic!("Unexpected event"),
1389                                 }
1390                         } else {
1391                                 assert!(events_2.is_empty());
1392                         }
1393                 } else {
1394                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1395                         assert_eq!(events_2.len(), 1);
1396                         check_added_monitors!(node, 1);
1397                         payment_event = SendEvent::from_event(events_2.remove(0));
1398                         assert_eq!(payment_event.msgs.len(), 1);
1399                 }
1400
1401                 prev_node = node;
1402         }
1403 }
1404
1405 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) {
1406         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1407         assert_eq!(events.len(), expected_route.len());
1408         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1409                 // Once we've gotten through all the HTLCs, the last one should result in a
1410                 // PaymentReceived (but each previous one should not!), .
1411                 let expect_payment = path_idx == expected_route.len() - 1;
1412                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1413         }
1414 }
1415
1416 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, PaymentId) {
1417         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1418         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1419         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1420 }
1421
1422 pub fn do_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) -> u64 {
1423         for path in expected_paths.iter() {
1424                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1425         }
1426         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1427         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1428
1429         let mut expected_total_fee_msat = 0;
1430
1431         macro_rules! msgs_from_ev {
1432                 ($ev: expr) => {
1433                         match $ev {
1434                                 &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 } } => {
1435                                         assert!(update_add_htlcs.is_empty());
1436                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1437                                         assert!(update_fail_htlcs.is_empty());
1438                                         assert!(update_fail_malformed_htlcs.is_empty());
1439                                         assert!(update_fee.is_none());
1440                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1441                                 },
1442                                 _ => panic!("Unexpected event"),
1443                         }
1444                 }
1445         }
1446         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1447         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1448         assert_eq!(events.len(), expected_paths.len());
1449         for ev in events.iter() {
1450                 per_path_msgs.push(msgs_from_ev!(ev));
1451         }
1452
1453         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1454                 let mut next_msgs = Some(path_msgs);
1455                 let mut expected_next_node = next_hop;
1456
1457                 macro_rules! last_update_fulfill_dance {
1458                         ($node: expr, $prev_node: expr) => {
1459                                 {
1460                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1461                                         check_added_monitors!($node, 0);
1462                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1463                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1464                                 }
1465                         }
1466                 }
1467                 macro_rules! mid_update_fulfill_dance {
1468                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1469                                 {
1470                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1471                                         let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1472                                         expect_payment_forwarded!($node, Some(fee as u64), false);
1473                                         expected_total_fee_msat += fee as u64;
1474                                         check_added_monitors!($node, 1);
1475                                         let new_next_msgs = if $new_msgs {
1476                                                 let events = $node.node.get_and_clear_pending_msg_events();
1477                                                 assert_eq!(events.len(), 1);
1478                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1479                                                 expected_next_node = nexthop;
1480                                                 Some(res)
1481                                         } else {
1482                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1483                                                 None
1484                                         };
1485                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1486                                         next_msgs = new_next_msgs;
1487                                 }
1488                         }
1489                 }
1490
1491                 let mut prev_node = expected_route.last().unwrap();
1492                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1493                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1494                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1495                         if next_msgs.is_some() {
1496                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1497                         } else {
1498                                 assert!(!update_next_msgs);
1499                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1500                         }
1501                         if !skip_last && idx == expected_route.len() - 1 {
1502                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1503                         }
1504
1505                         prev_node = node;
1506                 }
1507
1508                 if !skip_last {
1509                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1510                 }
1511         }
1512
1513         // Ensure that claim_funds is idempotent.
1514         assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1515         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1516         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1517
1518         expected_total_fee_msat
1519 }
1520 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) {
1521         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1522         if !skip_last {
1523                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1524         }
1525 }
1526
1527 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1528         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1529 }
1530
1531 pub const TEST_FINAL_CLTV: u32 = 70;
1532
1533 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) {
1534         let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1535                 .with_features(InvoiceFeatures::known());
1536         let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1537         let route = get_route(
1538                 &origin_node.node.get_our_node_id(), &payee, &origin_node.network_graph,
1539                 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1540                 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1541         assert_eq!(route.paths.len(), 1);
1542         assert_eq!(route.paths[0].len(), expected_route.len());
1543         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1544                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1545         }
1546
1547         let res = send_along_route(origin_node, route, expected_route, recv_value);
1548         (res.0, res.1, res.2)
1549 }
1550
1551 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1552         let payee = Payee::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1553                 .with_features(InvoiceFeatures::known());
1554         let scorer = test_utils::TestScorer::with_fixed_penalty(0);
1555         let route = get_route(&origin_node.node.get_our_node_id(), &payee, origin_node.network_graph, None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1556         assert_eq!(route.paths.len(), 1);
1557         assert_eq!(route.paths[0].len(), expected_route.len());
1558         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1559                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1560         }
1561
1562         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1563         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1564                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1565 }
1566
1567 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1568         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1569         claim_payment(&origin, expected_route, our_payment_preimage);
1570 }
1571
1572 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash)  {
1573         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1574         for path in expected_paths.iter() {
1575                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1576         }
1577         assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1578         expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1579         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1580
1581         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1582         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1583         assert_eq!(events.len(), expected_paths.len());
1584         for ev in events.iter() {
1585                 let (update_fail, commitment_signed, node_id) = match ev {
1586                         &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 } } => {
1587                                 assert!(update_add_htlcs.is_empty());
1588                                 assert!(update_fulfill_htlcs.is_empty());
1589                                 assert_eq!(update_fail_htlcs.len(), 1);
1590                                 assert!(update_fail_malformed_htlcs.is_empty());
1591                                 assert!(update_fee.is_none());
1592                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1593                         },
1594                         _ => panic!("Unexpected event"),
1595                 };
1596                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1597         }
1598         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1599         expected_paths.sort_unstable_by(|path_a, path_b| path_a[path_a.len() - 2].node.get_our_node_id().cmp(&path_b[path_b.len() - 2].node.get_our_node_id()));
1600
1601         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1602                 let mut next_msgs = Some(path_msgs);
1603                 let mut expected_next_node = next_hop;
1604                 let mut prev_node = expected_route.last().unwrap();
1605
1606                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1607                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1608                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
1609                         if next_msgs.is_some() {
1610                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1611                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1612                                 if !update_next_node {
1613                                         expect_pending_htlcs_forwardable!(node);
1614                                 }
1615                         }
1616                         let events = node.node.get_and_clear_pending_msg_events();
1617                         if update_next_node {
1618                                 assert_eq!(events.len(), 1);
1619                                 match events[0] {
1620                                         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 } } => {
1621                                                 assert!(update_add_htlcs.is_empty());
1622                                                 assert!(update_fulfill_htlcs.is_empty());
1623                                                 assert_eq!(update_fail_htlcs.len(), 1);
1624                                                 assert!(update_fail_malformed_htlcs.is_empty());
1625                                                 assert!(update_fee.is_none());
1626                                                 expected_next_node = node_id.clone();
1627                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1628                                         },
1629                                         _ => panic!("Unexpected event"),
1630                                 }
1631                         } else {
1632                                 assert!(events.is_empty());
1633                         }
1634                         if !skip_last && idx == expected_route.len() - 1 {
1635                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1636                         }
1637
1638                         prev_node = node;
1639                 }
1640
1641                 if !skip_last {
1642                         let prev_node = expected_route.first().unwrap();
1643                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1644                         check_added_monitors!(origin_node, 0);
1645                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1646                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1647                         let events = origin_node.node.get_and_clear_pending_events();
1648                         assert_eq!(events.len(), 1);
1649                         let expected_payment_id = match events[0] {
1650                                 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1651                                         assert_eq!(payment_hash, our_payment_hash);
1652                                         assert!(rejected_by_dest);
1653                                         assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1654                                         for (idx, hop) in expected_route.iter().enumerate() {
1655                                                 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1656                                         }
1657                                         payment_id.unwrap()
1658                                 },
1659                                 _ => panic!("Unexpected event"),
1660                         };
1661                         if i == expected_paths.len() - 1 {
1662                                 origin_node.node.abandon_payment(expected_payment_id);
1663                                 let events = origin_node.node.get_and_clear_pending_events();
1664                                 assert_eq!(events.len(), 1);
1665                                 match events[0] {
1666                                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1667                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1668                                                 assert_eq!(*payment_id, expected_payment_id);
1669                                         }
1670                                         _ => panic!("Unexpected second event"),
1671                                 }
1672                         }
1673                 }
1674         }
1675
1676         // Ensure that fail_htlc_backwards is idempotent.
1677         assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1678         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1679         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1680         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1681 }
1682
1683 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1684         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1685 }
1686
1687 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1688         let mut chan_mon_cfgs = Vec::new();
1689         for i in 0..node_count {
1690                 let tx_broadcaster = test_utils::TestBroadcaster {
1691                         txn_broadcasted: Mutex::new(Vec::new()),
1692                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1693                 };
1694                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1695                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1696                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1697                 let persister = test_utils::TestPersister::new();
1698                 let seed = [i as u8; 32];
1699                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1700                 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1701
1702                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1703         }
1704
1705         chan_mon_cfgs
1706 }
1707
1708 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1709         let mut nodes = Vec::new();
1710
1711         for i in 0..node_count {
1712                 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);
1713                 let seed = [i as u8; 32];
1714                 nodes.push(NodeCfg {
1715                         chain_source: &chanmon_cfgs[i].chain_source,
1716                         logger: &chanmon_cfgs[i].logger,
1717                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1718                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
1719                         chain_monitor,
1720                         keys_manager: &chanmon_cfgs[i].keys_manager,
1721                         node_seed: seed,
1722                         features: InitFeatures::known(),
1723                         network_graph: &chanmon_cfgs[i].network_graph,
1724                 });
1725         }
1726
1727         nodes
1728 }
1729
1730 pub fn test_default_channel_config() -> UserConfig {
1731         let mut default_config = UserConfig::default();
1732         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1733         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1734         default_config.channel_options.cltv_expiry_delta = 6*6;
1735         default_config.channel_options.announced_channel = true;
1736         default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1737         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1738         // It now defaults to 1, so we simply set it to the expected value here.
1739         default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1740         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1741         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1742         default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1743         default_config
1744 }
1745
1746 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>> {
1747         let mut chanmgrs = Vec::new();
1748         for i in 0..node_count {
1749                 let network = Network::Testnet;
1750                 let params = ChainParameters {
1751                         network,
1752                         best_block: BestBlock::from_genesis(network),
1753                 };
1754                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1755                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1756                 chanmgrs.push(node);
1757         }
1758
1759         chanmgrs
1760 }
1761
1762 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>> {
1763         let mut nodes = Vec::new();
1764         let chan_count = Rc::new(RefCell::new(0));
1765         let payment_count = Rc::new(RefCell::new(0));
1766         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1767
1768         for i in 0..node_count {
1769                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1770                 nodes.push(Node{
1771                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1772                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1773                         node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1774                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1775                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1776                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1777                         connect_style: Rc::clone(&connect_style),
1778                 })
1779         }
1780
1781         for i in 0..node_count {
1782                 for j in (i+1)..node_count {
1783                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1784                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1785                 }
1786         }
1787
1788         nodes
1789 }
1790
1791 // Note that the following only works for CLTV values up to 128
1792 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1793 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1794
1795 #[derive(PartialEq)]
1796 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1797 /// Tests that the given node has broadcast transactions for the given Channel
1798 ///
1799 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1800 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1801 /// broadcast and the revoked outputs were claimed.
1802 ///
1803 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1804 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1805 ///
1806 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1807 /// also fail.
1808 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>  {
1809         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1810         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1811
1812         let mut res = Vec::with_capacity(2);
1813         node_txn.retain(|tx| {
1814                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1815                         check_spends!(tx, chan.3);
1816                         if commitment_tx.is_none() {
1817                                 res.push(tx.clone());
1818                         }
1819                         false
1820                 } else { true }
1821         });
1822         if let Some(explicit_tx) = commitment_tx {
1823                 res.push(explicit_tx.clone());
1824         }
1825
1826         assert_eq!(res.len(), 1);
1827
1828         if has_htlc_tx != HTLCType::NONE {
1829                 node_txn.retain(|tx| {
1830                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1831                                 check_spends!(tx, res[0]);
1832                                 if has_htlc_tx == HTLCType::TIMEOUT {
1833                                         assert!(tx.lock_time != 0);
1834                                 } else {
1835                                         assert!(tx.lock_time == 0);
1836                                 }
1837                                 res.push(tx.clone());
1838                                 false
1839                         } else { true }
1840                 });
1841                 assert!(res.len() == 2 || res.len() == 3);
1842                 if res.len() == 3 {
1843                         assert_eq!(res[1], res[2]);
1844                 }
1845         }
1846
1847         assert!(node_txn.is_empty());
1848         res
1849 }
1850
1851 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1852 /// HTLC transaction.
1853 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1854         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1855         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1856         // for revoked htlc outputs
1857         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1858         node_txn.retain(|tx| {
1859                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1860                         check_spends!(tx, revoked_tx);
1861                         false
1862                 } else { true }
1863         });
1864         node_txn.retain(|tx| {
1865                 check_spends!(tx, commitment_revoked_tx);
1866                 false
1867         });
1868         assert!(node_txn.is_empty());
1869 }
1870
1871 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1872         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1873
1874         assert!(node_txn.len() >= 1);
1875         assert_eq!(node_txn[0].input.len(), 1);
1876         let mut found_prev = false;
1877
1878         for tx in prev_txn {
1879                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1880                         check_spends!(node_txn[0], tx);
1881                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1882                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1883
1884                         found_prev = true;
1885                         break;
1886                 }
1887         }
1888         assert!(found_prev);
1889
1890         let mut res = Vec::new();
1891         mem::swap(&mut *node_txn, &mut res);
1892         res
1893 }
1894
1895 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)  {
1896         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1897         assert_eq!(events_1.len(), 2);
1898         let as_update = match events_1[0] {
1899                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1900                         msg.clone()
1901                 },
1902                 _ => panic!("Unexpected event"),
1903         };
1904         match events_1[1] {
1905                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1906                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
1907                         assert_eq!(msg.data, expected_error);
1908                         if needs_err_handle {
1909                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1910                         }
1911                 },
1912                 _ => panic!("Unexpected event"),
1913         }
1914
1915         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1916         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1917         let bs_update = match events_2[0] {
1918                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1919                         msg.clone()
1920                 },
1921                 _ => panic!("Unexpected event"),
1922         };
1923         if !needs_err_handle {
1924                 match events_2[1] {
1925                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1926                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1927                                 assert_eq!(msg.data, expected_error);
1928                         },
1929                         _ => panic!("Unexpected event"),
1930                 }
1931         }
1932
1933         for node in nodes {
1934                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1935                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1936         }
1937 }
1938
1939 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1940         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1941 }
1942
1943 #[cfg(test)]
1944 macro_rules! get_channel_value_stat {
1945         ($node: expr, $channel_id: expr) => {{
1946                 let chan_lock = $node.node.channel_state.lock().unwrap();
1947                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1948                 chan.get_value_stat()
1949         }}
1950 }
1951
1952 macro_rules! get_chan_reestablish_msgs {
1953         ($src_node: expr, $dst_node: expr) => {
1954                 {
1955                         let mut res = Vec::with_capacity(1);
1956                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1957                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1958                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1959                                         res.push(msg.clone());
1960                                 } else {
1961                                         panic!("Unexpected event")
1962                                 }
1963                         }
1964                         res
1965                 }
1966         }
1967 }
1968
1969 macro_rules! handle_chan_reestablish_msgs {
1970         ($src_node: expr, $dst_node: expr) => {
1971                 {
1972                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1973                         let mut idx = 0;
1974                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1975                                 idx += 1;
1976                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1977                                 Some(msg.clone())
1978                         } else {
1979                                 None
1980                         };
1981
1982                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1983                                 idx += 1;
1984                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1985                         }
1986
1987                         let mut revoke_and_ack = None;
1988                         let mut commitment_update = None;
1989                         let order = if let Some(ev) = msg_events.get(idx) {
1990                                 match ev {
1991                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1992                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1993                                                 revoke_and_ack = Some(msg.clone());
1994                                                 idx += 1;
1995                                                 RAACommitmentOrder::RevokeAndACKFirst
1996                                         },
1997                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1998                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1999                                                 commitment_update = Some(updates.clone());
2000                                                 idx += 1;
2001                                                 RAACommitmentOrder::CommitmentFirst
2002                                         },
2003                                         &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
2004                                         _ => panic!("Unexpected event"),
2005                                 }
2006                         } else {
2007                                 RAACommitmentOrder::CommitmentFirst
2008                         };
2009
2010                         if let Some(ev) = msg_events.get(idx) {
2011                                 match ev {
2012                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2013                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2014                                                 assert!(revoke_and_ack.is_none());
2015                                                 revoke_and_ack = Some(msg.clone());
2016                                                 idx += 1;
2017                                         },
2018                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2019                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2020                                                 assert!(commitment_update.is_none());
2021                                                 commitment_update = Some(updates.clone());
2022                                                 idx += 1;
2023                                         },
2024                                         &MessageSendEvent::SendChannelUpdate { .. } => {},
2025                                         _ => panic!("Unexpected event"),
2026                                 }
2027                         }
2028
2029                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2030                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2031                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2032                         }
2033
2034                         (funding_locked, revoke_and_ack, commitment_update, order)
2035                 }
2036         }
2037 }
2038
2039 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2040 /// for claims/fails they are separated out.
2041 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_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
2042         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2043         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2044         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2045         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2046
2047         if send_funding_locked.0 {
2048                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2049                 // from b
2050                 for reestablish in reestablish_1.iter() {
2051                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2052                 }
2053         }
2054         if send_funding_locked.1 {
2055                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2056                 // from a
2057                 for reestablish in reestablish_2.iter() {
2058                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2059                 }
2060         }
2061         if send_funding_locked.0 || send_funding_locked.1 {
2062                 // If we expect any funding_locked's, both sides better have set
2063                 // next_holder_commitment_number to 1
2064                 for reestablish in reestablish_1.iter() {
2065                         assert_eq!(reestablish.next_local_commitment_number, 1);
2066                 }
2067                 for reestablish in reestablish_2.iter() {
2068                         assert_eq!(reestablish.next_local_commitment_number, 1);
2069                 }
2070         }
2071
2072         let mut resp_1 = Vec::new();
2073         for msg in reestablish_1 {
2074                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2075                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2076         }
2077         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2078                 check_added_monitors!(node_b, 1);
2079         } else {
2080                 check_added_monitors!(node_b, 0);
2081         }
2082
2083         let mut resp_2 = Vec::new();
2084         for msg in reestablish_2 {
2085                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2086                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2087         }
2088         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2089                 check_added_monitors!(node_a, 1);
2090         } else {
2091                 check_added_monitors!(node_a, 0);
2092         }
2093
2094         // We don't yet support both needing updates, as that would require a different commitment dance:
2095         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2096                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2097                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2098                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2099
2100         for chan_msgs in resp_1.drain(..) {
2101                 if send_funding_locked.0 {
2102                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2103                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2104                         if !announcement_event.is_empty() {
2105                                 assert_eq!(announcement_event.len(), 1);
2106                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2107                                         //TODO: Test announcement_sigs re-sending
2108                                 } else { panic!("Unexpected event!"); }
2109                         }
2110                 } else {
2111                         assert!(chan_msgs.0.is_none());
2112                 }
2113                 if pending_raa.0 {
2114                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2115                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2116                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2117                         check_added_monitors!(node_a, 1);
2118                 } else {
2119                         assert!(chan_msgs.1.is_none());
2120                 }
2121                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2122                         let commitment_update = chan_msgs.2.unwrap();
2123                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2124                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2125                         } else {
2126                                 assert!(commitment_update.update_add_htlcs.is_empty());
2127                         }
2128                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2129                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2130                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2131                         for update_add in commitment_update.update_add_htlcs {
2132                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2133                         }
2134                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2135                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2136                         }
2137                         for update_fail in commitment_update.update_fail_htlcs {
2138                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2139                         }
2140
2141                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2142                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2143                         } else {
2144                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2145                                 check_added_monitors!(node_a, 1);
2146                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2147                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2148                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2149                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2150                                 check_added_monitors!(node_b, 1);
2151                         }
2152                 } else {
2153                         assert!(chan_msgs.2.is_none());
2154                 }
2155         }
2156
2157         for chan_msgs in resp_2.drain(..) {
2158                 if send_funding_locked.1 {
2159                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2160                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2161                         if !announcement_event.is_empty() {
2162                                 assert_eq!(announcement_event.len(), 1);
2163                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
2164                                         //TODO: Test announcement_sigs re-sending
2165                                 } else { panic!("Unexpected event!"); }
2166                         }
2167                 } else {
2168                         assert!(chan_msgs.0.is_none());
2169                 }
2170                 if pending_raa.1 {
2171                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2172                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2173                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2174                         check_added_monitors!(node_b, 1);
2175                 } else {
2176                         assert!(chan_msgs.1.is_none());
2177                 }
2178                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2179                         let commitment_update = chan_msgs.2.unwrap();
2180                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2181                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2182                         }
2183                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2184                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2185                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2186                         for update_add in commitment_update.update_add_htlcs {
2187                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2188                         }
2189                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2190                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2191                         }
2192                         for update_fail in commitment_update.update_fail_htlcs {
2193                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2194                         }
2195
2196                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2197                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2198                         } else {
2199                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2200                                 check_added_monitors!(node_b, 1);
2201                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2202                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2203                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2204                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2205                                 check_added_monitors!(node_a, 1);
2206                         }
2207                 } else {
2208                         assert!(chan_msgs.2.is_none());
2209                 }
2210         }
2211 }