git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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