_ 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::{BumpTransactionEvent, 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                 MessageSendEvent::HandleError {
 669                         action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
 670                 } => {
 671                         assert_eq!(node_id, recipient);
 672                         msg.as_ref().unwrap().clone()
 673                 },
 674                 _ => panic!("Unexpected event"),
 675         }
 676 }
 677
 678 /// Get a specific event from the pending events queue.
 679 #[macro_export]
 680 macro_rules! get_event {
 681         ($node: expr, $event_type: path) => {
 682                 {
 683                         let mut events = $node.node.get_and_clear_pending_events();
 684                         assert_eq!(events.len(), 1);
 685                         let ev = events.pop().unwrap();
 686                         match ev {
 687                                 $event_type { .. } => {
 688                                         ev
 689                                 },
 690                                 _ => panic!("Unexpected event"),
 691                         }
 692                 }
 693         }
 694 }
 695
 696 /// Gets an UpdateHTLCs MessageSendEvent
 697 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
 698         let events = node.node.get_and_clear_pending_msg_events();
 699         assert_eq!(events.len(), 1);
 700         match events[0] {
 701                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 702                         assert_eq!(node_id, recipient);
 703                         (*updates).clone()
 704                 },
 705                 _ => panic!("Unexpected event"),
 706         }
 707 }
 708
 709 #[macro_export]
 710 /// Gets an UpdateHTLCs MessageSendEvent
 711 ///
 712 /// Don't use this, use the identically-named function instead.
 713 macro_rules! get_htlc_update_msgs {
 714         ($node: expr, $node_id: expr) => {
 715                 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
 716         }
 717 }
 718
 719 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
 720 /// Returns the `msg_event`.
 721 ///
 722 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
 723 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
 724 /// such messages are intended to all peers.
 725 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
 726         let ev_index = msg_events.iter().position(|e| { match e {
 727                 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
 728                         node_id == msg_node_id
 729                 },
 730                 MessageSendEvent::SendOpenChannel { node_id, .. } => {
 731                         node_id == msg_node_id
 732                 },
 733                 MessageSendEvent::SendFundingCreated { node_id, .. } => {
 734                         node_id == msg_node_id
 735                 },
 736                 MessageSendEvent::SendFundingSigned { node_id, .. } => {
 737                         node_id == msg_node_id
 738                 },
 739                 MessageSendEvent::SendChannelReady { node_id, .. } => {
 740                         node_id == msg_node_id
 741                 },
 742                 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
 743                         node_id == msg_node_id
 744                 },
 745                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
 746                         node_id == msg_node_id
 747                 },
 748                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
 749                         node_id == msg_node_id
 750                 },
 751                 MessageSendEvent::SendClosingSigned { node_id, .. } => {
 752                         node_id == msg_node_id
 753                 },
 754                 MessageSendEvent::SendShutdown { node_id, .. } => {
 755                         node_id == msg_node_id
 756                 },
 757                 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
 758                         node_id == msg_node_id
 759                 },
 760                 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
 761                         node_id == msg_node_id
 762                 },
 763                 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
 764                         false
 765                 },
 766                 MessageSendEvent::BroadcastChannelUpdate { .. } => {
 767                         false
 768                 },
 769                 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
 770                         false
 771                 },
 772                 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
 773                         node_id == msg_node_id
 774                 },
 775                 MessageSendEvent::HandleError { node_id, .. } => {
 776                         node_id == msg_node_id
 777                 },
 778                 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
 779                         node_id == msg_node_id
 780                 },
 781                 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
 782                         node_id == msg_node_id
 783                 },
 784                 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
 785                         node_id == msg_node_id
 786                 },
 787                 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
 788                         node_id == msg_node_id
 789                 },
 790                 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
 791                         node_id == msg_node_id
 792                 },
 793                 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
 794                         node_id == msg_node_id
 795                 },
 796                 MessageSendEvent::SendTxAddInput { node_id, .. } => {
 797                         node_id == msg_node_id
 798                 },
 799                 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
 800                         node_id == msg_node_id
 801                 },
 802                 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
 803                         node_id == msg_node_id
 804                 },
 805                 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
 806                         node_id == msg_node_id
 807                 },
 808                 MessageSendEvent::SendTxComplete { node_id, .. } => {
 809                         node_id == msg_node_id
 810                 },
 811                 MessageSendEvent::SendTxSignatures { node_id, .. } => {
 812                         node_id == msg_node_id
 813                 },
 814                 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
 815                         node_id == msg_node_id
 816                 },
 817                 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
 818                         node_id == msg_node_id
 819                 },
 820                 MessageSendEvent::SendTxAbort { node_id, .. } => {
 821                         node_id == msg_node_id
 822                 },
 823         }});
 824         if ev_index.is_some() {
 825                 msg_events.remove(ev_index.unwrap())
 826         } else {
 827                 panic!("Couldn't find any MessageSendEvent to the node!")
 828         }
 829 }
 830
 831 #[cfg(test)]
 832 macro_rules! get_channel_ref {
 833         ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
 834                 {
 835                         $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
 836                         $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
 837                         $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
 838                 }
 839         }
 840 }
 841
 842 #[cfg(test)]
 843 macro_rules! get_feerate {
 844         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
 845                 {
 846                         let mut per_peer_state_lock;
 847                         let mut peer_state_lock;
 848                         let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
 849                         phase.context().get_feerate_sat_per_1000_weight()
 850                 }
 851         }
 852 }
 853
 854 #[cfg(test)]
 855 macro_rules! get_channel_type_features {
 856         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
 857                 {
 858                         let mut per_peer_state_lock;
 859                         let mut peer_state_lock;
 860                         let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
 861                         chan.context().get_channel_type().clone()
 862                 }
 863         }
 864 }
 865
 866 /// Returns a channel monitor given a channel id, making some naive assumptions
 867 #[macro_export]
 868 macro_rules! get_monitor {
 869         ($node: expr, $channel_id: expr) => {
 870                 {
 871                         use bitcoin::hashes::Hash;
 872                         let mut monitor = None;
 873                         // Assume funding vout is either 0 or 1 blindly
 874                         for index in 0..2 {
 875                                 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
 876                                         $crate::chain::transaction::OutPoint {
 877                                                 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
 878                                         })
 879                                 {
 880                                         monitor = Some(mon);
 881                                         break;
 882                                 }
 883                         }
 884                         monitor.unwrap()
 885                 }
 886         }
 887 }
 888
 889 /// Returns any local commitment transactions for the channel.
 890 #[macro_export]
 891 macro_rules! get_local_commitment_txn {
 892         ($node: expr, $channel_id: expr) => {
 893                 {
 894                         $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
 895                 }
 896         }
 897 }
 898
 899 /// Check the error from attempting a payment.
 900 #[macro_export]
 901 macro_rules! unwrap_send_err {
 902         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
 903                 match &$res {
 904                         &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
 905                                 assert_eq!(fails.len(), 1);
 906                                 match fails[0] {
 907                                         $type => { $check },
 908                                         _ => panic!(),
 909                                 }
 910                         },
 911                         &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
 912                                 assert_eq!(results.len(), 1);
 913                                 match results[0] {
 914                                         Err($type) => { $check },
 915                                         _ => panic!(),
 916                                 }
 917                         },
 918                         _ => panic!(),
 919                 }
 920         }
 921 }
 922
 923 /// Check whether N channel monitor(s) have been added.
 924 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
 925         if let Some(chain_monitor) = node.chain_monitor() {
 926                 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
 927                 assert_eq!(added_monitors.len(), count);
 928                 added_monitors.clear();
 929         }
 930 }
 931
 932 /// Check whether N channel monitor(s) have been added.
 933 ///
 934 /// Don't use this, use the identically-named function instead.
 935 #[macro_export]
 936 macro_rules! check_added_monitors {
 937         ($node: expr, $count: expr) => {
 938                 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
 939         }
 940 }
 941
 942 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
 943 ///
 944 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
 945 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
 946 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
 947         let mut nodes = path.iter().rev();
 948         let dest = nodes.next().expect("path should have a destination").node;
 949         let prev = nodes.next().unwrap_or(&origin_node).node;
 950         let dest_channels = dest.list_channels();
 951         let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
 952                 .expect("HTLC's channel should be one of destination node's channels");
 953         assert_eq!(htlc.user_channel_id, ch.user_channel_id);
 954         assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
 955 }
 956
 957 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> {
 958         let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
 959         for encoded in monitors_encoded {
 960                 let mut monitor_read = &encoded[..];
 961                 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
 962                         ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
 963                 assert!(monitor_read.is_empty());
 964                 monitors_read.push(monitor);
 965         }
 966
 967         let mut node_read = &chanman_encoded[..];
 968         let (_, node_deserialized) = {
 969                 let mut channel_monitors = HashMap::new();
 970                 for monitor in monitors_read.iter_mut() {
 971                         assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
 972                 }
 973                 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
 974                         default_config,
 975                         entropy_source: node.keys_manager,
 976                         node_signer: node.keys_manager,
 977                         signer_provider: node.keys_manager,
 978                         fee_estimator: node.fee_estimator,
 979                         router: node.router,
 980                         chain_monitor: node.chain_monitor,
 981                         tx_broadcaster: node.tx_broadcaster,
 982                         logger: node.logger,
 983                         channel_monitors,
 984                 }).unwrap()
 985         };
 986         assert!(node_read.is_empty());
 987
 988         for monitor in monitors_read.drain(..) {
 989                 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
 990                         Ok(ChannelMonitorUpdateStatus::Completed));
 991                 check_added_monitors!(node, 1);
 992         }
 993
 994         node_deserialized
 995 }
 996
 997 #[cfg(test)]
 998 macro_rules! reload_node {
 999         ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1000                 let chanman_encoded = $chanman_encoded;
1001
1002                 $persister = test_utils::TestPersister::new();
1003                 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1004                 $node.chain_monitor = &$new_chain_monitor;
1005
1006                 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1007                 $node.node = &$new_channelmanager;
1008         };
1009         ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1010                 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1011         };
1012 }
1013
1014 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1015         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1016  -> (ChannelId, Transaction, OutPoint)
1017 {
1018         internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1019 }
1020
1021 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1022         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1023  -> (ChannelId, Transaction, OutPoint)
1024 {
1025         internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1026 }
1027
1028 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1029         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1030         coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1031         let chan_id = *node.network_chan_count.borrow();
1032
1033         let events = node.node.get_and_clear_pending_events();
1034         assert_eq!(events.len(), 1);
1035         match events[0] {
1036                 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1037                         assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1038                         assert_eq!(*channel_value_satoshis, expected_chan_value);
1039                         assert_eq!(user_channel_id, expected_user_chan_id);
1040
1041                         let input = if coinbase {
1042                                 vec![TxIn {
1043                                         previous_output: bitcoin::OutPoint::null(),
1044                                         ..Default::default()
1045                                 }]
1046                         } else {
1047                                 Vec::new()
1048                         };
1049
1050                         let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1051                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1052                         }]};
1053                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1054                         (*temporary_channel_id, tx, funding_outpoint)
1055                 },
1056                 _ => panic!("Unexpected event"),
1057         }
1058 }
1059
1060 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 {
1061         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1062         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1063
1064         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1065         check_added_monitors!(node_a, 0);
1066
1067         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1068         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1069         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1070         {
1071                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1072                 assert_eq!(added_monitors.len(), 1);
1073                 assert_eq!(added_monitors[0].0, funding_output);
1074                 added_monitors.clear();
1075         }
1076         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1077
1078         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()));
1079         {
1080                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1081                 assert_eq!(added_monitors.len(), 1);
1082                 assert_eq!(added_monitors[0].0, funding_output);
1083                 added_monitors.clear();
1084         }
1085         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1086
1087         let events_4 = node_a.node.get_and_clear_pending_events();
1088         assert_eq!(events_4.len(), 0);
1089
1090         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1091         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1092         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1093
1094         // Ensure that funding_transaction_generated is idempotent.
1095         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1096         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1097         check_added_monitors!(node_a, 0);
1098
1099         tx
1100 }
1101
1102 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1103 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) {
1104         let initiator_channels = initiator.node.list_usable_channels().len();
1105         let receiver_channels = receiver.node.list_usable_channels().len();
1106
1107         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1108         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1109
1110         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1111         let events = receiver.node.get_and_clear_pending_events();
1112         assert_eq!(events.len(), 1);
1113         match events[0] {
1114                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1115                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1116                 },
1117                 _ => panic!("Unexpected event"),
1118         };
1119
1120         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1121         assert_eq!(accept_channel.minimum_depth, 0);
1122         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1123
1124         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1125         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1126         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1127
1128         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1129         check_added_monitors!(receiver, 1);
1130         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1131         assert_eq!(bs_signed_locked.len(), 2);
1132         let as_channel_ready;
1133         match &bs_signed_locked[0] {
1134                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1135                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1136                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1137                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1138                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1139                         check_added_monitors!(initiator, 1);
1140
1141                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1142                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1143
1144                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1145                 }
1146                 _ => panic!("Unexpected event"),
1147         }
1148         match &bs_signed_locked[1] {
1149                 MessageSendEvent::SendChannelReady { node_id, msg } => {
1150                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1151                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1152                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1153                 }
1154                 _ => panic!("Unexpected event"),
1155         }
1156
1157         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1158         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1159
1160         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1161         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1162
1163         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1164         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1165
1166         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1167         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1168
1169         (tx, as_channel_ready.channel_id)
1170 }
1171
1172 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 {
1173         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1174         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1175         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1176         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1177         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1178         if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1179                 let events = node_b.node.get_and_clear_pending_events();
1180                 assert_eq!(events.len(), 1);
1181                 match &events[0] {
1182                         Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1183                                 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1184                         _ => panic!("Unexpected event"),
1185                 };
1186         }
1187         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1188         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1189         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1190         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1191
1192         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1193 }
1194
1195 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) {
1196         confirm_transaction_at(node_conf, tx, conf_height);
1197         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1198         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()));
1199 }
1200
1201 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) {
1202         let channel_id;
1203         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1204         assert_eq!(events_6.len(), 3);
1205         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1206                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1207                 2
1208         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1209                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1210                 1
1211         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1212         ((match events_6[0] {
1213                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1214                         channel_id = msg.channel_id.clone();
1215                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1216                         msg.clone()
1217                 },
1218                 _ => panic!("Unexpected event"),
1219         }, match events_6[announcement_sigs_idx] {
1220                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1221                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1222                         msg.clone()
1223                 },
1224                 _ => panic!("Unexpected event"),
1225         }), channel_id)
1226 }
1227
1228 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) {
1229         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1230         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1231         confirm_transaction_at(node_a, tx, conf_height);
1232         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1233         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1234         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1235 }
1236
1237 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) {
1238         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1239         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1240         (msgs, chan_id, tx)
1241 }
1242
1243 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) {
1244         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1245         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1246         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1247
1248         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1249         assert_eq!(events_7.len(), 1);
1250         let (announcement, bs_update) = match events_7[0] {
1251                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1252                         (msg, update_msg.clone().unwrap())
1253                 },
1254                 _ => panic!("Unexpected event"),
1255         };
1256
1257         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1258         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1259         assert_eq!(events_8.len(), 1);
1260         let as_update = match events_8[0] {
1261                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1262                         assert!(*announcement == *msg);
1263                         let update_msg = update_msg.clone().unwrap();
1264                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1265                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1266                         update_msg
1267                 },
1268                 _ => panic!("Unexpected event"),
1269         };
1270
1271         *node_a.network_chan_count.borrow_mut() += 1;
1272
1273         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1274         ((*announcement).clone(), as_update, bs_update)
1275 }
1276
1277 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) {
1278         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1279 }
1280
1281 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) {
1282         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1283         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1284         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1285 }
1286
1287 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) {
1288         let mut no_announce_cfg = test_default_channel_config();
1289         no_announce_cfg.channel_handshake_config.announced_channel = false;
1290         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1291         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1292         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1293         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1294         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1295
1296         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1297         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1298         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()));
1299         check_added_monitors!(nodes[b], 1);
1300
1301         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1302         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1303
1304         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1305         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1306         check_added_monitors!(nodes[a], 1);
1307
1308         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1309         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1310         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1311
1312         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1313         confirm_transaction_at(&nodes[a], &tx, conf_height);
1314         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1315         confirm_transaction_at(&nodes[b], &tx, conf_height);
1316         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1317         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1318         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()));
1319         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1320         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1321         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1322         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1323         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1324
1325         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1326         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1327
1328         let mut found_a = false;
1329         for chan in nodes[a].node.list_usable_channels() {
1330                 if chan.channel_id == as_channel_ready.channel_id {
1331                         assert!(!found_a);
1332                         found_a = true;
1333                         assert!(!chan.is_public);
1334                 }
1335         }
1336         assert!(found_a);
1337
1338         let mut found_b = false;
1339         for chan in nodes[b].node.list_usable_channels() {
1340                 if chan.channel_id == as_channel_ready.channel_id {
1341                         assert!(!found_b);
1342                         found_b = true;
1343                         assert!(!chan.is_public);
1344                 }
1345         }
1346         assert!(found_b);
1347
1348         (as_channel_ready, tx)
1349 }
1350
1351 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) {
1352         for node in nodes {
1353                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1354                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1355                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1356
1357                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1358                 // forwarding info for local channels even if its not accepted in the network graph.
1359                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1360                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1361         }
1362 }
1363
1364 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1365         for outp in tx.output.iter() {
1366                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1367         }
1368         let mut total_value_in = 0;
1369         for input in tx.input.iter() {
1370                 total_value_in += get_output(&input.previous_output).unwrap().value;
1371         }
1372         let mut total_value_out = 0;
1373         for output in tx.output.iter() {
1374                 total_value_out += output.value;
1375         }
1376         let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1377         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1378         assert!(total_value_out + min_fee <= total_value_in);
1379         tx.verify(get_output).unwrap();
1380 }
1381
1382 #[macro_export]
1383 macro_rules! check_spends {
1384         ($tx: expr, $($spends_txn: expr),*) => {
1385                 {
1386                         $(
1387                         for outp in $spends_txn.output.iter() {
1388                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1389                         }
1390                         )*
1391                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1392                                 $(
1393                                         if out_point.txid == $spends_txn.txid() {
1394                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1395                                         }
1396                                 )*
1397                                 None
1398                         };
1399                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1400                 }
1401         }
1402 }
1403
1404 macro_rules! get_closing_signed_broadcast {
1405         ($node: expr, $dest_pubkey: expr) => {
1406                 {
1407                         let events = $node.get_and_clear_pending_msg_events();
1408                         assert!(events.len() == 1 || events.len() == 2);
1409                         (match events[events.len() - 1] {
1410                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1411                                         assert_eq!(msg.contents.flags & 2, 2);
1412                                         msg.clone()
1413                                 },
1414                                 _ => panic!("Unexpected event"),
1415                         }, if events.len() == 2 {
1416                                 match events[0] {
1417                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1418                                                 assert_eq!(*node_id, $dest_pubkey);
1419                                                 Some(msg.clone())
1420                                         },
1421                                         _ => panic!("Unexpected event"),
1422                                 }
1423                         } else { None })
1424                 }
1425         }
1426 }
1427
1428 #[cfg(test)]
1429 macro_rules! check_warn_msg {
1430         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1431                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1432                 assert_eq!(msg_events.len(), 1);
1433                 match msg_events[0] {
1434                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1435                                 assert_eq!(node_id, $recipient_node_id);
1436                                 assert_eq!(msg.channel_id, $chan_id);
1437                                 msg.data.clone()
1438                         },
1439                         _ => panic!("Unexpected event"),
1440                 }
1441         }}
1442 }
1443
1444 /// Check that a channel's closing channel update has been broadcasted, and optionally
1445 /// check whether an error message event has occurred.
1446 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1447         let msg_events = node.node.get_and_clear_pending_msg_events();
1448         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1449         msg_events.into_iter().filter_map(|msg_event| {
1450                 match msg_event {
1451                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1452                                 assert_eq!(msg.contents.flags & 2, 2);
1453                                 None
1454                         },
1455                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1456                                 assert!(with_error_msg);
1457                                 // TODO: Check node_id
1458                                 Some(msg)
1459                         },
1460                         MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1461                                 assert!(with_error_msg);
1462                                 // TODO: Check node_id
1463                                 Some(msg.unwrap())
1464                         },
1465                         _ => panic!("Unexpected event"),
1466                 }
1467         }).collect()
1468 }
1469
1470 /// Check that a channel's closing channel update has been broadcasted, and optionally
1471 /// check whether an error message event has occurred.
1472 ///
1473 /// Don't use this, use the identically-named function instead.
1474 #[macro_export]
1475 macro_rules! check_closed_broadcast {
1476         ($node: expr, $with_error_msg: expr) => {
1477                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1478         }
1479 }
1480
1481 #[derive(Default)]
1482 pub struct ExpectedCloseEvent {
1483         pub channel_capacity_sats: Option<u64>,
1484         pub channel_id: Option<ChannelId>,
1485         pub counterparty_node_id: Option<PublicKey>,
1486         pub discard_funding: bool,
1487         pub reason: Option<ClosureReason>,
1488 }
1489
1490 /// Check that multiple channel closing events have been issued.
1491 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1492         let closed_events_count = expected_close_events.len();
1493         let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1494         let events = node.node.get_and_clear_pending_events();
1495         assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1496         for expected_event in expected_close_events {
1497                 assert!(events.iter().any(|e| matches!(
1498                         e,
1499                         Event::ChannelClosed {
1500                                 channel_id,
1501                                 reason,
1502                                 counterparty_node_id,
1503                                 channel_capacity_sats,
1504                                 ..
1505                         } if (
1506                                 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1507                                 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1508                                 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1509                                 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
1510                         )
1511                 )));
1512         }
1513         assert_eq!(events.iter().filter(|e| matches!(
1514                 e,
1515                 Event::DiscardFunding { .. },
1516         )).count(), discard_events_count);
1517 }
1518
1519 /// Check that a channel's closing channel events has been issued
1520 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1521         expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1522         let expected_events_count = if is_check_discard_funding {
1523                 2 * expected_counterparty_node_ids.len()
1524         } else {
1525                 expected_counterparty_node_ids.len()
1526         };
1527         assert_eq!(events_count, expected_events_count);
1528         let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1529                 channel_capacity_sats: Some(expected_channel_capacity),
1530                 channel_id: None,
1531                 counterparty_node_id: Some(*node_id),
1532                 discard_funding: is_check_discard_funding,
1533                 reason: Some(expected_reason.clone()),
1534         }).collect::<Vec<_>>();
1535         check_closed_events(node, expected_close_events.as_slice());
1536 }
1537
1538 /// Check that a channel's closing channel events has been issued
1539 ///
1540 /// Don't use this, use the identically-named function instead.
1541 #[macro_export]
1542 macro_rules! check_closed_event {
1543         ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1544                 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1545         };
1546         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1547                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1548                         $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1549         }
1550 }
1551
1552 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1553         let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1554         assert_eq!(events.len(), count);
1555         for event in events {
1556                 match event {
1557                         Event::BumpTransaction(bump_event) => {
1558                                 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1559                                 else { panic!(); }
1560                                 node.bump_tx_handler.handle_event(&bump_event);
1561                         },
1562                         _ => panic!(),
1563                 }
1564         }
1565 }
1566
1567 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) {
1568         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) };
1569         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) };
1570         let (tx_a, tx_b);
1571
1572         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1573         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1574
1575         let events_1 = node_b.get_and_clear_pending_msg_events();
1576         assert!(events_1.len() >= 1);
1577         let shutdown_b = match events_1[0] {
1578                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1579                         assert_eq!(node_id, &node_a.get_our_node_id());
1580                         msg.clone()
1581                 },
1582                 _ => panic!("Unexpected event"),
1583         };
1584
1585         let closing_signed_b = if !close_inbound_first {
1586                 assert_eq!(events_1.len(), 1);
1587                 None
1588         } else {
1589                 Some(match events_1[1] {
1590                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1591                                 assert_eq!(node_id, &node_a.get_our_node_id());
1592                                 msg.clone()
1593                         },
1594                         _ => panic!("Unexpected event"),
1595                 })
1596         };
1597
1598         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1599         let (as_update, bs_update) = if close_inbound_first {
1600                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1601                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1602
1603                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1604                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1605                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1606                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1607
1608                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1609                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1610                 assert!(none_a.is_none());
1611                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1612                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1613                 (as_update, bs_update)
1614         } else {
1615                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1616
1617                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1618                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1619
1620                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1621                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1622                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1623
1624                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1625                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1626                 assert!(none_b.is_none());
1627                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1628                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1629                 (as_update, bs_update)
1630         };
1631         assert_eq!(tx_a, tx_b);
1632         check_spends!(tx_a, funding_tx);
1633
1634         (as_update, bs_update, tx_a)
1635 }
1636
1637 pub struct SendEvent {
1638         pub node_id: PublicKey,
1639         pub msgs: Vec<msgs::UpdateAddHTLC>,
1640         pub commitment_msg: msgs::CommitmentSigned,
1641 }
1642 impl SendEvent {
1643         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1644                 assert!(updates.update_fulfill_htlcs.is_empty());
1645                 assert!(updates.update_fail_htlcs.is_empty());
1646                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1647                 assert!(updates.update_fee.is_none());
1648                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1649         }
1650
1651         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1652                 match event {
1653                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1654                         _ => panic!("Unexpected event type!"),
1655                 }
1656         }
1657
1658         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1659                 let mut events = node.node.get_and_clear_pending_msg_events();
1660                 assert_eq!(events.len(), 1);
1661                 SendEvent::from_event(events.pop().unwrap())
1662         }
1663 }
1664
1665 #[macro_export]
1666 /// Don't use this, use the identically-named function instead.
1667 macro_rules! expect_pending_htlcs_forwardable_conditions {
1668         ($node: expr, $expected_failures: expr) => {
1669                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1670         }
1671 }
1672
1673 #[macro_export]
1674 macro_rules! expect_htlc_handling_failed_destinations {
1675         ($events: expr, $expected_failures: expr) => {{
1676                 for event in $events {
1677                         match event {
1678                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1679                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1680                                         assert!($expected_failures.contains(&failed_next_destination))
1681                                 },
1682                                 _ => panic!("Unexpected destination"),
1683                         }
1684                 }
1685         }}
1686 }
1687
1688 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1689 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1690 /// `expected_failures` set.
1691 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1692         match events[0] {
1693                 Event::PendingHTLCsForwardable { .. } => { },
1694                 _ => panic!("Unexpected event {:?}", events),
1695         };
1696
1697         let count = expected_failures.len() + 1;
1698         assert_eq!(events.len(), count);
1699
1700         if expected_failures.len() > 0 {
1701                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1702         }
1703 }
1704
1705 #[macro_export]
1706 /// Clears (and ignores) a PendingHTLCsForwardable event
1707 ///
1708 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1709 /// set instead.
1710 macro_rules! expect_pending_htlcs_forwardable_ignore {
1711         ($node: expr) => {
1712                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1713         }
1714 }
1715
1716 #[macro_export]
1717 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1718 ///
1719 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1720 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1721         ($node: expr, $expected_failures: expr) => {
1722                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1723         }
1724 }
1725
1726 #[macro_export]
1727 /// Handles a PendingHTLCsForwardable event
1728 macro_rules! expect_pending_htlcs_forwardable {
1729         ($node: expr) => {{
1730                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1731                 $node.node.process_pending_htlc_forwards();
1732
1733                 // Ensure process_pending_htlc_forwards is idempotent.
1734                 $node.node.process_pending_htlc_forwards();
1735         }};
1736 }
1737
1738 #[macro_export]
1739 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1740 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1741         ($node: expr, $expected_failures: expr) => {{
1742                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1743                 $node.node.process_pending_htlc_forwards();
1744
1745                 // Ensure process_pending_htlc_forwards is idempotent.
1746                 $node.node.process_pending_htlc_forwards();
1747         }}
1748 }
1749
1750 #[cfg(test)]
1751 macro_rules! expect_pending_htlcs_forwardable_from_events {
1752         ($node: expr, $events: expr, $ignore: expr) => {{
1753                 assert_eq!($events.len(), 1);
1754                 match $events[0] {
1755                         Event::PendingHTLCsForwardable { .. } => { },
1756                         _ => panic!("Unexpected event"),
1757                 };
1758                 if $ignore {
1759                         $node.node.process_pending_htlc_forwards();
1760
1761                         // Ensure process_pending_htlc_forwards is idempotent.
1762                         $node.node.process_pending_htlc_forwards();
1763                 }
1764         }}
1765 }
1766
1767 #[macro_export]
1768 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1769 /// commitment update.
1770 macro_rules! commitment_signed_dance {
1771         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1772                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1773         };
1774         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1775                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1776         };
1777         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1778                 {
1779                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1780                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1781                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1782                         check_added_monitors(&$node_a, 1);
1783                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1784                         assert!(extra_msg_option.is_none());
1785                         bs_revoke_and_ack
1786                 }
1787         };
1788         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1789                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1790         };
1791         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1792                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1793         }
1794 }
1795
1796 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1797 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1798 /// `revoke_and_ack` response to it.
1799 ///
1800 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1801 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1802 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1803 /// the commitment we're exchanging. `includes_claim` provides that information.
1804 ///
1805 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1806 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1807         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1808         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1809         check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1810         extra_msg_option
1811 }
1812
1813 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1814 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1815 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1816 /// have included.
1817 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1818         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1819         check_added_monitors!(node_b, 0);
1820         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1821         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1822         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1823         check_added_monitors!(node_b, 1);
1824         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1825         let (bs_revoke_and_ack, extra_msg_option) = {
1826                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1827                 assert!(events.len() <= 2);
1828                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1829                 (match node_a_event {
1830                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1831                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1832                                 (*msg).clone()
1833                         },
1834                         _ => panic!("Unexpected event"),
1835                 }, events.get(0).map(|e| e.clone()))
1836         };
1837         check_added_monitors!(node_b, 1);
1838         if fail_backwards {
1839                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1840                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1841         }
1842         (extra_msg_option, bs_revoke_and_ack)
1843 }
1844
1845 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1846 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1847 ///
1848 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1849 /// on failure or that no new messages are left over on success.
1850 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1851         check_added_monitors!(node_a, 0);
1852         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1853         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1854         check_added_monitors!(node_a, 1);
1855
1856         // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1857         let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1858         if fail_backwards { assert!(!got_claim); }
1859         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1860
1861         if skip_last_step { return; }
1862
1863         if fail_backwards {
1864                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1865                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1866                 check_added_monitors!(node_a, 1);
1867
1868                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1869                 let mut number_of_msg_events = 0;
1870                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1871                         let peer_state = peer_state_mutex.lock().unwrap();
1872                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1873                         number_of_msg_events += cp_pending_msg_events.len();
1874                         if cp_pending_msg_events.len() == 1 {
1875                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1876                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1877                                 } else { panic!("Unexpected event"); }
1878                         }
1879                 }
1880                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1881                 assert_eq!(number_of_msg_events, 1);
1882         } else {
1883                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1884         }
1885 }
1886
1887 /// Get a payment preimage and hash.
1888 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1889         let mut payment_count = recipient.network_payment_count.borrow_mut();
1890         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1891         *payment_count += 1;
1892         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1893         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1894         (payment_preimage, payment_hash, payment_secret)
1895 }
1896
1897 /// Get a payment preimage and hash.
1898 ///
1899 /// Don't use this, use the identically-named function instead.
1900 #[macro_export]
1901 macro_rules! get_payment_preimage_hash {
1902         ($dest_node: expr) => {
1903                 get_payment_preimage_hash!($dest_node, None)
1904         };
1905         ($dest_node: expr, $min_value_msat: expr) => {
1906                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1907         };
1908         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1909                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1910         };
1911 }
1912
1913 /// Gets a route from the given sender to the node described in `payment_params`.
1914 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1915         let scorer = TestScorer::new();
1916         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1917         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1918         router::get_route(
1919                 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1920                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1921                 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
1922         )
1923 }
1924
1925 /// Gets a route from the given sender to the node described in `payment_params`.
1926 ///
1927 /// Don't use this, use the identically-named function instead.
1928 #[macro_export]
1929 macro_rules! get_route {
1930         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1931                 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1932                 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1933         }}
1934 }
1935
1936 #[cfg(test)]
1937 #[macro_export]
1938 macro_rules! get_route_and_payment_hash {
1939         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1940                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1941                         .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
1942                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1943         }};
1944         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1945                 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
1946         }};
1947         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
1948                 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1949                 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
1950                 let (payment_preimage, payment_hash, payment_secret) =
1951                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1952                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1953                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1954         }}
1955 }
1956
1957 pub fn check_payment_claimable(
1958         event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1959         expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1960         expected_receiver_node_id: PublicKey,
1961 ) {
1962         match event {
1963                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1964                         assert_eq!(expected_payment_hash, *payment_hash);
1965                         assert_eq!(expected_recv_value, *amount_msat);
1966                         assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1967                         match purpose {
1968                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1969                                         assert_eq!(&expected_payment_preimage, payment_preimage);
1970                                         assert_eq!(expected_payment_secret, *payment_secret);
1971                                 },
1972                                 _ => {},
1973                         }
1974                 },
1975                 _ => panic!("Unexpected event"),
1976         }
1977 }
1978
1979 #[macro_export]
1980 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1981 macro_rules! expect_payment_claimable {
1982         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1983                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1984         };
1985         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1986                 let events = $node.node.get_and_clear_pending_events();
1987                 assert_eq!(events.len(), 1);
1988                 $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)
1989         };
1990 }
1991
1992 #[macro_export]
1993 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1994 macro_rules! expect_payment_claimed {
1995         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1996                 let events = $node.node.get_and_clear_pending_events();
1997                 assert_eq!(events.len(), 1);
1998                 match events[0] {
1999                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2000                                 assert_eq!($expected_payment_hash, *payment_hash);
2001                                 assert_eq!($expected_recv_value, amount_msat);
2002                         },
2003                         _ => panic!("Unexpected event"),
2004                 }
2005         }
2006 }
2007
2008 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2009         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2010         expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2011 ) {
2012         let events = node.node().get_and_clear_pending_events();
2013         let expected_payment_hash = PaymentHash(
2014                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
2015         if expect_per_path_claims {
2016                 assert!(events.len() > 1);
2017         } else {
2018                 assert_eq!(events.len(), 1);
2019         }
2020         if expect_post_ev_mon_update {
2021                 check_added_monitors(node, 1);
2022         }
2023         let expected_payment_id = match events[0] {
2024                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2025                         assert_eq!(expected_payment_preimage, *payment_preimage);
2026                         assert_eq!(expected_payment_hash, *payment_hash);
2027                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
2028                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
2029                         } else {
2030                                 assert!(fee_paid_msat.is_some());
2031                         }
2032                         payment_id.unwrap()
2033                 },
2034                 _ => panic!("Unexpected event"),
2035         };
2036         if expect_per_path_claims {
2037                 for i in 1..events.len() {
2038                         match events[i] {
2039                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2040                                         assert_eq!(payment_id, expected_payment_id);
2041                                         assert_eq!(payment_hash, Some(expected_payment_hash));
2042                                 },
2043                                 _ => panic!("Unexpected event"),
2044                         }
2045                 }
2046         }
2047 }
2048
2049 #[macro_export]
2050 macro_rules! expect_payment_sent {
2051         ($node: expr, $expected_payment_preimage: expr) => {
2052                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2053         };
2054         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2055                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2056         };
2057         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2058                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2059                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2060         }
2061 }
2062
2063 #[cfg(test)]
2064 #[macro_export]
2065 macro_rules! expect_payment_path_successful {
2066         ($node: expr) => {
2067                 let events = $node.node.get_and_clear_pending_events();
2068                 assert_eq!(events.len(), 1);
2069                 match events[0] {
2070                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
2071                         _ => panic!("Unexpected event"),
2072                 }
2073         }
2074 }
2075
2076 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2077         event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2078         upstream_force_closed: bool, downstream_force_closed: bool
2079 ) {
2080         match event {
2081                 Event::PaymentForwarded {
2082                         fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2083                         outbound_amount_forwarded_msat: _
2084                 } => {
2085                         assert_eq!(fee_earned_msat, expected_fee);
2086                         if !upstream_force_closed {
2087                                 // Is the event prev_channel_id in one of the channels between the two nodes?
2088                                 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()));
2089                         }
2090                         // We check for force closures since a force closed channel is removed from the
2091                         // node's channel list
2092                         if !downstream_force_closed {
2093                                 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()));
2094                         }
2095                         assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2096                 },
2097                 _ => panic!("Unexpected event"),
2098         }
2099 }
2100
2101 macro_rules! expect_payment_forwarded {
2102         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2103                 let mut events = $node.node.get_and_clear_pending_events();
2104                 assert_eq!(events.len(), 1);
2105                 $crate::ln::functional_test_utils::expect_payment_forwarded(
2106                         events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee,
2107                         $upstream_force_closed, $downstream_force_closed);
2108         }
2109 }
2110
2111 #[cfg(test)]
2112 #[macro_export]
2113 macro_rules! expect_channel_shutdown_state {
2114         ($node: expr, $chan_id: expr, $state: path) => {
2115                 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2116                 assert_eq!(chan_details.len(), 1);
2117                 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2118         }
2119 }
2120
2121 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2122 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2123         let events = node.node.get_and_clear_pending_events();
2124         assert_eq!(events.len(), 1);
2125         match events[0] {
2126                 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2127                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2128                 },
2129                 _ => panic!("Unexpected event"),
2130         }
2131 }
2132
2133 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2134 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2135         let events = node.node.get_and_clear_pending_events();
2136         assert_eq!(events.len(), 1);
2137         match events[0] {
2138                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2139                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2140                 },
2141                 _ => panic!("Unexpected event"),
2142         }
2143 }
2144
2145 #[cfg(any(test, feature = "_test_utils"))]
2146 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2147         let mut events = node.node.get_and_clear_pending_events();
2148
2149         for event in events.drain(..) {
2150                 match event {
2151                         Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2152                                 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2153                                 assert!(result_idx.is_some());
2154
2155                                 probe_results.remove(result_idx.unwrap());
2156                         },
2157                         _ => panic!(),
2158                 }
2159         };
2160
2161         // Ensure that we received a ProbeSuccessful event for each probe result.
2162         assert!(probe_results.is_empty());
2163 }
2164
2165 pub struct PaymentFailedConditions<'a> {
2166         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2167         pub(crate) expected_blamed_scid: Option<u64>,
2168         pub(crate) expected_blamed_chan_closed: Option<bool>,
2169         pub(crate) expected_mpp_parts_remain: bool,
2170 }
2171
2172 impl<'a> PaymentFailedConditions<'a> {
2173         pub fn new() -> Self {
2174                 Self {
2175                         expected_htlc_error_data: None,
2176                         expected_blamed_scid: None,
2177                         expected_blamed_chan_closed: None,
2178                         expected_mpp_parts_remain: false,
2179                 }
2180         }
2181         pub fn mpp_parts_remain(mut self) -> Self {
2182                 self.expected_mpp_parts_remain = true;
2183                 self
2184         }
2185         pub fn blamed_scid(mut self, scid: u64) -> Self {
2186                 self.expected_blamed_scid = Some(scid);
2187                 self
2188         }
2189         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2190                 self.expected_blamed_chan_closed = Some(closed);
2191                 self
2192         }
2193         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2194                 self.expected_htlc_error_data = Some((code, data));
2195                 self
2196         }
2197 }
2198
2199 #[cfg(test)]
2200 macro_rules! expect_payment_failed_with_update {
2201         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2202                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2203                         &$node, $expected_payment_hash, $payment_failed_permanently,
2204                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2205                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2206         }
2207 }
2208
2209 #[cfg(test)]
2210 macro_rules! expect_payment_failed {
2211         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2212                 #[allow(unused_mut)]
2213                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2214                 $(
2215                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2216                 )*
2217                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2218         };
2219 }
2220
2221 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2222         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2223         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2224 ) {
2225         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2226         let expected_payment_id = match &payment_failed_events[0] {
2227                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2228                         #[cfg(test)]
2229                         error_code,
2230                         #[cfg(test)]
2231                         error_data, .. } => {
2232                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2233                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2234                         #[cfg(test)]
2235                         {
2236                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2237                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2238                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2239                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2240                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2241                                 }
2242                         }
2243
2244                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2245                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2246                                         match upd {
2247                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2248                                                         if let Some(scid) = conditions.expected_blamed_scid {
2249                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2250                                                         }
2251                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2252                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2253                                                 },
2254                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2255                                                         if let Some(scid) = conditions.expected_blamed_scid {
2256                                                                 assert_eq!(*short_channel_id, scid);
2257                                                         }
2258                                                         assert!(is_permanent);
2259                                                 },
2260                                                 _ => panic!("Unexpected update type"),
2261                                         }
2262                                 } else { panic!("Expected network update"); }
2263                         }
2264
2265                         payment_id.unwrap()
2266                 },
2267                 _ => panic!("Unexpected event"),
2268         };
2269         if !conditions.expected_mpp_parts_remain {
2270                 match &payment_failed_events[1] {
2271                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2272                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2273                                 assert_eq!(*payment_id, expected_payment_id);
2274                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2275                                         PaymentFailureReason::RecipientRejected
2276                                 } else {
2277                                         PaymentFailureReason::RetriesExhausted
2278                                 });
2279                         }
2280                         _ => panic!("Unexpected second event"),
2281                 }
2282         }
2283 }
2284
2285 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2286         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2287         conditions: PaymentFailedConditions<'e>
2288 ) {
2289         let events = node.node.get_and_clear_pending_events();
2290         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2291 }
2292
2293 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 {
2294         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2295         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2296                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2297         check_added_monitors!(origin_node, expected_paths.len());
2298         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2299         payment_id
2300 }
2301
2302 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2303         let origin_node_id = expected_path[0].node.get_our_node_id();
2304
2305         // iterate from the receiving node to the origin node and handle update fail htlc.
2306         for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2307                 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2308                 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2309                 check_added_monitors!(prev_node, 0);
2310
2311                 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2312                 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2313                 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2314         }
2315 }
2316
2317 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>, is_probe: bool) -> Option<Event> {
2318         let mut payment_event = SendEvent::from_event(ev);
2319         let mut prev_node = origin_node;
2320         let mut event = None;
2321
2322         for (idx, &node) in expected_path.iter().enumerate() {
2323                 let is_last_hop = idx == expected_path.len() - 1;
2324                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2325
2326                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2327                 check_added_monitors!(node, 0);
2328
2329                 if is_last_hop && is_probe {
2330                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2331                 } else {
2332                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2333                         expect_pending_htlcs_forwardable!(node);
2334                 }
2335
2336                 if is_last_hop && clear_recipient_events {
2337                         let events_2 = node.node.get_and_clear_pending_events();
2338                         if payment_claimable_expected {
2339                                 assert_eq!(events_2.len(), 1);
2340                                 match &events_2[0] {
2341                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2342                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2343                                                 claim_deadline, onion_fields, ..
2344                                         } => {
2345                                                 assert_eq!(our_payment_hash, *payment_hash);
2346                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2347                                                 assert!(onion_fields.is_some());
2348                                                 match &purpose {
2349                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2350                                                                 assert_eq!(expected_preimage, *payment_preimage);
2351                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2352                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2353                                                         },
2354                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2355                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2356                                                                 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2357                                                         },
2358                                                 }
2359                                                 assert_eq!(*amount_msat, recv_value);
2360                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2361                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2362                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2363                                         },
2364                                         _ => panic!("Unexpected event"),
2365                                 }
2366                                 event = Some(events_2[0].clone());
2367                         } else {
2368                                 assert!(events_2.is_empty());
2369                         }
2370                 } else if !is_last_hop {
2371                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2372                         assert_eq!(events_2.len(), 1);
2373                         check_added_monitors!(node, 1);
2374                         payment_event = SendEvent::from_event(events_2.remove(0));
2375                         assert_eq!(payment_event.msgs.len(), 1);
2376                 }
2377
2378                 prev_node = node;
2379         }
2380         event
2381 }
2382
2383 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> {
2384         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage, false)
2385 }
2386
2387 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2388         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2389         assert_eq!(events.len(), expected_route.len());
2390
2391         check_added_monitors!(origin_node, expected_route.len());
2392
2393         for path in expected_route.iter() {
2394                 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2395
2396                 do_pass_along_path(origin_node, path, 0, PaymentHash([0_u8; 32]), None, ev, false, false, None, true);
2397                 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2398
2399                 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2400         }
2401 }
2402
2403 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) {
2404         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2405         assert_eq!(events.len(), expected_route.len());
2406
2407         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2408                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2409                 // Once we've gotten through all the HTLCs, the last one should result in a
2410                 // PaymentClaimable (but each previous one should not!).
2411                 let expect_payment = path_idx == expected_route.len() - 1;
2412                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2413         }
2414 }
2415
2416 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) {
2417         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2418         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2419         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2420 }
2421
2422 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2423         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2424         our_payment_preimage: PaymentPreimage
2425 ) -> u64 {
2426         let extra_fees = vec![0; expected_paths.len()];
2427         do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2428                 &extra_fees[..], skip_last, our_payment_preimage)
2429 }
2430
2431 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2432         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2433         &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2434 ) -> u64 {
2435         assert_eq!(expected_paths.len(), expected_extra_fees.len());
2436         for path in expected_paths.iter() {
2437                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2438         }
2439         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2440         pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2441 }
2442
2443 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 {
2444         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2445         assert_eq!(claim_event.len(), 1);
2446         match claim_event[0] {
2447                 Event::PaymentClaimed {
2448                         purpose: PaymentPurpose::SpontaneousPayment(preimage),
2449                         amount_msat,
2450                         ref htlcs,
2451                         .. }
2452                 | Event::PaymentClaimed {
2453                         purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2454                         ref htlcs,
2455                         amount_msat,
2456                         ..
2457                 } => {
2458                         assert_eq!(preimage, our_payment_preimage);
2459                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2460                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2461                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2462                 },
2463                 Event::PaymentClaimed {
2464                         purpose: PaymentPurpose::InvoicePayment { .. },
2465                         payment_hash,
2466                         amount_msat,
2467                         ref htlcs,
2468                         ..
2469                 } => {
2470                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2471                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2472                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2473                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2474                 }
2475                 _ => panic!(),
2476         }
2477
2478         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2479
2480         let mut expected_total_fee_msat = 0;
2481
2482         macro_rules! msgs_from_ev {
2483                 ($ev: expr) => {
2484                         match $ev {
2485                                 &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 } } => {
2486                                         assert!(update_add_htlcs.is_empty());
2487                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2488                                         assert!(update_fail_htlcs.is_empty());
2489                                         assert!(update_fail_malformed_htlcs.is_empty());
2490                                         assert!(update_fee.is_none());
2491                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2492                                 },
2493                                 _ => panic!("Unexpected event"),
2494                         }
2495                 }
2496         }
2497         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2498         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2499         assert_eq!(events.len(), expected_paths.len());
2500
2501         if events.len() == 1 {
2502                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2503         } else {
2504                 for expected_path in expected_paths.iter() {
2505                         // For MPP payments, we always want the message to the first node in the path.
2506                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2507                         per_path_msgs.push(msgs_from_ev!(&ev));
2508                 }
2509         }
2510
2511         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2512                 let mut next_msgs = Some(path_msgs);
2513                 let mut expected_next_node = next_hop;
2514
2515                 macro_rules! last_update_fulfill_dance {
2516                         ($node: expr, $prev_node: expr) => {
2517                                 {
2518                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2519                                         check_added_monitors!($node, 0);
2520                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2521                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2522                                 }
2523                         }
2524                 }
2525                 macro_rules! mid_update_fulfill_dance {
2526                         ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2527                                 {
2528                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2529                                         let mut fee = {
2530                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2531                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2532                                                         .unwrap().lock().unwrap();
2533                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2534                                                 if let Some(prev_config) = channel.context().prev_config() {
2535                                                         prev_config.forwarding_fee_base_msat
2536                                                 } else {
2537                                                         channel.context().config().forwarding_fee_base_msat
2538                                                 }
2539                                         };
2540                                         if $idx == 1 { fee += expected_extra_fees[i]; }
2541                                         expect_payment_forwarded!(*$node, $next_node, $prev_node, Some(fee as u64), false, false);
2542                                         expected_total_fee_msat += fee as u64;
2543                                         check_added_monitors!($node, 1);
2544                                         let new_next_msgs = if $new_msgs {
2545                                                 let events = $node.node.get_and_clear_pending_msg_events();
2546                                                 assert_eq!(events.len(), 1);
2547                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2548                                                 expected_next_node = nexthop;
2549                                                 Some(res)
2550                                         } else {
2551                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2552                                                 None
2553                                         };
2554                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2555                                         next_msgs = new_next_msgs;
2556                                 }
2557                         }
2558                 }
2559
2560                 let mut prev_node = expected_route.last().unwrap();
2561                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2562                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2563                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2564                         if next_msgs.is_some() {
2565                                 // Since we are traversing in reverse, next_node is actually the previous node
2566                                 let next_node: &Node;
2567                                 if idx == expected_route.len() - 1 {
2568                                         next_node = origin_node;
2569                                 } else {
2570                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2571                                 }
2572                                 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2573                         } else {
2574                                 assert!(!update_next_msgs);
2575                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2576                         }
2577                         if !skip_last && idx == expected_route.len() - 1 {
2578                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2579                         }
2580
2581                         prev_node = node;
2582                 }
2583
2584                 if !skip_last {
2585                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2586                 }
2587         }
2588
2589         // Ensure that claim_funds is idempotent.
2590         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2591         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2592         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2593
2594         expected_total_fee_msat
2595 }
2596 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) {
2597         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2598         if !skip_last {
2599                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2600         }
2601 }
2602
2603 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2604         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2605 }
2606
2607 pub const TEST_FINAL_CLTV: u32 = 70;
2608
2609 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) {
2610         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2611                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2612         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2613         let route = get_route(origin_node, &route_params).unwrap();
2614         assert_eq!(route.paths.len(), 1);
2615         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2616         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2617                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2618         }
2619
2620         let res = send_along_route(origin_node, route, expected_route, recv_value);
2621         (res.0, res.1, res.2, res.3)
2622 }
2623
2624 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2625         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2626                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2627         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2628         let network_graph = origin_node.network_graph.read_only();
2629         let scorer = test_utils::TestScorer::new();
2630         let seed = [0u8; 32];
2631         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2632         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2633         let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2634                 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2635         assert_eq!(route.paths.len(), 1);
2636         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2637         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2638                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2639         }
2640
2641         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2642         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2643                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2644                 true, APIError::ChannelUnavailable { ref err },
2645                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2646 }
2647
2648 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) {
2649         let res = route_payment(&origin, expected_route, recv_value);
2650         claim_payment(&origin, expected_route, res.0);
2651         res
2652 }
2653
2654 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) {
2655         for path in expected_paths.iter() {
2656                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2657         }
2658         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2659         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2660         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2661
2662         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2663 }
2664
2665 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) {
2666         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2667         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2668
2669         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2670         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2671         assert_eq!(events.len(), expected_paths.len());
2672         for ev in events.iter() {
2673                 let (update_fail, commitment_signed, node_id) = match ev {
2674                         &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 } } => {
2675                                 assert!(update_add_htlcs.is_empty());
2676                                 assert!(update_fulfill_htlcs.is_empty());
2677                                 assert_eq!(update_fail_htlcs.len(), 1);
2678                                 assert!(update_fail_malformed_htlcs.is_empty());
2679                                 assert!(update_fee.is_none());
2680                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2681                         },
2682                         _ => panic!("Unexpected event"),
2683                 };
2684                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2685         }
2686         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2687         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()));
2688
2689         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2690                 let mut next_msgs = Some(path_msgs);
2691                 let mut expected_next_node = next_hop;
2692                 let mut prev_node = expected_route.last().unwrap();
2693
2694                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2695                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2696                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2697                         if next_msgs.is_some() {
2698                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2699                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2700                                 if !update_next_node {
2701                                         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 }]);
2702                                 }
2703                         }
2704                         let events = node.node.get_and_clear_pending_msg_events();
2705                         if update_next_node {
2706                                 assert_eq!(events.len(), 1);
2707                                 match events[0] {
2708                                         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 } } => {
2709                                                 assert!(update_add_htlcs.is_empty());
2710                                                 assert!(update_fulfill_htlcs.is_empty());
2711                                                 assert_eq!(update_fail_htlcs.len(), 1);
2712                                                 assert!(update_fail_malformed_htlcs.is_empty());
2713                                                 assert!(update_fee.is_none());
2714                                                 expected_next_node = node_id.clone();
2715                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2716                                         },
2717                                         _ => panic!("Unexpected event"),
2718                                 }
2719                         } else {
2720                                 assert!(events.is_empty());
2721                         }
2722                         if !skip_last && idx == expected_route.len() - 1 {
2723                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2724                         }
2725
2726                         prev_node = node;
2727                 }
2728
2729                 if !skip_last {
2730                         let prev_node = expected_route.first().unwrap();
2731                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2732                         check_added_monitors!(origin_node, 0);
2733                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2734                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2735                         let events = origin_node.node.get_and_clear_pending_events();
2736                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2737
2738                         let expected_payment_id = match events[0] {
2739                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2740                                         assert_eq!(payment_hash, our_payment_hash);
2741                                         assert!(payment_failed_permanently);
2742                                         for (idx, hop) in expected_route.iter().enumerate() {
2743                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2744                                         }
2745                                         payment_id.unwrap()
2746                                 },
2747                                 _ => panic!("Unexpected event"),
2748                         };
2749                         if i == expected_paths.len() - 1 {
2750                                 match events[1] {
2751                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2752                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2753                                                 assert_eq!(*payment_id, expected_payment_id);
2754                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2755                                         }
2756                                         _ => panic!("Unexpected second event"),
2757                                 }
2758                         }
2759                 }
2760         }
2761
2762         // Ensure that fail_htlc_backwards is idempotent.
2763         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2764         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2765         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2766         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2767 }
2768
2769 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2770         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2771 }
2772
2773 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2774         let mut chan_mon_cfgs = Vec::new();
2775         for i in 0..node_count {
2776                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2777                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2778                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2779                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2780                 let persister = test_utils::TestPersister::new();
2781                 let seed = [i as u8; 32];
2782                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2783                 let scorer = RwLock::new(test_utils::TestScorer::new());
2784
2785                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2786         }
2787
2788         chan_mon_cfgs
2789 }
2790
2791 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2792         create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2793 }
2794
2795 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>> {
2796         let mut nodes = Vec::new();
2797
2798         for i in 0..node_count {
2799                 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);
2800                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2801                 let seed = [i as u8; 32];
2802                 nodes.push(NodeCfg {
2803                         chain_source: &chanmon_cfgs[i].chain_source,
2804                         logger: &chanmon_cfgs[i].logger,
2805                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2806                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2807                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2808                         chain_monitor,
2809                         keys_manager: &chanmon_cfgs[i].keys_manager,
2810                         node_seed: seed,
2811                         network_graph,
2812                         override_init_features: Rc::new(RefCell::new(None)),
2813                 });
2814         }
2815
2816         nodes
2817 }
2818
2819 pub fn test_default_channel_config() -> UserConfig {
2820         let mut default_config = UserConfig::default();
2821         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2822         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2823         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2824         default_config.channel_handshake_config.announced_channel = true;
2825         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2826         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2827         // It now defaults to 1, so we simply set it to the expected value here.
2828         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2829         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2830         // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2831         // feerate of 253).
2832         default_config.channel_config.max_dust_htlc_exposure =
2833                 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2834         default_config
2835 }
2836
2837 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>> {
2838         let mut chanmgrs = Vec::new();
2839         for i in 0..node_count {
2840                 let network = Network::Testnet;
2841                 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2842                 let params = ChainParameters {
2843                         network,
2844                         best_block: BestBlock::from_network(network),
2845                 };
2846                 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,
2847                         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);
2848                 chanmgrs.push(node);
2849         }
2850
2851         chanmgrs
2852 }
2853
2854 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>> {
2855         let mut nodes = Vec::new();
2856         let chan_count = Rc::new(RefCell::new(0));
2857         let payment_count = Rc::new(RefCell::new(0));
2858         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2859
2860         for i in 0..node_count {
2861                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2862                 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2863                 nodes.push(Node{
2864                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2865                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2866                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2867                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2868                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2869                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2870                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2871                         connect_style: Rc::clone(&connect_style),
2872                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2873                         wallet_source: Arc::clone(&wallet_source),
2874                         bump_tx_handler: BumpTransactionEventHandler::new(
2875                                 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2876                                 &cfgs[i].keys_manager, cfgs[i].logger,
2877                         ),
2878                 })
2879         }
2880
2881         for i in 0..node_count {
2882                 for j in (i+1)..node_count {
2883                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2884                                 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2885                                 networks: None,
2886                                 remote_network_address: None,
2887                         }, true).unwrap();
2888                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2889                                 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2890                                 networks: None,
2891                                 remote_network_address: None,
2892                         }, false).unwrap();
2893                 }
2894         }
2895
2896         nodes
2897 }
2898
2899 // Note that the following only works for CLTV values up to 128
2900 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2901 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2902
2903 #[derive(PartialEq)]
2904 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2905 /// Tests that the given node has broadcast transactions for the given Channel
2906 ///
2907 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2908 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2909 /// broadcast and the revoked outputs were claimed.
2910 ///
2911 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2912 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2913 ///
2914 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2915 /// also fail.
2916 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>  {
2917         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2918         let mut txn_seen = HashSet::new();
2919         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2920         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2921
2922         let mut res = Vec::with_capacity(2);
2923         node_txn.retain(|tx| {
2924                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2925                         check_spends!(tx, chan.3);
2926                         if commitment_tx.is_none() {
2927                                 res.push(tx.clone());
2928                         }
2929                         false
2930                 } else { true }
2931         });
2932         if let Some(explicit_tx) = commitment_tx {
2933                 res.push(explicit_tx.clone());
2934         }
2935
2936         assert_eq!(res.len(), 1);
2937
2938         if has_htlc_tx != HTLCType::NONE {
2939                 node_txn.retain(|tx| {
2940                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2941                                 check_spends!(tx, res[0]);
2942                                 if has_htlc_tx == HTLCType::TIMEOUT {
2943                                         assert!(tx.lock_time.0 != 0);
2944                                 } else {
2945                                         assert!(tx.lock_time.0 == 0);
2946                                 }
2947                                 res.push(tx.clone());
2948                                 false
2949                         } else { true }
2950                 });
2951                 assert!(res.len() == 2 || res.len() == 3);
2952                 if res.len() == 3 {
2953                         assert_eq!(res[1], res[2]);
2954                 }
2955         }
2956
2957         assert!(node_txn.is_empty());
2958         res
2959 }
2960
2961 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2962 /// HTLC transaction.
2963 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2964         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2965         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2966         // for revoked htlc outputs
2967         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2968         node_txn.retain(|tx| {
2969                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2970                         check_spends!(tx, revoked_tx);
2971                         false
2972                 } else { true }
2973         });
2974         node_txn.retain(|tx| {
2975                 check_spends!(tx, commitment_revoked_tx);
2976                 false
2977         });
2978         assert!(node_txn.is_empty());
2979 }
2980
2981 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2982         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2983         let mut txn_seen = HashSet::new();
2984         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2985
2986         let mut found_prev = false;
2987         for prev_tx in prev_txn {
2988                 for tx in &*node_txn {
2989                         if tx.input[0].previous_output.txid == prev_tx.txid() {
2990                                 check_spends!(tx, prev_tx);
2991                                 let mut iter = tx.input[0].witness.iter();
2992                                 iter.next().expect("expected 3 witness items");
2993                                 iter.next().expect("expected 3 witness items");
2994                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2995                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2996
2997                                 found_prev = true;
2998                                 break;
2999                         }
3000                 }
3001         }
3002         assert!(found_prev);
3003
3004         let mut res = Vec::new();
3005         mem::swap(&mut *node_txn, &mut res);
3006         res
3007 }
3008
3009 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)  {
3010         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3011         assert_eq!(events_1.len(), 2);
3012         let as_update = match events_1[0] {
3013                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3014                         msg.clone()
3015                 },
3016                 _ => panic!("Unexpected event"),
3017         };
3018         match events_1[1] {
3019                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3020                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3021                         assert_eq!(msg.data, expected_error);
3022                         if needs_err_handle {
3023                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3024                         }
3025                 },
3026                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3027                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3028                         assert_eq!(msg.as_ref().unwrap().data, expected_error);
3029                         if needs_err_handle {
3030                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3031                         }
3032                 },
3033                 _ => panic!("Unexpected event"),
3034         }
3035
3036         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3037         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3038         let bs_update = match events_2[0] {
3039                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3040                         msg.clone()
3041                 },
3042                 _ => panic!("Unexpected event"),
3043         };
3044         if !needs_err_handle {
3045                 match events_2[1] {
3046                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3047                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3048                                 assert_eq!(msg.data, expected_error);
3049                         },
3050                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3051                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3052                                 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3053                         },
3054                         _ => panic!("Unexpected event"),
3055                 }
3056         }
3057
3058         for node in nodes {
3059                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3060                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3061         }
3062 }
3063
3064 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
3065         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3066 }
3067
3068 #[cfg(test)]
3069 macro_rules! get_channel_value_stat {
3070         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3071                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3072                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3073                 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3074                         |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3075                 ).flatten().unwrap();
3076                 chan.get_value_stat()
3077         }}
3078 }
3079
3080 macro_rules! get_chan_reestablish_msgs {
3081         ($src_node: expr, $dst_node: expr) => {
3082                 {
3083                         let mut announcements = $crate::prelude::HashSet::new();
3084                         let mut res = Vec::with_capacity(1);
3085                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
3086                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3087                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3088                                         res.push(msg.clone());
3089                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3090                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3091                                         announcements.insert(msg.contents.short_channel_id);
3092                                 } else {
3093                                         panic!("Unexpected event")
3094                                 }
3095                         }
3096                         assert!(announcements.is_empty());
3097                         res
3098                 }
3099         }
3100 }
3101
3102 macro_rules! handle_chan_reestablish_msgs {
3103         ($src_node: expr, $dst_node: expr) => {
3104                 {
3105                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3106                         let mut idx = 0;
3107                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3108                                 idx += 1;
3109                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3110                                 Some(msg.clone())
3111                         } else {
3112                                 None
3113                         };
3114
3115                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3116                                 idx += 1;
3117                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3118                         }
3119
3120                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3121                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3122                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3123                                 idx += 1;
3124                                 had_channel_update = true;
3125                         }
3126
3127                         let mut revoke_and_ack = None;
3128                         let mut commitment_update = None;
3129                         let order = if let Some(ev) = msg_events.get(idx) {
3130                                 match ev {
3131                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3132                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3133                                                 revoke_and_ack = Some(msg.clone());
3134                                                 idx += 1;
3135                                                 RAACommitmentOrder::RevokeAndACKFirst
3136                                         },
3137                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3138                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3139                                                 commitment_update = Some(updates.clone());
3140                                                 idx += 1;
3141                                                 RAACommitmentOrder::CommitmentFirst
3142                                         },
3143                                         _ => RAACommitmentOrder::CommitmentFirst,
3144                                 }
3145                         } else {
3146                                 RAACommitmentOrder::CommitmentFirst
3147                         };
3148
3149                         if let Some(ev) = msg_events.get(idx) {
3150                                 match ev {
3151                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3152                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3153                                                 assert!(revoke_and_ack.is_none());
3154                                                 revoke_and_ack = Some(msg.clone());
3155                                                 idx += 1;
3156                                         },
3157                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3158                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3159                                                 assert!(commitment_update.is_none());
3160                                                 commitment_update = Some(updates.clone());
3161                                                 idx += 1;
3162                                         },
3163                                         _ => {},
3164                                 }
3165                         }
3166
3167                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3168                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3169                                 idx += 1;
3170                                 assert!(!had_channel_update);
3171                         }
3172
3173                         assert_eq!(msg_events.len(), idx);
3174
3175                         (channel_ready, revoke_and_ack, commitment_update, order)
3176                 }
3177         }
3178 }
3179
3180 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3181         pub node_a: &'a Node<'b, 'c, 'd>,
3182         pub node_b: &'a Node<'b, 'c, 'd>,
3183         pub send_channel_ready: (bool, bool),
3184         pub pending_responding_commitment_signed: (bool, bool),
3185         /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3186         /// and no monitor update is expected
3187         pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3188         pub pending_htlc_adds: (usize, usize),
3189         pub pending_htlc_claims: (usize, usize),
3190         pub pending_htlc_fails: (usize, usize),
3191         pub pending_cell_htlc_claims: (usize, usize),
3192         pub pending_cell_htlc_fails: (usize, usize),
3193         pub pending_raa: (bool, bool),
3194 }
3195
3196 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3197         pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3198                 Self {
3199                         node_a,
3200                         node_b,
3201                         send_channel_ready: (false, false),
3202                         pending_responding_commitment_signed: (false, false),
3203                         pending_responding_commitment_signed_dup_monitor: (false, false),
3204                         pending_htlc_adds: (0, 0),
3205                         pending_htlc_claims: (0, 0),
3206                         pending_htlc_fails: (0, 0),
3207                         pending_cell_htlc_claims: (0, 0),
3208                         pending_cell_htlc_fails: (0, 0),
3209                         pending_raa: (false, false),
3210                 }
3211         }
3212 }
3213
3214 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3215 /// for claims/fails they are separated out.
3216 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3217         let ReconnectArgs {
3218                 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3219                 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3220                 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3221         } = args;
3222         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3223                 features: node_b.node.init_features(), networks: None, remote_network_address: None
3224         }, true).unwrap();
3225         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3226         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3227                 features: node_a.node.init_features(), networks: None, remote_network_address: None
3228         }, false).unwrap();
3229         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3230
3231         if send_channel_ready.0 {
3232                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3233                 // from b
3234                 for reestablish in reestablish_1.iter() {
3235                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3236                 }
3237         }
3238         if send_channel_ready.1 {
3239                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3240                 // from a
3241                 for reestablish in reestablish_2.iter() {
3242                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3243                 }
3244         }
3245         if send_channel_ready.0 || send_channel_ready.1 {
3246                 // If we expect any channel_ready's, both sides better have set
3247                 // next_holder_commitment_number to 1
3248                 for reestablish in reestablish_1.iter() {
3249                         assert_eq!(reestablish.next_local_commitment_number, 1);
3250                 }
3251                 for reestablish in reestablish_2.iter() {
3252                         assert_eq!(reestablish.next_local_commitment_number, 1);
3253                 }
3254         }
3255
3256         let mut resp_1 = Vec::new();
3257         for msg in reestablish_1 {
3258                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3259                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3260         }
3261         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3262                 check_added_monitors!(node_b, 1);
3263         } else {
3264                 check_added_monitors!(node_b, 0);
3265         }
3266
3267         let mut resp_2 = Vec::new();
3268         for msg in reestablish_2 {
3269                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3270                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3271         }
3272         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3273                 check_added_monitors!(node_a, 1);
3274         } else {
3275                 check_added_monitors!(node_a, 0);
3276         }
3277
3278         // We don't yet support both needing updates, as that would require a different commitment dance:
3279         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3280                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3281                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3282                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3283
3284         for chan_msgs in resp_1.drain(..) {
3285                 if send_channel_ready.0 {
3286                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3287                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3288                         if !announcement_event.is_empty() {
3289                                 assert_eq!(announcement_event.len(), 1);
3290                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3291                                         //TODO: Test announcement_sigs re-sending
3292                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3293                         }
3294                 } else {
3295                         assert!(chan_msgs.0.is_none());
3296                 }
3297                 if pending_raa.0 {
3298                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3299                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3300                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3301                         check_added_monitors!(node_a, 1);
3302                 } else {
3303                         assert!(chan_msgs.1.is_none());
3304                 }
3305                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3306                         pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3307                         pending_responding_commitment_signed.0
3308                 {
3309                         let commitment_update = chan_msgs.2.unwrap();
3310                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3311                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3312                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3313                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3314                         for update_add in commitment_update.update_add_htlcs {
3315                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3316                         }
3317                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3318                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3319                         }
3320                         for update_fail in commitment_update.update_fail_htlcs {
3321                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3322                         }
3323
3324                         if !pending_responding_commitment_signed.0 {
3325                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3326                         } else {
3327                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3328                                 check_added_monitors!(node_a, 1);
3329                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3330                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3331                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3332                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3333                                 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3334                         }
3335                 } else {
3336                         assert!(chan_msgs.2.is_none());
3337                 }
3338         }
3339
3340         for chan_msgs in resp_2.drain(..) {
3341                 if send_channel_ready.1 {
3342                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3343                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3344                         if !announcement_event.is_empty() {
3345                                 assert_eq!(announcement_event.len(), 1);
3346                                 match announcement_event[0] {
3347                                         MessageSendEvent::SendChannelUpdate { .. } => {},
3348                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3349                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3350                                 }
3351                         }
3352                 } else {
3353                         assert!(chan_msgs.0.is_none());
3354                 }
3355                 if pending_raa.1 {
3356                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3357                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3358                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3359                         check_added_monitors!(node_b, 1);
3360                 } else {
3361                         assert!(chan_msgs.1.is_none());
3362                 }
3363                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3364                         pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3365                         pending_responding_commitment_signed.1
3366                 {
3367                         let commitment_update = chan_msgs.2.unwrap();
3368                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3369                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3370                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3371                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3372                         for update_add in commitment_update.update_add_htlcs {
3373                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3374                         }
3375                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3376                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3377                         }
3378                         for update_fail in commitment_update.update_fail_htlcs {
3379                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3380                         }
3381
3382                         if !pending_responding_commitment_signed.1 {
3383                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3384                         } else {
3385                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3386                                 check_added_monitors!(node_b, 1);
3387                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3388                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3389                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3390                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3391                                 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3392                         }
3393                 } else {
3394                         assert!(chan_msgs.2.is_none());
3395                 }
3396         }
3397 }
3398
3399 /// Initiates channel opening and creates a single batch funding transaction.
3400 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3401 /// transaction with corresponding funding_created messages.
3402 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3403         funding_node: &Node<'a, 'b, 'c>,
3404         params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3405 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3406         let mut tx_outs = Vec::new();
3407         let mut temp_chan_ids = Vec::new();
3408         let mut funding_created_msgs = Vec::new();
3409
3410         for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3411                 // Initialize channel opening.
3412                 let temp_chan_id = funding_node.node.create_channel(
3413                         other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3414                         *override_config,
3415                 ).unwrap();
3416                 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3417                 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3418                 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3419                 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3420
3421                 // Create the corresponding funding output.
3422                 let events = funding_node.node.get_and_clear_pending_events();
3423                 assert_eq!(events.len(), 1);
3424                 match events[0] {
3425                         Event::FundingGenerationReady {
3426                                 ref temporary_channel_id,
3427                                 ref counterparty_node_id,
3428                                 channel_value_satoshis: ref event_channel_value_satoshis,
3429                                 ref output_script,
3430                                 user_channel_id: ref event_user_channel_id
3431                         } => {
3432                                 assert_eq!(temporary_channel_id, &temp_chan_id);
3433                                 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3434                                 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3435                                 assert_eq!(user_channel_id, event_user_channel_id);
3436                                 tx_outs.push(TxOut {
3437                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3438                                 });
3439                         },
3440                         _ => panic!("Unexpected event"),
3441                 };
3442                 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3443         }
3444
3445         // Compose the batch funding transaction and give it to the ChannelManager.
3446         let tx = Transaction {
3447                 version: 2,
3448                 lock_time: PackedLockTime::ZERO,
3449                 input: Vec::new(),
3450                 output: tx_outs,
3451         };
3452         assert!(funding_node.node.batch_funding_transaction_generated(
3453                 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3454                 tx.clone(),
3455         ).is_ok());
3456         check_added_monitors!(funding_node, 0);
3457         let events = funding_node.node.get_and_clear_pending_msg_events();
3458         assert_eq!(events.len(), params.len());
3459         for (other_node, ..) in params {
3460                 let funding_created = events
3461                         .iter()
3462                         .find_map(|event| match event {
3463                                 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3464                                 _ => None,
3465                         })
3466                         .unwrap();
3467                 funding_created_msgs.push(funding_created);
3468         }
3469         return (tx, funding_created_msgs);
3470 }