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