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