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