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