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