_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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