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