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

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