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

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