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

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