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