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