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