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