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