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