_ 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                         _ => panic!(),
 960                 }
 961         }
 962 }
 963
 964 /// Check whether N channel monitor(s) have been added.
 965 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
 966         if let Some(chain_monitor) = node.chain_monitor() {
 967                 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
 968                 let n = added_monitors.len();
 969                 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
 970                 added_monitors.clear();
 971         }
 972 }
 973
 974 /// Check whether N channel monitor(s) have been added.
 975 ///
 976 /// Don't use this, use the identically-named function instead.
 977 #[macro_export]
 978 macro_rules! check_added_monitors {
 979         ($node: expr, $count: expr) => {
 980                 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
 981         }
 982 }
 983
 984 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
 985 ///
 986 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
 987 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
 988 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
 989         let mut nodes = path.iter().rev();
 990         let dest = nodes.next().expect("path should have a destination").node;
 991         let prev = nodes.next().unwrap_or(&origin_node).node;
 992         let dest_channels = dest.list_channels();
 993         let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
 994                 .expect("HTLC's channel should be one of destination node's channels");
 995         assert_eq!(htlc.user_channel_id, ch.user_channel_id);
 996         assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
 997 }
 998
 999 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> {
1000         let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1001         for encoded in monitors_encoded {
1002                 let mut monitor_read = &encoded[..];
1003                 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1004                         ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1005                 assert!(monitor_read.is_empty());
1006                 monitors_read.push(monitor);
1007         }
1008
1009         let mut node_read = &chanman_encoded[..];
1010         let (_, node_deserialized) = {
1011                 let mut channel_monitors = HashMap::new();
1012                 for monitor in monitors_read.iter_mut() {
1013                         assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1014                 }
1015                 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1016                         default_config,
1017                         entropy_source: node.keys_manager,
1018                         node_signer: node.keys_manager,
1019                         signer_provider: node.keys_manager,
1020                         fee_estimator: node.fee_estimator,
1021                         router: node.router,
1022                         chain_monitor: node.chain_monitor,
1023                         tx_broadcaster: node.tx_broadcaster,
1024                         logger: node.logger,
1025                         channel_monitors,
1026                 }).unwrap()
1027         };
1028         assert!(node_read.is_empty());
1029
1030         for monitor in monitors_read.drain(..) {
1031                 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
1032                         Ok(ChannelMonitorUpdateStatus::Completed));
1033                 check_added_monitors!(node, 1);
1034         }
1035
1036         node_deserialized
1037 }
1038
1039 #[cfg(test)]
1040 macro_rules! reload_node {
1041         ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1042                 let chanman_encoded = $chanman_encoded;
1043
1044                 $persister = test_utils::TestPersister::new();
1045                 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1046                 $node.chain_monitor = &$new_chain_monitor;
1047
1048                 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1049                 $node.node = &$new_channelmanager;
1050         };
1051         ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1052                 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1053         };
1054 }
1055
1056 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1057         expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1058  -> (ChannelId, Transaction, OutPoint)
1059 {
1060         internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1061 }
1062
1063 pub fn create_coinbase_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, true)
1068 }
1069
1070 fn internal_create_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         coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1073         let chan_id = *node.network_chan_count.borrow();
1074
1075         let events = node.node.get_and_clear_pending_events();
1076         assert_eq!(events.len(), 1);
1077         match events[0] {
1078                 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1079                         assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1080                         assert_eq!(*channel_value_satoshis, expected_chan_value);
1081                         assert_eq!(user_channel_id, expected_user_chan_id);
1082
1083                         let input = if coinbase {
1084                                 vec![TxIn {
1085                                         previous_output: bitcoin::OutPoint::null(),
1086                                         ..Default::default()
1087                                 }]
1088                         } else {
1089                                 Vec::new()
1090                         };
1091
1092                         let tx = Transaction { version: chan_id as i32, lock_time: LockTime::ZERO, input, output: vec![TxOut {
1093                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1094                         }]};
1095                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1096                         (*temporary_channel_id, tx, funding_outpoint)
1097                 },
1098                 _ => panic!("Unexpected event"),
1099         }
1100 }
1101
1102 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 {
1103         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1104         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1105
1106         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1107         check_added_monitors!(node_a, 0);
1108
1109         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1110         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1111         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1112         {
1113                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1114                 assert_eq!(added_monitors.len(), 1);
1115                 assert_eq!(added_monitors[0].0, funding_output);
1116                 added_monitors.clear();
1117         }
1118         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1119
1120         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()));
1121         {
1122                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1123                 assert_eq!(added_monitors.len(), 1);
1124                 assert_eq!(added_monitors[0].0, funding_output);
1125                 added_monitors.clear();
1126         }
1127         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1128
1129         let events_4 = node_a.node.get_and_clear_pending_events();
1130         assert_eq!(events_4.len(), 0);
1131
1132         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1133         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1134         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1135
1136         // Ensure that funding_transaction_generated is idempotent.
1137         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1138         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1139         check_added_monitors!(node_a, 0);
1140
1141         tx
1142 }
1143
1144 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1145 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) {
1146         let initiator_channels = initiator.node.list_usable_channels().len();
1147         let receiver_channels = receiver.node.list_usable_channels().len();
1148
1149         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1150         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1151
1152         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1153         let events = receiver.node.get_and_clear_pending_events();
1154         assert_eq!(events.len(), 1);
1155         match events[0] {
1156                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1157                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1158                 },
1159                 _ => panic!("Unexpected event"),
1160         };
1161
1162         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1163         assert_eq!(accept_channel.minimum_depth, 0);
1164         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1165
1166         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1167         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1168         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1169
1170         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1171         check_added_monitors!(receiver, 1);
1172         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1173         assert_eq!(bs_signed_locked.len(), 2);
1174         let as_channel_ready;
1175         match &bs_signed_locked[0] {
1176                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1177                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1178                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1179                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1180                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1181                         check_added_monitors!(initiator, 1);
1182
1183                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1184                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1185
1186                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1187                 }
1188                 _ => panic!("Unexpected event"),
1189         }
1190         match &bs_signed_locked[1] {
1191                 MessageSendEvent::SendChannelReady { node_id, msg } => {
1192                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1193                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1194                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1195                 }
1196                 _ => panic!("Unexpected event"),
1197         }
1198
1199         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1200         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1201
1202         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1203         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1204
1205         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1206         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1207
1208         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1209         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1210
1211         (tx, as_channel_ready.channel_id)
1212 }
1213
1214 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 {
1215         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1216         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1217         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1218         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1219         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1220         if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1221                 let events = node_b.node.get_and_clear_pending_events();
1222                 assert_eq!(events.len(), 1);
1223                 match &events[0] {
1224                         Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1225                                 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1226                         _ => panic!("Unexpected event"),
1227                 };
1228         }
1229         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1230         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1231         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1232         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1233
1234         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1235 }
1236
1237 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) {
1238         confirm_transaction_at(node_conf, tx, conf_height);
1239         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1240         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()));
1241 }
1242
1243 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) {
1244         let channel_id;
1245         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1246         assert_eq!(events_6.len(), 3);
1247         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1248                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1249                 2
1250         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1251                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1252                 1
1253         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1254         ((match events_6[0] {
1255                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1256                         channel_id = msg.channel_id.clone();
1257                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1258                         msg.clone()
1259                 },
1260                 _ => panic!("Unexpected event"),
1261         }, match events_6[announcement_sigs_idx] {
1262                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1263                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1264                         msg.clone()
1265                 },
1266                 _ => panic!("Unexpected event"),
1267         }), channel_id)
1268 }
1269
1270 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) {
1271         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1272         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1273         confirm_transaction_at(node_a, tx, conf_height);
1274         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1275         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1276         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1277 }
1278
1279 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) {
1280         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1281         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1282         (msgs, chan_id, tx)
1283 }
1284
1285 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) {
1286         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1287         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1288         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1289
1290         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1291         assert_eq!(events_7.len(), 1);
1292         let (announcement, bs_update) = match events_7[0] {
1293                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1294                         (msg, update_msg.clone().unwrap())
1295                 },
1296                 _ => panic!("Unexpected event"),
1297         };
1298
1299         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1300         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1301         assert_eq!(events_8.len(), 1);
1302         let as_update = match events_8[0] {
1303                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1304                         assert!(*announcement == *msg);
1305                         let update_msg = update_msg.clone().unwrap();
1306                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1307                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1308                         update_msg
1309                 },
1310                 _ => panic!("Unexpected event"),
1311         };
1312
1313         *node_a.network_chan_count.borrow_mut() += 1;
1314
1315         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1316         ((*announcement).clone(), as_update, bs_update)
1317 }
1318
1319 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) {
1320         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1321 }
1322
1323 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) {
1324         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1325         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1326         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1327 }
1328
1329 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) {
1330         let mut no_announce_cfg = test_default_channel_config();
1331         no_announce_cfg.channel_handshake_config.announced_channel = false;
1332         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1333         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1334         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1335         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1336         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1337
1338         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1339         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1340         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()));
1341         check_added_monitors!(nodes[b], 1);
1342
1343         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1344         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1345
1346         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1347         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1348         check_added_monitors!(nodes[a], 1);
1349
1350         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1351         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1352         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1353
1354         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1355         confirm_transaction_at(&nodes[a], &tx, conf_height);
1356         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1357         confirm_transaction_at(&nodes[b], &tx, conf_height);
1358         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1359         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1360         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()));
1361         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1362         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1363         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1364         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1365         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1366
1367         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1368         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1369
1370         let mut found_a = false;
1371         for chan in nodes[a].node.list_usable_channels() {
1372                 if chan.channel_id == as_channel_ready.channel_id {
1373                         assert!(!found_a);
1374                         found_a = true;
1375                         assert!(!chan.is_public);
1376                 }
1377         }
1378         assert!(found_a);
1379
1380         let mut found_b = false;
1381         for chan in nodes[b].node.list_usable_channels() {
1382                 if chan.channel_id == as_channel_ready.channel_id {
1383                         assert!(!found_b);
1384                         found_b = true;
1385                         assert!(!chan.is_public);
1386                 }
1387         }
1388         assert!(found_b);
1389
1390         (as_channel_ready, tx)
1391 }
1392
1393 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) {
1394         for node in nodes {
1395                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1396                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1397                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1398
1399                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1400                 // forwarding info for local channels even if its not accepted in the network graph.
1401                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1402                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1403         }
1404 }
1405
1406 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1407         for outp in tx.output.iter() {
1408                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1409         }
1410         let mut total_value_in = 0;
1411         for input in tx.input.iter() {
1412                 total_value_in += get_output(&input.previous_output).unwrap().value;
1413         }
1414         let mut total_value_out = 0;
1415         for output in tx.output.iter() {
1416                 total_value_out += output.value;
1417         }
1418         let min_fee = (tx.weight().to_wu() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1419         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1420         assert!(total_value_out + min_fee <= total_value_in);
1421         tx.verify(get_output).unwrap();
1422 }
1423
1424 #[macro_export]
1425 macro_rules! check_spends {
1426         ($tx: expr, $($spends_txn: expr),*) => {
1427                 {
1428                         $(
1429                         for outp in $spends_txn.output.iter() {
1430                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1431                         }
1432                         )*
1433                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1434                                 $(
1435                                         if out_point.txid == $spends_txn.txid() {
1436                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1437                                         }
1438                                 )*
1439                                 None
1440                         };
1441                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1442                 }
1443         }
1444 }
1445
1446 macro_rules! get_closing_signed_broadcast {
1447         ($node: expr, $dest_pubkey: expr) => {
1448                 {
1449                         let events = $node.get_and_clear_pending_msg_events();
1450                         assert!(events.len() == 1 || events.len() == 2);
1451                         (match events[events.len() - 1] {
1452                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1453                                         assert_eq!(msg.contents.flags & 2, 2);
1454                                         msg.clone()
1455                                 },
1456                                 _ => panic!("Unexpected event"),
1457                         }, if events.len() == 2 {
1458                                 match events[0] {
1459                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1460                                                 assert_eq!(*node_id, $dest_pubkey);
1461                                                 Some(msg.clone())
1462                                         },
1463                                         _ => panic!("Unexpected event"),
1464                                 }
1465                         } else { None })
1466                 }
1467         }
1468 }
1469
1470 #[cfg(test)]
1471 macro_rules! check_warn_msg {
1472         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1473                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1474                 assert_eq!(msg_events.len(), 1);
1475                 match msg_events[0] {
1476                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1477                                 assert_eq!(node_id, $recipient_node_id);
1478                                 assert_eq!(msg.channel_id, $chan_id);
1479                                 msg.data.clone()
1480                         },
1481                         _ => panic!("Unexpected event"),
1482                 }
1483         }}
1484 }
1485
1486 /// Check that a channel's closing channel update has been broadcasted, and optionally
1487 /// check whether an error message event has occurred.
1488 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1489         let msg_events = node.node.get_and_clear_pending_msg_events();
1490         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1491         msg_events.into_iter().filter_map(|msg_event| {
1492                 match msg_event {
1493                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1494                                 assert_eq!(msg.contents.flags & 2, 2);
1495                                 None
1496                         },
1497                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1498                                 assert!(with_error_msg);
1499                                 // TODO: Check node_id
1500                                 Some(msg)
1501                         },
1502                         MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1503                                 assert!(with_error_msg);
1504                                 // TODO: Check node_id
1505                                 Some(msg.unwrap())
1506                         },
1507                         _ => panic!("Unexpected event"),
1508                 }
1509         }).collect()
1510 }
1511
1512 /// Check that a channel's closing channel update has been broadcasted, and optionally
1513 /// check whether an error message event has occurred.
1514 ///
1515 /// Don't use this, use the identically-named function instead.
1516 #[macro_export]
1517 macro_rules! check_closed_broadcast {
1518         ($node: expr, $with_error_msg: expr) => {
1519                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1520         }
1521 }
1522
1523 #[derive(Default)]
1524 pub struct ExpectedCloseEvent {
1525         pub channel_capacity_sats: Option<u64>,
1526         pub channel_id: Option<ChannelId>,
1527         pub counterparty_node_id: Option<PublicKey>,
1528         pub discard_funding: bool,
1529         pub reason: Option<ClosureReason>,
1530 }
1531
1532 /// Check that multiple channel closing events have been issued.
1533 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1534         let closed_events_count = expected_close_events.len();
1535         let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1536         let events = node.node.get_and_clear_pending_events();
1537         assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1538         for expected_event in expected_close_events {
1539                 assert!(events.iter().any(|e| matches!(
1540                         e,
1541                         Event::ChannelClosed {
1542                                 channel_id,
1543                                 reason,
1544                                 counterparty_node_id,
1545                                 channel_capacity_sats,
1546                                 ..
1547                         } if (
1548                                 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1549                                 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1550                                 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1551                                 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
1552                         )
1553                 )));
1554         }
1555         assert_eq!(events.iter().filter(|e| matches!(
1556                 e,
1557                 Event::DiscardFunding { .. },
1558         )).count(), discard_events_count);
1559 }
1560
1561 /// Check that a channel's closing channel events has been issued
1562 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1563         expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1564         let expected_events_count = if is_check_discard_funding {
1565                 2 * expected_counterparty_node_ids.len()
1566         } else {
1567                 expected_counterparty_node_ids.len()
1568         };
1569         assert_eq!(events_count, expected_events_count);
1570         let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1571                 channel_capacity_sats: Some(expected_channel_capacity),
1572                 channel_id: None,
1573                 counterparty_node_id: Some(*node_id),
1574                 discard_funding: is_check_discard_funding,
1575                 reason: Some(expected_reason.clone()),
1576         }).collect::<Vec<_>>();
1577         check_closed_events(node, expected_close_events.as_slice());
1578 }
1579
1580 /// Check that a channel's closing channel events has been issued
1581 ///
1582 /// Don't use this, use the identically-named function instead.
1583 #[macro_export]
1584 macro_rules! check_closed_event {
1585         ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1586                 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1587         };
1588         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1589                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1590                         $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1591         }
1592 }
1593
1594 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1595         let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1596         assert_eq!(events.len(), count);
1597         for event in events {
1598                 match event {
1599                         Event::BumpTransaction(bump_event) => {
1600                                 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1601                                 else { panic!(); }
1602                                 node.bump_tx_handler.handle_event(&bump_event);
1603                         },
1604                         _ => panic!(),
1605                 }
1606         }
1607 }
1608
1609 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) {
1610         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) };
1611         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) };
1612         let (tx_a, tx_b);
1613
1614         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1615         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1616
1617         let events_1 = node_b.get_and_clear_pending_msg_events();
1618         assert!(events_1.len() >= 1);
1619         let shutdown_b = match events_1[0] {
1620                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1621                         assert_eq!(node_id, &node_a.get_our_node_id());
1622                         msg.clone()
1623                 },
1624                 _ => panic!("Unexpected event"),
1625         };
1626
1627         let closing_signed_b = if !close_inbound_first {
1628                 assert_eq!(events_1.len(), 1);
1629                 None
1630         } else {
1631                 Some(match events_1[1] {
1632                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1633                                 assert_eq!(node_id, &node_a.get_our_node_id());
1634                                 msg.clone()
1635                         },
1636                         _ => panic!("Unexpected event"),
1637                 })
1638         };
1639
1640         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1641         let (as_update, bs_update) = if close_inbound_first {
1642                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1643                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1644
1645                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1646                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1647                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1648                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1649
1650                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1651                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1652                 assert!(none_a.is_none());
1653                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1654                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1655                 (as_update, bs_update)
1656         } else {
1657                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1658
1659                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1660                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1661
1662                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1663                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1664                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1665
1666                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1667                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1668                 assert!(none_b.is_none());
1669                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1670                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1671                 (as_update, bs_update)
1672         };
1673         assert_eq!(tx_a, tx_b);
1674         check_spends!(tx_a, funding_tx);
1675
1676         (as_update, bs_update, tx_a)
1677 }
1678
1679 pub struct SendEvent {
1680         pub node_id: PublicKey,
1681         pub msgs: Vec<msgs::UpdateAddHTLC>,
1682         pub commitment_msg: msgs::CommitmentSigned,
1683 }
1684 impl SendEvent {
1685         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1686                 assert!(updates.update_fulfill_htlcs.is_empty());
1687                 assert!(updates.update_fail_htlcs.is_empty());
1688                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1689                 assert!(updates.update_fee.is_none());
1690                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1691         }
1692
1693         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1694                 match event {
1695                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1696                         _ => panic!("Unexpected event type!"),
1697                 }
1698         }
1699
1700         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1701                 let mut events = node.node.get_and_clear_pending_msg_events();
1702                 assert_eq!(events.len(), 1);
1703                 SendEvent::from_event(events.pop().unwrap())
1704         }
1705 }
1706
1707 #[macro_export]
1708 /// Don't use this, use the identically-named function instead.
1709 macro_rules! expect_pending_htlcs_forwardable_conditions {
1710         ($node: expr, $expected_failures: expr) => {
1711                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1712         }
1713 }
1714
1715 #[macro_export]
1716 macro_rules! expect_htlc_handling_failed_destinations {
1717         ($events: expr, $expected_failures: expr) => {{
1718                 for event in $events {
1719                         match event {
1720                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1721                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1722                                         assert!($expected_failures.contains(&failed_next_destination))
1723                                 },
1724                                 _ => panic!("Unexpected destination"),
1725                         }
1726                 }
1727         }}
1728 }
1729
1730 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1731 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1732 /// `expected_failures` set.
1733 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1734         match events[0] {
1735                 Event::PendingHTLCsForwardable { .. } => { },
1736                 _ => panic!("Unexpected event {:?}", events),
1737         };
1738
1739         let count = expected_failures.len() + 1;
1740         assert_eq!(events.len(), count);
1741
1742         if expected_failures.len() > 0 {
1743                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1744         }
1745 }
1746
1747 #[macro_export]
1748 /// Clears (and ignores) a PendingHTLCsForwardable event
1749 ///
1750 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1751 /// set instead.
1752 macro_rules! expect_pending_htlcs_forwardable_ignore {
1753         ($node: expr) => {
1754                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1755         }
1756 }
1757
1758 #[macro_export]
1759 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1760 ///
1761 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1762 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1763         ($node: expr, $expected_failures: expr) => {
1764                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1765         }
1766 }
1767
1768 #[macro_export]
1769 /// Handles a PendingHTLCsForwardable event
1770 macro_rules! expect_pending_htlcs_forwardable {
1771         ($node: expr) => {{
1772                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1773                 $node.node.process_pending_htlc_forwards();
1774
1775                 // Ensure process_pending_htlc_forwards is idempotent.
1776                 $node.node.process_pending_htlc_forwards();
1777         }};
1778 }
1779
1780 #[macro_export]
1781 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1782 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1783         ($node: expr, $expected_failures: expr) => {{
1784                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1785                 $node.node.process_pending_htlc_forwards();
1786
1787                 // Ensure process_pending_htlc_forwards is idempotent.
1788                 $node.node.process_pending_htlc_forwards();
1789         }}
1790 }
1791
1792 #[cfg(test)]
1793 macro_rules! expect_pending_htlcs_forwardable_from_events {
1794         ($node: expr, $events: expr, $ignore: expr) => {{
1795                 assert_eq!($events.len(), 1);
1796                 match $events[0] {
1797                         Event::PendingHTLCsForwardable { .. } => { },
1798                         _ => panic!("Unexpected event"),
1799                 };
1800                 if $ignore {
1801                         $node.node.process_pending_htlc_forwards();
1802
1803                         // Ensure process_pending_htlc_forwards is idempotent.
1804                         $node.node.process_pending_htlc_forwards();
1805                 }
1806         }}
1807 }
1808
1809 #[macro_export]
1810 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1811 /// commitment update.
1812 macro_rules! commitment_signed_dance {
1813         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1814                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1815         };
1816         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1817                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1818         };
1819         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1820                 {
1821                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1822                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1823                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1824                         check_added_monitors(&$node_a, 1);
1825                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1826                         assert!(extra_msg_option.is_none());
1827                         bs_revoke_and_ack
1828                 }
1829         };
1830         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1831                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1832         };
1833         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1834                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1835         }
1836 }
1837
1838 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1839 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1840 /// `revoke_and_ack` response to it.
1841 ///
1842 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1843 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1844 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1845 /// the commitment we're exchanging. `includes_claim` provides that information.
1846 ///
1847 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1848 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1849         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1850         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1851         check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1852         extra_msg_option
1853 }
1854
1855 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1856 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1857 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1858 /// have included.
1859 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1860         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1861         check_added_monitors!(node_b, 0);
1862         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1863         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1864         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1865         check_added_monitors!(node_b, 1);
1866         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1867         let (bs_revoke_and_ack, extra_msg_option) = {
1868                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1869                 assert!(events.len() <= 2);
1870                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1871                 (match node_a_event {
1872                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1873                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1874                                 (*msg).clone()
1875                         },
1876                         _ => panic!("Unexpected event"),
1877                 }, events.get(0).map(|e| e.clone()))
1878         };
1879         check_added_monitors!(node_b, 1);
1880         if fail_backwards {
1881                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1882                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1883         }
1884         (extra_msg_option, bs_revoke_and_ack)
1885 }
1886
1887 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1888 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1889 ///
1890 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1891 /// on failure or that no new messages are left over on success.
1892 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1893         check_added_monitors!(node_a, 0);
1894         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1895         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1896         check_added_monitors!(node_a, 1);
1897
1898         // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1899         let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1900         if fail_backwards { assert!(!got_claim); }
1901         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1902
1903         if skip_last_step { return; }
1904
1905         if fail_backwards {
1906                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1907                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1908                 check_added_monitors!(node_a, 1);
1909
1910                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1911                 let mut number_of_msg_events = 0;
1912                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1913                         let peer_state = peer_state_mutex.lock().unwrap();
1914                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1915                         number_of_msg_events += cp_pending_msg_events.len();
1916                         if cp_pending_msg_events.len() == 1 {
1917                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1918                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1919                                 } else { panic!("Unexpected event"); }
1920                         }
1921                 }
1922                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1923                 assert_eq!(number_of_msg_events, 1);
1924         } else {
1925                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1926         }
1927 }
1928
1929 /// Get a payment preimage and hash.
1930 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1931         let mut payment_count = recipient.network_payment_count.borrow_mut();
1932         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1933         *payment_count += 1;
1934         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
1935         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1936         (payment_preimage, payment_hash, payment_secret)
1937 }
1938
1939 /// Get a payment preimage and hash.
1940 ///
1941 /// Don't use this, use the identically-named function instead.
1942 #[macro_export]
1943 macro_rules! get_payment_preimage_hash {
1944         ($dest_node: expr) => {
1945                 get_payment_preimage_hash!($dest_node, None)
1946         };
1947         ($dest_node: expr, $min_value_msat: expr) => {
1948                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1949         };
1950         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1951                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1952         };
1953 }
1954
1955 /// Gets a route from the given sender to the node described in `payment_params`.
1956 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1957         let scorer = TestScorer::new();
1958         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1959         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1960         router::get_route(
1961                 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1962                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1963                 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
1964         )
1965 }
1966
1967 /// Gets a route from the given sender to the node described in `payment_params`.
1968 ///
1969 /// Don't use this, use the identically-named function instead.
1970 #[macro_export]
1971 macro_rules! get_route {
1972         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1973                 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1974                 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1975         }}
1976 }
1977
1978 #[cfg(test)]
1979 #[macro_export]
1980 macro_rules! get_route_and_payment_hash {
1981         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1982                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1983                         .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
1984                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1985         }};
1986         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1987                 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
1988         }};
1989         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
1990                 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1991                 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
1992                 let (payment_preimage, payment_hash, payment_secret) =
1993                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1994                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1995                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1996         }}
1997 }
1998
1999 pub fn check_payment_claimable(
2000         event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2001         expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2002         expected_receiver_node_id: PublicKey,
2003 ) {
2004         match event {
2005                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2006                         assert_eq!(expected_payment_hash, *payment_hash);
2007                         assert_eq!(expected_recv_value, *amount_msat);
2008                         assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2009                         match purpose {
2010                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2011                                         assert_eq!(&expected_payment_preimage, payment_preimage);
2012                                         assert_eq!(expected_payment_secret, *payment_secret);
2013                                 },
2014                                 _ => {},
2015                         }
2016                 },
2017                 _ => panic!("Unexpected event"),
2018         }
2019 }
2020
2021 #[macro_export]
2022 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2023 macro_rules! expect_payment_claimable {
2024         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2025                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2026         };
2027         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2028                 let events = $node.node.get_and_clear_pending_events();
2029                 assert_eq!(events.len(), 1);
2030                 $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)
2031         };
2032 }
2033
2034 #[macro_export]
2035 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2036 macro_rules! expect_payment_claimed {
2037         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2038                 let events = $node.node.get_and_clear_pending_events();
2039                 assert_eq!(events.len(), 1);
2040                 match events[0] {
2041                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2042                                 assert_eq!($expected_payment_hash, *payment_hash);
2043                                 assert_eq!($expected_recv_value, amount_msat);
2044                         },
2045                         _ => panic!("Unexpected event"),
2046                 }
2047         }
2048 }
2049
2050 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2051         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2052         expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2053 ) {
2054         let events = node.node().get_and_clear_pending_events();
2055         let expected_payment_hash = PaymentHash(
2056                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array());
2057         if expect_per_path_claims {
2058                 assert!(events.len() > 1);
2059         } else {
2060                 assert_eq!(events.len(), 1);
2061         }
2062         if expect_post_ev_mon_update {
2063                 check_added_monitors(node, 1);
2064         }
2065         let expected_payment_id = match events[0] {
2066                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2067                         assert_eq!(expected_payment_preimage, *payment_preimage);
2068                         assert_eq!(expected_payment_hash, *payment_hash);
2069                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
2070                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
2071                         } else {
2072                                 assert!(fee_paid_msat.is_some());
2073                         }
2074                         payment_id.unwrap()
2075                 },
2076                 _ => panic!("Unexpected event"),
2077         };
2078         if expect_per_path_claims {
2079                 for i in 1..events.len() {
2080                         match events[i] {
2081                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2082                                         assert_eq!(payment_id, expected_payment_id);
2083                                         assert_eq!(payment_hash, Some(expected_payment_hash));
2084                                 },
2085                                 _ => panic!("Unexpected event"),
2086                         }
2087                 }
2088         }
2089 }
2090
2091 #[macro_export]
2092 macro_rules! expect_payment_sent {
2093         ($node: expr, $expected_payment_preimage: expr) => {
2094                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2095         };
2096         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2097                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2098         };
2099         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2100                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2101                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2102         }
2103 }
2104
2105 #[cfg(test)]
2106 #[macro_export]
2107 macro_rules! expect_payment_path_successful {
2108         ($node: expr) => {
2109                 let events = $node.node.get_and_clear_pending_events();
2110                 assert_eq!(events.len(), 1);
2111                 match events[0] {
2112                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
2113                         _ => panic!("Unexpected event"),
2114                 }
2115         }
2116 }
2117
2118 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2119         event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2120         upstream_force_closed: bool, downstream_force_closed: bool
2121 ) {
2122         match event {
2123                 Event::PaymentForwarded {
2124                         fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2125                         outbound_amount_forwarded_msat: _
2126                 } => {
2127                         assert_eq!(fee_earned_msat, expected_fee);
2128                         if !upstream_force_closed {
2129                                 // Is the event prev_channel_id in one of the channels between the two nodes?
2130                                 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()));
2131                         }
2132                         // We check for force closures since a force closed channel is removed from the
2133                         // node's channel list
2134                         if !downstream_force_closed {
2135                                 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()));
2136                         }
2137                         assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2138                 },
2139                 _ => panic!("Unexpected event"),
2140         }
2141 }
2142
2143 macro_rules! expect_payment_forwarded {
2144         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2145                 let mut events = $node.node.get_and_clear_pending_events();
2146                 assert_eq!(events.len(), 1);
2147                 $crate::ln::functional_test_utils::expect_payment_forwarded(
2148                         events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee,
2149                         $upstream_force_closed, $downstream_force_closed);
2150         }
2151 }
2152
2153 #[cfg(test)]
2154 #[macro_export]
2155 macro_rules! expect_channel_shutdown_state {
2156         ($node: expr, $chan_id: expr, $state: path) => {
2157                 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2158                 assert_eq!(chan_details.len(), 1);
2159                 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2160         }
2161 }
2162
2163 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2164 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2165         let events = node.node.get_and_clear_pending_events();
2166         assert_eq!(events.len(), 1);
2167         match &events[0] {
2168                 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2169                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2170                         *channel_id
2171                 },
2172                 _ => panic!("Unexpected event"),
2173         }
2174 }
2175
2176 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2177 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2178         let events = node.node.get_and_clear_pending_events();
2179         assert_eq!(events.len(), 1);
2180         match events[0] {
2181                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2182                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2183                 },
2184                 _ => panic!("Unexpected event"),
2185         }
2186 }
2187
2188 #[cfg(any(test, feature = "_test_utils"))]
2189 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2190         let mut events = node.node.get_and_clear_pending_events();
2191
2192         for event in events.drain(..) {
2193                 match event {
2194                         Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2195                                 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2196                                 assert!(result_idx.is_some());
2197
2198                                 probe_results.remove(result_idx.unwrap());
2199                         },
2200                         _ => panic!(),
2201                 }
2202         };
2203
2204         // Ensure that we received a ProbeSuccessful event for each probe result.
2205         assert!(probe_results.is_empty());
2206 }
2207
2208 pub struct PaymentFailedConditions<'a> {
2209         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2210         pub(crate) expected_blamed_scid: Option<u64>,
2211         pub(crate) expected_blamed_chan_closed: Option<bool>,
2212         pub(crate) expected_mpp_parts_remain: bool,
2213 }
2214
2215 impl<'a> PaymentFailedConditions<'a> {
2216         pub fn new() -> Self {
2217                 Self {
2218                         expected_htlc_error_data: None,
2219                         expected_blamed_scid: None,
2220                         expected_blamed_chan_closed: None,
2221                         expected_mpp_parts_remain: false,
2222                 }
2223         }
2224         pub fn mpp_parts_remain(mut self) -> Self {
2225                 self.expected_mpp_parts_remain = true;
2226                 self
2227         }
2228         pub fn blamed_scid(mut self, scid: u64) -> Self {
2229                 self.expected_blamed_scid = Some(scid);
2230                 self
2231         }
2232         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2233                 self.expected_blamed_chan_closed = Some(closed);
2234                 self
2235         }
2236         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2237                 self.expected_htlc_error_data = Some((code, data));
2238                 self
2239         }
2240 }
2241
2242 #[cfg(test)]
2243 macro_rules! expect_payment_failed_with_update {
2244         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2245                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2246                         &$node, $expected_payment_hash, $payment_failed_permanently,
2247                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2248                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2249         }
2250 }
2251
2252 #[cfg(test)]
2253 macro_rules! expect_payment_failed {
2254         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2255                 #[allow(unused_mut)]
2256                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2257                 $(
2258                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2259                 )*
2260                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2261         };
2262 }
2263
2264 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2265         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2266         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2267 ) {
2268         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2269         let expected_payment_id = match &payment_failed_events[0] {
2270                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2271                         #[cfg(test)]
2272                         error_code,
2273                         #[cfg(test)]
2274                         error_data, .. } => {
2275                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2276                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2277                         #[cfg(test)]
2278                         {
2279                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2280                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2281                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2282                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2283                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2284                                 }
2285                         }
2286
2287                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2288                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2289                                         match upd {
2290                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2291                                                         if let Some(scid) = conditions.expected_blamed_scid {
2292                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2293                                                         }
2294                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2295                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2296                                                 },
2297                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2298                                                         if let Some(scid) = conditions.expected_blamed_scid {
2299                                                                 assert_eq!(*short_channel_id, scid);
2300                                                         }
2301                                                         assert!(is_permanent);
2302                                                 },
2303                                                 _ => panic!("Unexpected update type"),
2304                                         }
2305                                 } else { panic!("Expected network update"); }
2306                         }
2307
2308                         payment_id.unwrap()
2309                 },
2310                 _ => panic!("Unexpected event"),
2311         };
2312         if !conditions.expected_mpp_parts_remain {
2313                 match &payment_failed_events[1] {
2314                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2315                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2316                                 assert_eq!(*payment_id, expected_payment_id);
2317                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2318                                         PaymentFailureReason::RecipientRejected
2319                                 } else {
2320                                         PaymentFailureReason::RetriesExhausted
2321                                 });
2322                         }
2323                         _ => panic!("Unexpected second event"),
2324                 }
2325         }
2326 }
2327
2328 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2329         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2330         conditions: PaymentFailedConditions<'e>
2331 ) {
2332         let events = node.node.get_and_clear_pending_events();
2333         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2334 }
2335
2336 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 {
2337         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2338         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2339                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2340         check_added_monitors!(origin_node, expected_paths.len());
2341         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2342         payment_id
2343 }
2344
2345 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2346         let origin_node_id = expected_path[0].node.get_our_node_id();
2347
2348         // iterate from the receiving node to the origin node and handle update fail htlc.
2349         for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2350                 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2351                 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2352                 check_added_monitors!(prev_node, 0);
2353
2354                 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2355                 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2356                 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2357         }
2358 }
2359
2360 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> {
2361         let mut payment_event = SendEvent::from_event(ev);
2362         let mut prev_node = origin_node;
2363         let mut event = None;
2364
2365         for (idx, &node) in expected_path.iter().enumerate() {
2366                 let is_last_hop = idx == expected_path.len() - 1;
2367                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2368
2369                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2370                 check_added_monitors!(node, 0);
2371
2372                 if is_last_hop && is_probe {
2373                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2374                 } else {
2375                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2376                         expect_pending_htlcs_forwardable!(node);
2377                 }
2378
2379                 if is_last_hop && clear_recipient_events {
2380                         let events_2 = node.node.get_and_clear_pending_events();
2381                         if payment_claimable_expected {
2382                                 assert_eq!(events_2.len(), 1);
2383                                 match &events_2[0] {
2384                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2385                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2386                                                 claim_deadline, onion_fields, ..
2387                                         } => {
2388                                                 assert_eq!(our_payment_hash, *payment_hash);
2389                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2390                                                 assert!(onion_fields.is_some());
2391                                                 match &purpose {
2392                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2393                                                                 assert_eq!(expected_preimage, *payment_preimage);
2394                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2395                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2396                                                         },
2397                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2398                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2399                                                                 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2400                                                         },
2401                                                 }
2402                                                 assert_eq!(*amount_msat, recv_value);
2403                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2404                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2405                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2406                                         },
2407                                         _ => panic!("Unexpected event"),
2408                                 }
2409                                 event = Some(events_2[0].clone());
2410                         } else {
2411                                 assert!(events_2.is_empty());
2412                         }
2413                 } else if !is_last_hop {
2414                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2415                         assert_eq!(events_2.len(), 1);
2416                         check_added_monitors!(node, 1);
2417                         payment_event = SendEvent::from_event(events_2.remove(0));
2418                         assert_eq!(payment_event.msgs.len(), 1);
2419                 }
2420
2421                 prev_node = node;
2422         }
2423         event
2424 }
2425
2426 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> {
2427         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage, false)
2428 }
2429
2430 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2431         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2432         assert_eq!(events.len(), expected_route.len());
2433
2434         check_added_monitors!(origin_node, expected_route.len());
2435
2436         for path in expected_route.iter() {
2437                 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2438
2439                 do_pass_along_path(origin_node, path, 0, PaymentHash([0_u8; 32]), None, ev, false, false, None, true);
2440                 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2441
2442                 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2443         }
2444 }
2445
2446 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) {
2447         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2448         assert_eq!(events.len(), expected_route.len());
2449
2450         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2451                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2452                 // Once we've gotten through all the HTLCs, the last one should result in a
2453                 // PaymentClaimable (but each previous one should not!).
2454                 let expect_payment = path_idx == expected_route.len() - 1;
2455                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2456         }
2457 }
2458
2459 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) {
2460         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2461         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2462         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2463 }
2464
2465 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2466         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2467         our_payment_preimage: PaymentPreimage
2468 ) -> u64 {
2469         let extra_fees = vec![0; expected_paths.len()];
2470         do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2471                 &extra_fees[..], skip_last, our_payment_preimage)
2472 }
2473
2474 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2475         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2476         &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2477 ) -> u64 {
2478         assert_eq!(expected_paths.len(), expected_extra_fees.len());
2479         for path in expected_paths.iter() {
2480                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2481         }
2482         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2483         pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2484 }
2485
2486 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 {
2487         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2488         assert_eq!(claim_event.len(), 1);
2489         match claim_event[0] {
2490                 Event::PaymentClaimed {
2491                         purpose: PaymentPurpose::SpontaneousPayment(preimage),
2492                         amount_msat,
2493                         ref htlcs,
2494                         .. }
2495                 | Event::PaymentClaimed {
2496                         purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2497                         ref htlcs,
2498                         amount_msat,
2499                         ..
2500                 } => {
2501                         assert_eq!(preimage, our_payment_preimage);
2502                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2503                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2504                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2505                 },
2506                 Event::PaymentClaimed {
2507                         purpose: PaymentPurpose::InvoicePayment { .. },
2508                         payment_hash,
2509                         amount_msat,
2510                         ref htlcs,
2511                         ..
2512                 } => {
2513                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2514                         assert_eq!(htlcs.len(), expected_paths.len());  // One per path.
2515                         assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2516                         expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2517                 }
2518                 _ => panic!(),
2519         }
2520
2521         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2522
2523         let mut expected_total_fee_msat = 0;
2524
2525         macro_rules! msgs_from_ev {
2526                 ($ev: expr) => {
2527                         match $ev {
2528                                 &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 } } => {
2529                                         assert!(update_add_htlcs.is_empty());
2530                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2531                                         assert!(update_fail_htlcs.is_empty());
2532                                         assert!(update_fail_malformed_htlcs.is_empty());
2533                                         assert!(update_fee.is_none());
2534                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2535                                 },
2536                                 _ => panic!("Unexpected event"),
2537                         }
2538                 }
2539         }
2540         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2541         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2542         assert_eq!(events.len(), expected_paths.len());
2543
2544         if events.len() == 1 {
2545                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2546         } else {
2547                 for expected_path in expected_paths.iter() {
2548                         // For MPP payments, we always want the message to the first node in the path.
2549                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2550                         per_path_msgs.push(msgs_from_ev!(&ev));
2551                 }
2552         }
2553
2554         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2555                 let mut next_msgs = Some(path_msgs);
2556                 let mut expected_next_node = next_hop;
2557
2558                 macro_rules! last_update_fulfill_dance {
2559                         ($node: expr, $prev_node: expr) => {
2560                                 {
2561                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2562                                         check_added_monitors!($node, 0);
2563                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2564                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2565                                 }
2566                         }
2567                 }
2568                 macro_rules! mid_update_fulfill_dance {
2569                         ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2570                                 {
2571                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2572                                         let mut fee = {
2573                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2574                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2575                                                         .unwrap().lock().unwrap();
2576                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2577                                                 if let Some(prev_config) = channel.context().prev_config() {
2578                                                         prev_config.forwarding_fee_base_msat
2579                                                 } else {
2580                                                         channel.context().config().forwarding_fee_base_msat
2581                                                 }
2582                                         };
2583                                         if $idx == 1 { fee += expected_extra_fees[i]; }
2584                                         expect_payment_forwarded!(*$node, $next_node, $prev_node, Some(fee as u64), false, false);
2585                                         expected_total_fee_msat += fee as u64;
2586                                         check_added_monitors!($node, 1);
2587                                         let new_next_msgs = if $new_msgs {
2588                                                 let events = $node.node.get_and_clear_pending_msg_events();
2589                                                 assert_eq!(events.len(), 1);
2590                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2591                                                 expected_next_node = nexthop;
2592                                                 Some(res)
2593                                         } else {
2594                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2595                                                 None
2596                                         };
2597                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2598                                         next_msgs = new_next_msgs;
2599                                 }
2600                         }
2601                 }
2602
2603                 let mut prev_node = expected_route.last().unwrap();
2604                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2605                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2606                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2607                         if next_msgs.is_some() {
2608                                 // Since we are traversing in reverse, next_node is actually the previous node
2609                                 let next_node: &Node;
2610                                 if idx == expected_route.len() - 1 {
2611                                         next_node = origin_node;
2612                                 } else {
2613                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2614                                 }
2615                                 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2616                         } else {
2617                                 assert!(!update_next_msgs);
2618                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2619                         }
2620                         if !skip_last && idx == expected_route.len() - 1 {
2621                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2622                         }
2623
2624                         prev_node = node;
2625                 }
2626
2627                 if !skip_last {
2628                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2629                 }
2630         }
2631
2632         // Ensure that claim_funds is idempotent.
2633         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2634         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2635         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2636
2637         expected_total_fee_msat
2638 }
2639 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) {
2640         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2641         if !skip_last {
2642                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2643         }
2644 }
2645
2646 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2647         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2648 }
2649
2650 pub const TEST_FINAL_CLTV: u32 = 70;
2651
2652 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) {
2653         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2654                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2655         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2656         let route = get_route(origin_node, &route_params).unwrap();
2657         assert_eq!(route.paths.len(), 1);
2658         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2659         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2660                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2661         }
2662
2663         let res = send_along_route(origin_node, route, expected_route, recv_value);
2664         (res.0, res.1, res.2, res.3)
2665 }
2666
2667 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2668         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2669                 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2670         let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2671         let network_graph = origin_node.network_graph.read_only();
2672         let scorer = test_utils::TestScorer::new();
2673         let seed = [0u8; 32];
2674         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2675         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2676         let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2677                 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2678         assert_eq!(route.paths.len(), 1);
2679         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2680         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2681                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2682         }
2683
2684         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2685         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2686                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2687                 true, APIError::ChannelUnavailable { ref err },
2688                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2689 }
2690
2691 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) {
2692         let res = route_payment(&origin, expected_route, recv_value);
2693         claim_payment(&origin, expected_route, res.0);
2694         res
2695 }
2696
2697 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) {
2698         for path in expected_paths.iter() {
2699                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2700         }
2701         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2702         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2703         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2704
2705         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2706 }
2707
2708 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) {
2709         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2710         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2711
2712         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2713         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2714         assert_eq!(events.len(), expected_paths.len());
2715         for ev in events.iter() {
2716                 let (update_fail, commitment_signed, node_id) = match ev {
2717                         &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 } } => {
2718                                 assert!(update_add_htlcs.is_empty());
2719                                 assert!(update_fulfill_htlcs.is_empty());
2720                                 assert_eq!(update_fail_htlcs.len(), 1);
2721                                 assert!(update_fail_malformed_htlcs.is_empty());
2722                                 assert!(update_fee.is_none());
2723                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2724                         },
2725                         _ => panic!("Unexpected event"),
2726                 };
2727                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2728         }
2729         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2730         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()));
2731
2732         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2733                 let mut next_msgs = Some(path_msgs);
2734                 let mut expected_next_node = next_hop;
2735                 let mut prev_node = expected_route.last().unwrap();
2736
2737                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2738                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2739                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2740                         if next_msgs.is_some() {
2741                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2742                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2743                                 if !update_next_node {
2744                                         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 }]);
2745                                 }
2746                         }
2747                         let events = node.node.get_and_clear_pending_msg_events();
2748                         if update_next_node {
2749                                 assert_eq!(events.len(), 1);
2750                                 match events[0] {
2751                                         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 } } => {
2752                                                 assert!(update_add_htlcs.is_empty());
2753                                                 assert!(update_fulfill_htlcs.is_empty());
2754                                                 assert_eq!(update_fail_htlcs.len(), 1);
2755                                                 assert!(update_fail_malformed_htlcs.is_empty());
2756                                                 assert!(update_fee.is_none());
2757                                                 expected_next_node = node_id.clone();
2758                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2759                                         },
2760                                         _ => panic!("Unexpected event"),
2761                                 }
2762                         } else {
2763                                 assert!(events.is_empty());
2764                         }
2765                         if !skip_last && idx == expected_route.len() - 1 {
2766                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2767                         }
2768
2769                         prev_node = node;
2770                 }
2771
2772                 if !skip_last {
2773                         let prev_node = expected_route.first().unwrap();
2774                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2775                         check_added_monitors!(origin_node, 0);
2776                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2777                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2778                         let events = origin_node.node.get_and_clear_pending_events();
2779                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2780
2781                         let expected_payment_id = match events[0] {
2782                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2783                                         assert_eq!(payment_hash, our_payment_hash);
2784                                         assert!(payment_failed_permanently);
2785                                         for (idx, hop) in expected_route.iter().enumerate() {
2786                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2787                                         }
2788                                         payment_id.unwrap()
2789                                 },
2790                                 _ => panic!("Unexpected event"),
2791                         };
2792                         if i == expected_paths.len() - 1 {
2793                                 match events[1] {
2794                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2795                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2796                                                 assert_eq!(*payment_id, expected_payment_id);
2797                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2798                                         }
2799                                         _ => panic!("Unexpected second event"),
2800                                 }
2801                         }
2802                 }
2803         }
2804
2805         // Ensure that fail_htlc_backwards is idempotent.
2806         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2807         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2808         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2809         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2810 }
2811
2812 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2813         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2814 }
2815
2816 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2817         let mut chan_mon_cfgs = Vec::new();
2818         for i in 0..node_count {
2819                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2820                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2821                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2822                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2823                 let persister = test_utils::TestPersister::new();
2824                 let seed = [i as u8; 32];
2825                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2826                 let scorer = RwLock::new(test_utils::TestScorer::new());
2827
2828                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2829         }
2830
2831         chan_mon_cfgs
2832 }
2833
2834 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2835         create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2836 }
2837
2838 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>> {
2839         let mut nodes = Vec::new();
2840
2841         for i in 0..node_count {
2842                 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);
2843                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2844                 let seed = [i as u8; 32];
2845                 nodes.push(NodeCfg {
2846                         chain_source: &chanmon_cfgs[i].chain_source,
2847                         logger: &chanmon_cfgs[i].logger,
2848                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2849                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2850                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2851                         chain_monitor,
2852                         keys_manager: &chanmon_cfgs[i].keys_manager,
2853                         node_seed: seed,
2854                         network_graph,
2855                         override_init_features: Rc::new(RefCell::new(None)),
2856                 });
2857         }
2858
2859         nodes
2860 }
2861
2862 pub fn test_default_channel_config() -> UserConfig {
2863         let mut default_config = UserConfig::default();
2864         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2865         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2866         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2867         default_config.channel_handshake_config.announced_channel = true;
2868         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2869         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2870         // It now defaults to 1, so we simply set it to the expected value here.
2871         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2872         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2873         // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2874         // feerate of 253).
2875         default_config.channel_config.max_dust_htlc_exposure =
2876                 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2877         default_config
2878 }
2879
2880 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>> {
2881         let mut chanmgrs = Vec::new();
2882         for i in 0..node_count {
2883                 let network = Network::Testnet;
2884                 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2885                 let params = ChainParameters {
2886                         network,
2887                         best_block: BestBlock::from_network(network),
2888                 };
2889                 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,
2890                         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);
2891                 chanmgrs.push(node);
2892         }
2893
2894         chanmgrs
2895 }
2896
2897 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>> {
2898         let mut nodes = Vec::new();
2899         let chan_count = Rc::new(RefCell::new(0));
2900         let payment_count = Rc::new(RefCell::new(0));
2901         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2902
2903         for i in 0..node_count {
2904                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2905                 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2906                 nodes.push(Node{
2907                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2908                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2909                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2910                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2911                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2912                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2913                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2914                         connect_style: Rc::clone(&connect_style),
2915                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2916                         wallet_source: Arc::clone(&wallet_source),
2917                         bump_tx_handler: BumpTransactionEventHandler::new(
2918                                 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2919                                 &cfgs[i].keys_manager, cfgs[i].logger,
2920                         ),
2921                 })
2922         }
2923
2924         for i in 0..node_count {
2925                 for j in (i+1)..node_count {
2926                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2927                                 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2928                                 networks: None,
2929                                 remote_network_address: None,
2930                         }, true).unwrap();
2931                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2932                                 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2933                                 networks: None,
2934                                 remote_network_address: None,
2935                         }, false).unwrap();
2936                 }
2937         }
2938
2939         nodes
2940 }
2941
2942 // Note that the following only works for CLTV values up to 128
2943 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2944 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2945
2946 #[derive(PartialEq)]
2947 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2948 /// Tests that the given node has broadcast transactions for the given Channel
2949 ///
2950 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2951 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2952 /// broadcast and the revoked outputs were claimed.
2953 ///
2954 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2955 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2956 ///
2957 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2958 /// also fail.
2959 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>  {
2960         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2961         let mut txn_seen = HashSet::new();
2962         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2963         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2964
2965         let mut res = Vec::with_capacity(2);
2966         node_txn.retain(|tx| {
2967                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2968                         check_spends!(tx, chan.3);
2969                         if commitment_tx.is_none() {
2970                                 res.push(tx.clone());
2971                         }
2972                         false
2973                 } else { true }
2974         });
2975         if let Some(explicit_tx) = commitment_tx {
2976                 res.push(explicit_tx.clone());
2977         }
2978
2979         assert_eq!(res.len(), 1);
2980
2981         if has_htlc_tx != HTLCType::NONE {
2982                 node_txn.retain(|tx| {
2983                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2984                                 check_spends!(tx, res[0]);
2985                                 if has_htlc_tx == HTLCType::TIMEOUT {
2986                                         assert_ne!(tx.lock_time, LockTime::ZERO);
2987                                 } else {
2988                                         assert_eq!(tx.lock_time, LockTime::ZERO);
2989                                 }
2990                                 res.push(tx.clone());
2991                                 false
2992                         } else { true }
2993                 });
2994                 assert!(res.len() == 2 || res.len() == 3);
2995                 if res.len() == 3 {
2996                         assert_eq!(res[1], res[2]);
2997                 }
2998         }
2999
3000         assert!(node_txn.is_empty());
3001         res
3002 }
3003
3004 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3005 /// HTLC transaction.
3006 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
3007         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3008         // We may issue multiple claiming transaction on revoked outputs due to block rescan
3009         // for revoked htlc outputs
3010         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3011         node_txn.retain(|tx| {
3012                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3013                         check_spends!(tx, revoked_tx);
3014                         false
3015                 } else { true }
3016         });
3017         node_txn.retain(|tx| {
3018                 check_spends!(tx, commitment_revoked_tx);
3019                 false
3020         });
3021         assert!(node_txn.is_empty());
3022 }
3023
3024 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
3025         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3026         let mut txn_seen = HashSet::new();
3027         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3028
3029         let mut found_prev = false;
3030         for prev_tx in prev_txn {
3031                 for tx in &*node_txn {
3032                         if tx.input[0].previous_output.txid == prev_tx.txid() {
3033                                 check_spends!(tx, prev_tx);
3034                                 let mut iter = tx.input[0].witness.iter();
3035                                 iter.next().expect("expected 3 witness items");
3036                                 iter.next().expect("expected 3 witness items");
3037                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3038                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3039
3040                                 found_prev = true;
3041                                 break;
3042                         }
3043                 }
3044         }
3045         assert!(found_prev);
3046
3047         let mut res = Vec::new();
3048         mem::swap(&mut *node_txn, &mut res);
3049         res
3050 }
3051
3052 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)  {
3053         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3054         assert_eq!(events_1.len(), 2);
3055         let as_update = match events_1[0] {
3056                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3057                         msg.clone()
3058                 },
3059                 _ => panic!("Unexpected event"),
3060         };
3061         match events_1[1] {
3062                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3063                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3064                         assert_eq!(msg.data, expected_error);
3065                         if needs_err_handle {
3066                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3067                         }
3068                 },
3069                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3070                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
3071                         assert_eq!(msg.as_ref().unwrap().data, expected_error);
3072                         if needs_err_handle {
3073                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3074                         }
3075                 },
3076                 _ => panic!("Unexpected event"),
3077         }
3078
3079         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3080         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3081         let bs_update = match events_2[0] {
3082                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3083                         msg.clone()
3084                 },
3085                 _ => panic!("Unexpected event"),
3086         };
3087         if !needs_err_handle {
3088                 match events_2[1] {
3089                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3090                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3091                                 assert_eq!(msg.data, expected_error);
3092                         },
3093                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3094                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3095                                 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3096                         },
3097                         _ => panic!("Unexpected event"),
3098                 }
3099         }
3100
3101         for node in nodes {
3102                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3103                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3104         }
3105 }
3106
3107 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
3108         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3109 }
3110
3111 #[cfg(test)]
3112 macro_rules! get_channel_value_stat {
3113         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3114                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3115                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3116                 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3117                         |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3118                 ).flatten().unwrap();
3119                 chan.get_value_stat()
3120         }}
3121 }
3122
3123 macro_rules! get_chan_reestablish_msgs {
3124         ($src_node: expr, $dst_node: expr) => {
3125                 {
3126                         let mut announcements = $crate::prelude::HashSet::new();
3127                         let mut res = Vec::with_capacity(1);
3128                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
3129                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3130                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3131                                         res.push(msg.clone());
3132                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3133                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3134                                         announcements.insert(msg.contents.short_channel_id);
3135                                 } else {
3136                                         panic!("Unexpected event")
3137                                 }
3138                         }
3139                         assert!(announcements.is_empty());
3140                         res
3141                 }
3142         }
3143 }
3144
3145 macro_rules! handle_chan_reestablish_msgs {
3146         ($src_node: expr, $dst_node: expr) => {
3147                 {
3148                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3149                         let mut idx = 0;
3150                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3151                                 idx += 1;
3152                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3153                                 Some(msg.clone())
3154                         } else {
3155                                 None
3156                         };
3157
3158                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3159                                 idx += 1;
3160                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3161                         }
3162
3163                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3164                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3165                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3166                                 idx += 1;
3167                                 had_channel_update = true;
3168                         }
3169
3170                         let mut revoke_and_ack = None;
3171                         let mut commitment_update = None;
3172                         let order = if let Some(ev) = msg_events.get(idx) {
3173                                 match ev {
3174                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3175                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3176                                                 revoke_and_ack = Some(msg.clone());
3177                                                 idx += 1;
3178                                                 RAACommitmentOrder::RevokeAndACKFirst
3179                                         },
3180                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3181                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3182                                                 commitment_update = Some(updates.clone());
3183                                                 idx += 1;
3184                                                 RAACommitmentOrder::CommitmentFirst
3185                                         },
3186                                         _ => RAACommitmentOrder::CommitmentFirst,
3187                                 }
3188                         } else {
3189                                 RAACommitmentOrder::CommitmentFirst
3190                         };
3191
3192                         if let Some(ev) = msg_events.get(idx) {
3193                                 match ev {
3194                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3195                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3196                                                 assert!(revoke_and_ack.is_none());
3197                                                 revoke_and_ack = Some(msg.clone());
3198                                                 idx += 1;
3199                                         },
3200                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3201                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3202                                                 assert!(commitment_update.is_none());
3203                                                 commitment_update = Some(updates.clone());
3204                                                 idx += 1;
3205                                         },
3206                                         _ => {},
3207                                 }
3208                         }
3209
3210                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3211                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3212                                 idx += 1;
3213                                 assert!(!had_channel_update);
3214                         }
3215
3216                         assert_eq!(msg_events.len(), idx);
3217
3218                         (channel_ready, revoke_and_ack, commitment_update, order)
3219                 }
3220         }
3221 }
3222
3223 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3224         pub node_a: &'a Node<'b, 'c, 'd>,
3225         pub node_b: &'a Node<'b, 'c, 'd>,
3226         pub send_channel_ready: (bool, bool),
3227         pub pending_responding_commitment_signed: (bool, bool),
3228         /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3229         /// and no monitor update is expected
3230         pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3231         pub pending_htlc_adds: (usize, usize),
3232         pub pending_htlc_claims: (usize, usize),
3233         pub pending_htlc_fails: (usize, usize),
3234         pub pending_cell_htlc_claims: (usize, usize),
3235         pub pending_cell_htlc_fails: (usize, usize),
3236         pub pending_raa: (bool, bool),
3237 }
3238
3239 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3240         pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3241                 Self {
3242                         node_a,
3243                         node_b,
3244                         send_channel_ready: (false, false),
3245                         pending_responding_commitment_signed: (false, false),
3246                         pending_responding_commitment_signed_dup_monitor: (false, false),
3247                         pending_htlc_adds: (0, 0),
3248                         pending_htlc_claims: (0, 0),
3249                         pending_htlc_fails: (0, 0),
3250                         pending_cell_htlc_claims: (0, 0),
3251                         pending_cell_htlc_fails: (0, 0),
3252                         pending_raa: (false, false),
3253                 }
3254         }
3255 }
3256
3257 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3258 /// for claims/fails they are separated out.
3259 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3260         let ReconnectArgs {
3261                 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3262                 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3263                 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3264         } = args;
3265         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3266                 features: node_b.node.init_features(), networks: None, remote_network_address: None
3267         }, true).unwrap();
3268         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3269         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3270                 features: node_a.node.init_features(), networks: None, remote_network_address: None
3271         }, false).unwrap();
3272         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3273
3274         if send_channel_ready.0 {
3275                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3276                 // from b
3277                 for reestablish in reestablish_1.iter() {
3278                         let n = reestablish.next_remote_commitment_number;
3279                         assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3280                 }
3281         }
3282         if send_channel_ready.1 {
3283                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3284                 // from a
3285                 for reestablish in reestablish_2.iter() {
3286                         let n = reestablish.next_remote_commitment_number;
3287                         assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3288                 }
3289         }
3290         if send_channel_ready.0 || send_channel_ready.1 {
3291                 // If we expect any channel_ready's, both sides better have set
3292                 // next_holder_commitment_number to 1
3293                 for reestablish in reestablish_1.iter() {
3294                         let n = reestablish.next_local_commitment_number;
3295                         assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3296                 }
3297                 for reestablish in reestablish_2.iter() {
3298                         let n = reestablish.next_local_commitment_number;
3299                         assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3300                 }
3301         }
3302
3303         let mut resp_1 = Vec::new();
3304         for msg in reestablish_1 {
3305                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3306                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3307         }
3308         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3309                 check_added_monitors!(node_b, 1);
3310         } else {
3311                 check_added_monitors!(node_b, 0);
3312         }
3313
3314         let mut resp_2 = Vec::new();
3315         for msg in reestablish_2 {
3316                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3317                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3318         }
3319         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3320                 check_added_monitors!(node_a, 1);
3321         } else {
3322                 check_added_monitors!(node_a, 0);
3323         }
3324
3325         // We don't yet support both needing updates, as that would require a different commitment dance:
3326         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3327                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3328                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3329                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3330
3331         for chan_msgs in resp_1.drain(..) {
3332                 if send_channel_ready.0 {
3333                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3334                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3335                         if !announcement_event.is_empty() {
3336                                 assert_eq!(announcement_event.len(), 1);
3337                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3338                                         //TODO: Test announcement_sigs re-sending
3339                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3340                         }
3341                 } else {
3342                         assert!(chan_msgs.0.is_none());
3343                 }
3344                 if pending_raa.0 {
3345                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3346                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3347                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3348                         check_added_monitors!(node_a, 1);
3349                 } else {
3350                         assert!(chan_msgs.1.is_none());
3351                 }
3352                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3353                         pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3354                         pending_responding_commitment_signed.0
3355                 {
3356                         let commitment_update = chan_msgs.2.unwrap();
3357                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3358                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3359                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3360                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3361                         for update_add in commitment_update.update_add_htlcs {
3362                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3363                         }
3364                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3365                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3366                         }
3367                         for update_fail in commitment_update.update_fail_htlcs {
3368                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3369                         }
3370
3371                         if !pending_responding_commitment_signed.0 {
3372                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3373                         } else {
3374                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3375                                 check_added_monitors!(node_a, 1);
3376                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3377                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3378                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3379                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3380                                 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3381                         }
3382                 } else {
3383                         assert!(chan_msgs.2.is_none());
3384                 }
3385         }
3386
3387         for chan_msgs in resp_2.drain(..) {
3388                 if send_channel_ready.1 {
3389                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3390                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3391                         if !announcement_event.is_empty() {
3392                                 assert_eq!(announcement_event.len(), 1);
3393                                 match announcement_event[0] {
3394                                         MessageSendEvent::SendChannelUpdate { .. } => {},
3395                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3396                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3397                                 }
3398                         }
3399                 } else {
3400                         assert!(chan_msgs.0.is_none());
3401                 }
3402                 if pending_raa.1 {
3403                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3404                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3405                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3406                         check_added_monitors!(node_b, 1);
3407                 } else {
3408                         assert!(chan_msgs.1.is_none());
3409                 }
3410                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3411                         pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3412                         pending_responding_commitment_signed.1
3413                 {
3414                         let commitment_update = chan_msgs.2.unwrap();
3415                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3416                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3417                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3418                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3419                         for update_add in commitment_update.update_add_htlcs {
3420                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3421                         }
3422                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3423                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3424                         }
3425                         for update_fail in commitment_update.update_fail_htlcs {
3426                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3427                         }
3428
3429                         if !pending_responding_commitment_signed.1 {
3430                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3431                         } else {
3432                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3433                                 check_added_monitors!(node_b, 1);
3434                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3435                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3436                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3437                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3438                                 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3439                         }
3440                 } else {
3441                         assert!(chan_msgs.2.is_none());
3442                 }
3443         }
3444 }
3445
3446 /// Initiates channel opening and creates a single batch funding transaction.
3447 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3448 /// transaction with corresponding funding_created messages.
3449 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3450         funding_node: &Node<'a, 'b, 'c>,
3451         params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3452 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3453         let mut tx_outs = Vec::new();
3454         let mut temp_chan_ids = Vec::new();
3455         let mut funding_created_msgs = Vec::new();
3456
3457         for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3458                 // Initialize channel opening.
3459                 let temp_chan_id = funding_node.node.create_channel(
3460                         other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3461                         None,
3462                         *override_config,
3463                 ).unwrap();
3464                 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3465                 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3466                 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3467                 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3468
3469                 // Create the corresponding funding output.
3470                 let events = funding_node.node.get_and_clear_pending_events();
3471                 assert_eq!(events.len(), 1);
3472                 match events[0] {
3473                         Event::FundingGenerationReady {
3474                                 ref temporary_channel_id,
3475                                 ref counterparty_node_id,
3476                                 channel_value_satoshis: ref event_channel_value_satoshis,
3477                                 ref output_script,
3478                                 user_channel_id: ref event_user_channel_id
3479                         } => {
3480                                 assert_eq!(temporary_channel_id, &temp_chan_id);
3481                                 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3482                                 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3483                                 assert_eq!(user_channel_id, event_user_channel_id);
3484                                 tx_outs.push(TxOut {
3485                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3486                                 });
3487                         },
3488                         _ => panic!("Unexpected event"),
3489                 };
3490                 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3491         }
3492
3493         // Compose the batch funding transaction and give it to the ChannelManager.
3494         let tx = Transaction {
3495                 version: 2,
3496                 lock_time: LockTime::ZERO,
3497                 input: Vec::new(),
3498                 output: tx_outs,
3499         };
3500         assert!(funding_node.node.batch_funding_transaction_generated(
3501                 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3502                 tx.clone(),
3503         ).is_ok());
3504         check_added_monitors!(funding_node, 0);
3505         let events = funding_node.node.get_and_clear_pending_msg_events();
3506         assert_eq!(events.len(), params.len());
3507         for (other_node, ..) in params {
3508                 let funding_created = events
3509                         .iter()
3510                         .find_map(|event| match event {
3511                                 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3512                                 _ => None,
3513                         })
3514                         .unwrap();
3515                 funding_created_msgs.push(funding_created);
3516         }
3517         return (tx, funding_created_msgs);
3518 }