_ 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::{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 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> {
 937         let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
 938         for encoded in monitors_encoded {
 939                 let mut monitor_read = &encoded[..];
 940                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
 941                         ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
 942                 assert!(monitor_read.is_empty());
 943                 monitors_read.push(monitor);
 944         }
 945
 946         let mut node_read = &chanman_encoded[..];
 947         let (_, node_deserialized) = {
 948                 let mut channel_monitors = HashMap::new();
 949                 for monitor in monitors_read.iter_mut() {
 950                         assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
 951                 }
 952                 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
 953                         default_config,
 954                         entropy_source: node.keys_manager,
 955                         node_signer: node.keys_manager,
 956                         signer_provider: node.keys_manager,
 957                         fee_estimator: node.fee_estimator,
 958                         router: node.router,
 959                         chain_monitor: node.chain_monitor,
 960                         tx_broadcaster: node.tx_broadcaster,
 961                         logger: node.logger,
 962                         channel_monitors,
 963                 }).unwrap()
 964         };
 965         assert!(node_read.is_empty());
 966
 967         for monitor in monitors_read.drain(..) {
 968                 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
 969                         ChannelMonitorUpdateStatus::Completed);
 970                 check_added_monitors!(node, 1);
 971         }
 972
 973         node_deserialized
 974 }
 975
 976 #[cfg(test)]
 977 macro_rules! reload_node {
 978         ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
 979                 let chanman_encoded = $chanman_encoded;
 980
 981                 $persister = test_utils::TestPersister::new();
 982                 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
 983                 $node.chain_monitor = &$new_chain_monitor;
 984
 985                 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
 986                 $node.node = &$new_channelmanager;
 987         };
 988         ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
 989                 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
 990         };
 991 }
 992
 993 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) {
 994         let chan_id = *node.network_chan_count.borrow();
 995
 996         let events = node.node.get_and_clear_pending_events();
 997         assert_eq!(events.len(), 1);
 998         match events[0] {
 999                 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1000                         assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1001                         assert_eq!(*channel_value_satoshis, expected_chan_value);
1002                         assert_eq!(user_channel_id, expected_user_chan_id);
1003
1004                         let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
1005                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1006                         }]};
1007                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1008                         (*temporary_channel_id, tx, funding_outpoint)
1009                 },
1010                 _ => panic!("Unexpected event"),
1011         }
1012 }
1013 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 {
1014         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1015         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1016
1017         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1018         check_added_monitors!(node_a, 0);
1019
1020         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1021         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1022         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1023         {
1024                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1025                 assert_eq!(added_monitors.len(), 1);
1026                 assert_eq!(added_monitors[0].0, funding_output);
1027                 added_monitors.clear();
1028         }
1029         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1030
1031         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()));
1032         {
1033                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1034                 assert_eq!(added_monitors.len(), 1);
1035                 assert_eq!(added_monitors[0].0, funding_output);
1036                 added_monitors.clear();
1037         }
1038         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1039
1040         let events_4 = node_a.node.get_and_clear_pending_events();
1041         assert_eq!(events_4.len(), 0);
1042
1043         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1044         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1045         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1046
1047         // Ensure that funding_transaction_generated is idempotent.
1048         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1049         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1050         check_added_monitors!(node_a, 0);
1051
1052         tx
1053 }
1054
1055 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1056 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]) {
1057         let initiator_channels = initiator.node.list_usable_channels().len();
1058         let receiver_channels = receiver.node.list_usable_channels().len();
1059
1060         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1061         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1062
1063         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1064         let events = receiver.node.get_and_clear_pending_events();
1065         assert_eq!(events.len(), 1);
1066         match events[0] {
1067                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1068                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1069                 },
1070                 _ => panic!("Unexpected event"),
1071         };
1072
1073         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1074         assert_eq!(accept_channel.minimum_depth, 0);
1075         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1076
1077         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1078         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1079         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1080
1081         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1082         check_added_monitors!(receiver, 1);
1083         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1084         assert_eq!(bs_signed_locked.len(), 2);
1085         let as_channel_ready;
1086         match &bs_signed_locked[0] {
1087                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1088                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1089                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1090                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1091                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1092                         check_added_monitors!(initiator, 1);
1093
1094                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1095                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1096
1097                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1098                 }
1099                 _ => panic!("Unexpected event"),
1100         }
1101         match &bs_signed_locked[1] {
1102                 MessageSendEvent::SendChannelReady { node_id, msg } => {
1103                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1104                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1105                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1106                 }
1107                 _ => panic!("Unexpected event"),
1108         }
1109
1110         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1111         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1112
1113         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1114         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1115
1116         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1117         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1118
1119         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1120         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1121
1122         (tx, as_channel_ready.channel_id)
1123 }
1124
1125 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 {
1126         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1127         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1128         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1129         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1130         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1131         if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1132                 let events = node_b.node.get_and_clear_pending_events();
1133                 assert_eq!(events.len(), 1);
1134                 match &events[0] {
1135                         Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1136                                 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1137                         _ => panic!("Unexpected event"),
1138                 };
1139         }
1140         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1141         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1142         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1143         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1144
1145         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1146 }
1147
1148 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) {
1149         confirm_transaction_at(node_conf, tx, conf_height);
1150         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1151         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()));
1152 }
1153
1154 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]) {
1155         let channel_id;
1156         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1157         assert_eq!(events_6.len(), 3);
1158         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1159                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1160                 2
1161         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1162                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1163                 1
1164         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1165         ((match events_6[0] {
1166                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1167                         channel_id = msg.channel_id.clone();
1168                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1169                         msg.clone()
1170                 },
1171                 _ => panic!("Unexpected event"),
1172         }, match events_6[announcement_sigs_idx] {
1173                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1174                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1175                         msg.clone()
1176                 },
1177                 _ => panic!("Unexpected event"),
1178         }), channel_id)
1179 }
1180
1181 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]) {
1182         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1183         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1184         confirm_transaction_at(node_a, tx, conf_height);
1185         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1186         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1187         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1188 }
1189
1190 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) {
1191         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1192         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1193         (msgs, chan_id, tx)
1194 }
1195
1196 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) {
1197         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1198         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1199         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1200
1201         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1202         assert_eq!(events_7.len(), 1);
1203         let (announcement, bs_update) = match events_7[0] {
1204                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1205                         (msg, update_msg.clone().unwrap())
1206                 },
1207                 _ => panic!("Unexpected event"),
1208         };
1209
1210         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1211         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1212         assert_eq!(events_8.len(), 1);
1213         let as_update = match events_8[0] {
1214                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1215                         assert!(*announcement == *msg);
1216                         let update_msg = update_msg.clone().unwrap();
1217                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1218                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1219                         update_msg
1220                 },
1221                 _ => panic!("Unexpected event"),
1222         };
1223
1224         *node_a.network_chan_count.borrow_mut() += 1;
1225
1226         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1227         ((*announcement).clone(), as_update, bs_update)
1228 }
1229
1230 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) {
1231         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1232 }
1233
1234 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) {
1235         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1236         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1237         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1238 }
1239
1240 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) {
1241         let mut no_announce_cfg = test_default_channel_config();
1242         no_announce_cfg.channel_handshake_config.announced_channel = false;
1243         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1244         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1245         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1246         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1247         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1248
1249         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1250         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1251         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()));
1252         check_added_monitors!(nodes[b], 1);
1253
1254         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1255         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1256
1257         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1258         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1259         check_added_monitors!(nodes[a], 1);
1260
1261         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1262         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1263         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1264
1265         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1266         confirm_transaction_at(&nodes[a], &tx, conf_height);
1267         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1268         confirm_transaction_at(&nodes[b], &tx, conf_height);
1269         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1270         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1271         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()));
1272         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1273         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1274         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1275         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1276         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1277
1278         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1279         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1280
1281         let mut found_a = false;
1282         for chan in nodes[a].node.list_usable_channels() {
1283                 if chan.channel_id == as_channel_ready.channel_id {
1284                         assert!(!found_a);
1285                         found_a = true;
1286                         assert!(!chan.is_public);
1287                 }
1288         }
1289         assert!(found_a);
1290
1291         let mut found_b = false;
1292         for chan in nodes[b].node.list_usable_channels() {
1293                 if chan.channel_id == as_channel_ready.channel_id {
1294                         assert!(!found_b);
1295                         found_b = true;
1296                         assert!(!chan.is_public);
1297                 }
1298         }
1299         assert!(found_b);
1300
1301         (as_channel_ready, tx)
1302 }
1303
1304 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) {
1305         for node in nodes {
1306                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1307                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1308                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1309
1310                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1311                 // forwarding info for local channels even if its not accepted in the network graph.
1312                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1313                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1314         }
1315 }
1316
1317 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1318         for outp in tx.output.iter() {
1319                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1320         }
1321         let mut total_value_in = 0;
1322         for input in tx.input.iter() {
1323                 total_value_in += get_output(&input.previous_output).unwrap().value;
1324         }
1325         let mut total_value_out = 0;
1326         for output in tx.output.iter() {
1327                 total_value_out += output.value;
1328         }
1329         let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1330         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1331         assert!(total_value_out + min_fee <= total_value_in);
1332         tx.verify(get_output).unwrap();
1333 }
1334
1335 #[macro_export]
1336 macro_rules! check_spends {
1337         ($tx: expr, $($spends_txn: expr),*) => {
1338                 {
1339                         $(
1340                         for outp in $spends_txn.output.iter() {
1341                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1342                         }
1343                         )*
1344                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1345                                 $(
1346                                         if out_point.txid == $spends_txn.txid() {
1347                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1348                                         }
1349                                 )*
1350                                 None
1351                         };
1352                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1353                 }
1354         }
1355 }
1356
1357 macro_rules! get_closing_signed_broadcast {
1358         ($node: expr, $dest_pubkey: expr) => {
1359                 {
1360                         let events = $node.get_and_clear_pending_msg_events();
1361                         assert!(events.len() == 1 || events.len() == 2);
1362                         (match events[events.len() - 1] {
1363                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1364                                         assert_eq!(msg.contents.flags & 2, 2);
1365                                         msg.clone()
1366                                 },
1367                                 _ => panic!("Unexpected event"),
1368                         }, if events.len() == 2 {
1369                                 match events[0] {
1370                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1371                                                 assert_eq!(*node_id, $dest_pubkey);
1372                                                 Some(msg.clone())
1373                                         },
1374                                         _ => panic!("Unexpected event"),
1375                                 }
1376                         } else { None })
1377                 }
1378         }
1379 }
1380
1381 #[cfg(test)]
1382 macro_rules! check_warn_msg {
1383         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1384                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1385                 assert_eq!(msg_events.len(), 1);
1386                 match msg_events[0] {
1387                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1388                                 assert_eq!(node_id, $recipient_node_id);
1389                                 assert_eq!(msg.channel_id, $chan_id);
1390                                 msg.data.clone()
1391                         },
1392                         _ => panic!("Unexpected event"),
1393                 }
1394         }}
1395 }
1396
1397 /// Check that a channel's closing channel update has been broadcasted, and optionally
1398 /// check whether an error message event has occurred.
1399 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1400         let msg_events = node.node.get_and_clear_pending_msg_events();
1401         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1402         msg_events.into_iter().filter_map(|msg_event| {
1403                 match msg_event {
1404                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1405                                 assert_eq!(msg.contents.flags & 2, 2);
1406                                 None
1407                         },
1408                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1409                                 assert!(with_error_msg);
1410                                 // TODO: Check node_id
1411                                 Some(msg.clone())
1412                         },
1413                         _ => panic!("Unexpected event"),
1414                 }
1415         }).collect()
1416 }
1417
1418 /// Check that a channel's closing channel update has been broadcasted, and optionally
1419 /// check whether an error message event has occurred.
1420 ///
1421 /// Don't use this, use the identically-named function instead.
1422 #[macro_export]
1423 macro_rules! check_closed_broadcast {
1424         ($node: expr, $with_error_msg: expr) => {
1425                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1426         }
1427 }
1428
1429 /// Check that a channel's closing channel events has been issued
1430 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1431         expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1432         let events = node.node.get_and_clear_pending_events();
1433         assert_eq!(events.len(), events_count, "{:?}", events);
1434         let mut issues_discard_funding = false;
1435         for (idx, event) in events.into_iter().enumerate() {
1436                 match event {
1437                         Event::ChannelClosed { ref reason, counterparty_node_id,
1438                                 channel_capacity_sats, .. } => {
1439                                 assert_eq!(*reason, expected_reason);
1440                                 assert_eq!(counterparty_node_id.unwrap(), expected_counterparty_node_ids[idx]);
1441                                 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1442                         },
1443                         Event::DiscardFunding { .. } => {
1444                                 issues_discard_funding = true;
1445                         }
1446                         _ => panic!("Unexpected event"),
1447                 }
1448         }
1449         assert_eq!(is_check_discard_funding, issues_discard_funding);
1450 }
1451
1452 /// Check that a channel's closing channel events has been issued
1453 ///
1454 /// Don't use this, use the identically-named function instead.
1455 #[macro_export]
1456 macro_rules! check_closed_event {
1457         ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1458                 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1459         };
1460         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1461                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1462                         $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1463         }
1464 }
1465
1466 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) {
1467         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) };
1468         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) };
1469         let (tx_a, tx_b);
1470
1471         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1472         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1473
1474         let events_1 = node_b.get_and_clear_pending_msg_events();
1475         assert!(events_1.len() >= 1);
1476         let shutdown_b = match events_1[0] {
1477                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1478                         assert_eq!(node_id, &node_a.get_our_node_id());
1479                         msg.clone()
1480                 },
1481                 _ => panic!("Unexpected event"),
1482         };
1483
1484         let closing_signed_b = if !close_inbound_first {
1485                 assert_eq!(events_1.len(), 1);
1486                 None
1487         } else {
1488                 Some(match events_1[1] {
1489                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1490                                 assert_eq!(node_id, &node_a.get_our_node_id());
1491                                 msg.clone()
1492                         },
1493                         _ => panic!("Unexpected event"),
1494                 })
1495         };
1496
1497         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1498         let (as_update, bs_update) = if close_inbound_first {
1499                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1500                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1501
1502                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1503                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1504                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1505                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1506
1507                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1508                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1509                 assert!(none_a.is_none());
1510                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1511                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1512                 (as_update, bs_update)
1513         } else {
1514                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1515
1516                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1517                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1518
1519                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1520                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1521                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1522
1523                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1524                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1525                 assert!(none_b.is_none());
1526                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1527                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1528                 (as_update, bs_update)
1529         };
1530         assert_eq!(tx_a, tx_b);
1531         check_spends!(tx_a, funding_tx);
1532
1533         (as_update, bs_update, tx_a)
1534 }
1535
1536 pub struct SendEvent {
1537         pub node_id: PublicKey,
1538         pub msgs: Vec<msgs::UpdateAddHTLC>,
1539         pub commitment_msg: msgs::CommitmentSigned,
1540 }
1541 impl SendEvent {
1542         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1543                 assert!(updates.update_fulfill_htlcs.is_empty());
1544                 assert!(updates.update_fail_htlcs.is_empty());
1545                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1546                 assert!(updates.update_fee.is_none());
1547                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1548         }
1549
1550         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1551                 match event {
1552                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1553                         _ => panic!("Unexpected event type!"),
1554                 }
1555         }
1556
1557         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1558                 let mut events = node.node.get_and_clear_pending_msg_events();
1559                 assert_eq!(events.len(), 1);
1560                 SendEvent::from_event(events.pop().unwrap())
1561         }
1562 }
1563
1564 #[macro_export]
1565 /// Don't use this, use the identically-named function instead.
1566 macro_rules! expect_pending_htlcs_forwardable_conditions {
1567         ($node: expr, $expected_failures: expr) => {
1568                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1569         }
1570 }
1571
1572 #[macro_export]
1573 macro_rules! expect_htlc_handling_failed_destinations {
1574         ($events: expr, $expected_failures: expr) => {{
1575                 for event in $events {
1576                         match event {
1577                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1578                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1579                                         assert!($expected_failures.contains(&failed_next_destination))
1580                                 },
1581                                 _ => panic!("Unexpected destination"),
1582                         }
1583                 }
1584         }}
1585 }
1586
1587 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1588 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1589 /// `expected_failures` set.
1590 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1591         match events[0] {
1592                 Event::PendingHTLCsForwardable { .. } => { },
1593                 _ => panic!("Unexpected event {:?}", events),
1594         };
1595
1596         let count = expected_failures.len() + 1;
1597         assert_eq!(events.len(), count);
1598
1599         if expected_failures.len() > 0 {
1600                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1601         }
1602 }
1603
1604 #[macro_export]
1605 /// Clears (and ignores) a PendingHTLCsForwardable event
1606 ///
1607 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1608 /// set instead.
1609 macro_rules! expect_pending_htlcs_forwardable_ignore {
1610         ($node: expr) => {
1611                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1612         }
1613 }
1614
1615 #[macro_export]
1616 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1617 ///
1618 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1619 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1620         ($node: expr, $expected_failures: expr) => {
1621                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1622         }
1623 }
1624
1625 #[macro_export]
1626 /// Handles a PendingHTLCsForwardable event
1627 macro_rules! expect_pending_htlcs_forwardable {
1628         ($node: expr) => {{
1629                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1630                 $node.node.process_pending_htlc_forwards();
1631
1632                 // Ensure process_pending_htlc_forwards is idempotent.
1633                 $node.node.process_pending_htlc_forwards();
1634         }};
1635 }
1636
1637 #[macro_export]
1638 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1639 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1640         ($node: expr, $expected_failures: expr) => {{
1641                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1642                 $node.node.process_pending_htlc_forwards();
1643
1644                 // Ensure process_pending_htlc_forwards is idempotent.
1645                 $node.node.process_pending_htlc_forwards();
1646         }}
1647 }
1648
1649 #[cfg(test)]
1650 macro_rules! expect_pending_htlcs_forwardable_from_events {
1651         ($node: expr, $events: expr, $ignore: expr) => {{
1652                 assert_eq!($events.len(), 1);
1653                 match $events[0] {
1654                         Event::PendingHTLCsForwardable { .. } => { },
1655                         _ => panic!("Unexpected event"),
1656                 };
1657                 if $ignore {
1658                         $node.node.process_pending_htlc_forwards();
1659
1660                         // Ensure process_pending_htlc_forwards is idempotent.
1661                         $node.node.process_pending_htlc_forwards();
1662                 }
1663         }}
1664 }
1665
1666 #[macro_export]
1667 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1668 /// commitment update.
1669 macro_rules! commitment_signed_dance {
1670         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1671                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1672         };
1673         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1674                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1675         };
1676         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1677                 {
1678                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1679                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1680                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1681                         check_added_monitors(&$node_a, 1);
1682                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1683                         assert!(extra_msg_option.is_none());
1684                         bs_revoke_and_ack
1685                 }
1686         };
1687         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1688                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1689         };
1690         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1691                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1692         }
1693 }
1694
1695 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1696 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1697 /// `revoke_and_ack` response to it.
1698 ///
1699 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1700 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1701         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1702         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1703         check_added_monitors(node_a, 1);
1704         extra_msg_option
1705 }
1706
1707 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1708 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1709 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1710 /// have included.
1711 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1712         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1713         check_added_monitors!(node_b, 0);
1714         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1715         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1716         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1717         check_added_monitors!(node_b, 1);
1718         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1719         let (bs_revoke_and_ack, extra_msg_option) = {
1720                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1721                 assert!(events.len() <= 2);
1722                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1723                 (match node_a_event {
1724                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1725                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1726                                 (*msg).clone()
1727                         },
1728                         _ => panic!("Unexpected event"),
1729                 }, events.get(0).map(|e| e.clone()))
1730         };
1731         check_added_monitors!(node_b, 1);
1732         if fail_backwards {
1733                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1734                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1735         }
1736         (extra_msg_option, bs_revoke_and_ack)
1737 }
1738
1739 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1740 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1741 ///
1742 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1743 /// on failure or that no new messages are left over on success.
1744 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1745         check_added_monitors!(node_a, 0);
1746         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1747         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1748         check_added_monitors!(node_a, 1);
1749
1750         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1751
1752         if skip_last_step { return; }
1753
1754         if fail_backwards {
1755                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1756                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1757                 check_added_monitors!(node_a, 1);
1758
1759                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1760                 let mut number_of_msg_events = 0;
1761                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1762                         let peer_state = peer_state_mutex.lock().unwrap();
1763                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1764                         number_of_msg_events += cp_pending_msg_events.len();
1765                         if cp_pending_msg_events.len() == 1 {
1766                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1767                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1768                                 } else { panic!("Unexpected event"); }
1769                         }
1770                 }
1771                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1772                 assert_eq!(number_of_msg_events, 1);
1773         } else {
1774                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1775         }
1776 }
1777
1778 /// Get a payment preimage and hash.
1779 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1780         let mut payment_count = recipient.network_payment_count.borrow_mut();
1781         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1782         *payment_count += 1;
1783         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1784         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1785         (payment_preimage, payment_hash, payment_secret)
1786 }
1787
1788 /// Get a payment preimage and hash.
1789 ///
1790 /// Don't use this, use the identically-named function instead.
1791 #[macro_export]
1792 macro_rules! get_payment_preimage_hash {
1793         ($dest_node: expr) => {
1794                 get_payment_preimage_hash!($dest_node, None)
1795         };
1796         ($dest_node: expr, $min_value_msat: expr) => {
1797                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1798         };
1799         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1800                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1801         };
1802 }
1803
1804 /// Gets a route from the given sender to the node described in `payment_params`.
1805 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1806         let scorer = TestScorer::new();
1807         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1808         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1809         router::get_route(
1810                 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1811                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1812                 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1813         )
1814 }
1815
1816 /// Gets a route from the given sender to the node described in `payment_params`.
1817 ///
1818 /// Don't use this, use the identically-named function instead.
1819 #[macro_export]
1820 macro_rules! get_route {
1821         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1822                 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1823         }
1824 }
1825
1826 #[cfg(test)]
1827 #[macro_export]
1828 macro_rules! get_route_and_payment_hash {
1829         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1830                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1831                         .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1832                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1833         }};
1834         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1835                 let (payment_preimage, payment_hash, payment_secret) =
1836                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1837                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1838                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1839         }}
1840 }
1841
1842 pub fn check_payment_claimable(
1843         event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1844         expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1845         expected_receiver_node_id: PublicKey,
1846 ) {
1847         match event {
1848                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1849                         assert_eq!(expected_payment_hash, *payment_hash);
1850                         assert_eq!(expected_recv_value, *amount_msat);
1851                         assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1852                         match purpose {
1853                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1854                                         assert_eq!(&expected_payment_preimage, payment_preimage);
1855                                         assert_eq!(expected_payment_secret, *payment_secret);
1856                                 },
1857                                 _ => {},
1858                         }
1859                 },
1860                 _ => panic!("Unexpected event"),
1861         }
1862 }
1863
1864 #[macro_export]
1865 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1866 macro_rules! expect_payment_claimable {
1867         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1868                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1869         };
1870         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1871                 let events = $node.node.get_and_clear_pending_events();
1872                 assert_eq!(events.len(), 1);
1873                 $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)
1874         };
1875 }
1876
1877 #[macro_export]
1878 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1879 macro_rules! expect_payment_claimed {
1880         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1881                 let events = $node.node.get_and_clear_pending_events();
1882                 assert_eq!(events.len(), 1);
1883                 match events[0] {
1884                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1885                                 assert_eq!($expected_payment_hash, *payment_hash);
1886                                 assert_eq!($expected_recv_value, amount_msat);
1887                         },
1888                         _ => panic!("Unexpected event"),
1889                 }
1890         }
1891 }
1892
1893 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1894         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1895         expect_per_path_claims: bool,
1896 ) {
1897         let events = node.node().get_and_clear_pending_events();
1898         let expected_payment_hash = PaymentHash(
1899                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1900         if expect_per_path_claims {
1901                 assert!(events.len() > 1);
1902         } else {
1903                 assert_eq!(events.len(), 1);
1904         }
1905         let expected_payment_id = match events[0] {
1906                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1907                         assert_eq!(expected_payment_preimage, *payment_preimage);
1908                         assert_eq!(expected_payment_hash, *payment_hash);
1909                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
1910                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
1911                         } else {
1912                                 assert!(fee_paid_msat.is_some());
1913                         }
1914                         payment_id.unwrap()
1915                 },
1916                 _ => panic!("Unexpected event"),
1917         };
1918         if expect_per_path_claims {
1919                 for i in 1..events.len() {
1920                         match events[i] {
1921                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1922                                         assert_eq!(payment_id, expected_payment_id);
1923                                         assert_eq!(payment_hash, Some(expected_payment_hash));
1924                                 },
1925                                 _ => panic!("Unexpected event"),
1926                         }
1927                 }
1928         }
1929 }
1930
1931 #[cfg(test)]
1932 #[macro_export]
1933 macro_rules! expect_payment_sent_without_paths {
1934         ($node: expr, $expected_payment_preimage: expr) => {
1935                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1936         };
1937         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1938                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1939         }
1940 }
1941
1942 #[macro_export]
1943 macro_rules! expect_payment_sent {
1944         ($node: expr, $expected_payment_preimage: expr) => {
1945                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1946         };
1947         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1948                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1949         };
1950         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1951                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1952                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1953         }
1954 }
1955
1956 #[cfg(test)]
1957 #[macro_export]
1958 macro_rules! expect_payment_path_successful {
1959         ($node: expr) => {
1960                 let events = $node.node.get_and_clear_pending_events();
1961                 assert_eq!(events.len(), 1);
1962                 match events[0] {
1963                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
1964                         _ => panic!("Unexpected event"),
1965                 }
1966         }
1967 }
1968
1969 macro_rules! expect_payment_forwarded {
1970         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1971                 let events = $node.node.get_and_clear_pending_events();
1972                 assert_eq!(events.len(), 1);
1973                 match events[0] {
1974                         Event::PaymentForwarded {
1975                                 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1976                                 outbound_amount_forwarded_msat: _
1977                         } => {
1978                                 assert_eq!(fee_earned_msat, $expected_fee);
1979                                 if fee_earned_msat.is_some() {
1980                                         // Is the event prev_channel_id in one of the channels between the two nodes?
1981                                         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()));
1982                                 }
1983                                 // We check for force closures since a force closed channel is removed from the
1984                                 // node's channel list
1985                                 if !$downstream_force_closed {
1986                                         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()));
1987                                 }
1988                                 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1989                         },
1990                         _ => panic!("Unexpected event"),
1991                 }
1992         }
1993 }
1994
1995 #[cfg(test)]
1996 #[macro_export]
1997 macro_rules! expect_channel_shutdown_state {
1998         ($node: expr, $chan_id: expr, $state: path) => {
1999                 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2000                 assert_eq!(chan_details.len(), 1);
2001                 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2002         }
2003 }
2004
2005 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2006 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2007         let events = node.node.get_and_clear_pending_events();
2008         assert_eq!(events.len(), 1);
2009         match events[0] {
2010                 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2011                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2012                 },
2013                 _ => panic!("Unexpected event"),
2014         }
2015 }
2016
2017 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2018 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2019         let events = node.node.get_and_clear_pending_events();
2020         assert_eq!(events.len(), 1);
2021         match events[0] {
2022                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2023                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2024                 },
2025                 _ => panic!("Unexpected event"),
2026         }
2027 }
2028
2029 pub struct PaymentFailedConditions<'a> {
2030         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2031         pub(crate) expected_blamed_scid: Option<u64>,
2032         pub(crate) expected_blamed_chan_closed: Option<bool>,
2033         pub(crate) expected_mpp_parts_remain: bool,
2034 }
2035
2036 impl<'a> PaymentFailedConditions<'a> {
2037         pub fn new() -> Self {
2038                 Self {
2039                         expected_htlc_error_data: None,
2040                         expected_blamed_scid: None,
2041                         expected_blamed_chan_closed: None,
2042                         expected_mpp_parts_remain: false,
2043                 }
2044         }
2045         pub fn mpp_parts_remain(mut self) -> Self {
2046                 self.expected_mpp_parts_remain = true;
2047                 self
2048         }
2049         pub fn blamed_scid(mut self, scid: u64) -> Self {
2050                 self.expected_blamed_scid = Some(scid);
2051                 self
2052         }
2053         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2054                 self.expected_blamed_chan_closed = Some(closed);
2055                 self
2056         }
2057         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2058                 self.expected_htlc_error_data = Some((code, data));
2059                 self
2060         }
2061 }
2062
2063 #[cfg(test)]
2064 macro_rules! expect_payment_failed_with_update {
2065         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2066                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2067                         &$node, $expected_payment_hash, $payment_failed_permanently,
2068                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2069                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2070         }
2071 }
2072
2073 #[cfg(test)]
2074 macro_rules! expect_payment_failed {
2075         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2076                 #[allow(unused_mut)]
2077                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2078                 $(
2079                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2080                 )*
2081                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2082         };
2083 }
2084
2085 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2086         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2087         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2088 ) {
2089         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2090         let expected_payment_id = match &payment_failed_events[0] {
2091                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2092                         #[cfg(test)]
2093                         error_code,
2094                         #[cfg(test)]
2095                         error_data, .. } => {
2096                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2097                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2098                         #[cfg(test)]
2099                         {
2100                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2101                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2102                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2103                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2104                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2105                                 }
2106                         }
2107
2108                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2109                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2110                                         match upd {
2111                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2112                                                         if let Some(scid) = conditions.expected_blamed_scid {
2113                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2114                                                         }
2115                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2116                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2117                                                 },
2118                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2119                                                         if let Some(scid) = conditions.expected_blamed_scid {
2120                                                                 assert_eq!(*short_channel_id, scid);
2121                                                         }
2122                                                         assert!(is_permanent);
2123                                                 },
2124                                                 _ => panic!("Unexpected update type"),
2125                                         }
2126                                 } else { panic!("Expected network update"); }
2127                         }
2128
2129                         payment_id.unwrap()
2130                 },
2131                 _ => panic!("Unexpected event"),
2132         };
2133         if !conditions.expected_mpp_parts_remain {
2134                 match &payment_failed_events[1] {
2135                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2136                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2137                                 assert_eq!(*payment_id, expected_payment_id);
2138                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2139                                         PaymentFailureReason::RecipientRejected
2140                                 } else {
2141                                         PaymentFailureReason::RetriesExhausted
2142                                 });
2143                         }
2144                         _ => panic!("Unexpected second event"),
2145                 }
2146         }
2147 }
2148
2149 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2150         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2151         conditions: PaymentFailedConditions<'e>
2152 ) {
2153         let events = node.node.get_and_clear_pending_events();
2154         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2155 }
2156
2157 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 {
2158         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2159         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2160                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2161         check_added_monitors!(origin_node, expected_paths.len());
2162         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2163         payment_id
2164 }
2165
2166 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> {
2167         let mut payment_event = SendEvent::from_event(ev);
2168         let mut prev_node = origin_node;
2169         let mut event = None;
2170
2171         for (idx, &node) in expected_path.iter().enumerate() {
2172                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2173
2174                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2175                 check_added_monitors!(node, 0);
2176                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2177
2178                 expect_pending_htlcs_forwardable!(node);
2179
2180                 if idx == expected_path.len() - 1 && clear_recipient_events {
2181                         let events_2 = node.node.get_and_clear_pending_events();
2182                         if payment_claimable_expected {
2183                                 assert_eq!(events_2.len(), 1);
2184                                 match &events_2[0] {
2185                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2186                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2187                                                 claim_deadline, onion_fields, ..
2188                                         } => {
2189                                                 assert_eq!(our_payment_hash, *payment_hash);
2190                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2191                                                 assert!(onion_fields.is_some());
2192                                                 match &purpose {
2193                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2194                                                                 assert_eq!(expected_preimage, *payment_preimage);
2195                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2196                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2197                                                         },
2198                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2199                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2200                                                                 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2201                                                         },
2202                                                 }
2203                                                 assert_eq!(*amount_msat, recv_value);
2204                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2205                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2206                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2207                                         },
2208                                         _ => panic!("Unexpected event"),
2209                                 }
2210                                 event = Some(events_2[0].clone());
2211                         } else {
2212                                 assert!(events_2.is_empty());
2213                         }
2214                 } else if idx != expected_path.len() - 1 {
2215                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2216                         assert_eq!(events_2.len(), 1);
2217                         check_added_monitors!(node, 1);
2218                         payment_event = SendEvent::from_event(events_2.remove(0));
2219                         assert_eq!(payment_event.msgs.len(), 1);
2220                 }
2221
2222                 prev_node = node;
2223         }
2224         event
2225 }
2226
2227 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> {
2228         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2229 }
2230
2231 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) {
2232         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2233         assert_eq!(events.len(), expected_route.len());
2234         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2235                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2236                 // Once we've gotten through all the HTLCs, the last one should result in a
2237                 // PaymentClaimable (but each previous one should not!), .
2238                 let expect_payment = path_idx == expected_route.len() - 1;
2239                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2240         }
2241 }
2242
2243 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) {
2244         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2245         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2246         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2247 }
2248
2249 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2250         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2251         our_payment_preimage: PaymentPreimage
2252 ) -> u64 {
2253         let extra_fees = vec![0; expected_paths.len()];
2254         do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2255                 &extra_fees[..], skip_last, our_payment_preimage)
2256 }
2257
2258 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2259         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2260         &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2261 ) -> u64 {
2262         assert_eq!(expected_paths.len(), expected_extra_fees.len());
2263         for path in expected_paths.iter() {
2264                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2265         }
2266         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2267         pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2268 }
2269
2270 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 {
2271         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2272         assert_eq!(claim_event.len(), 1);
2273         match claim_event[0] {
2274                 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2275                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2276                         assert_eq!(preimage, our_payment_preimage),
2277                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2278                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2279                 _ => panic!(),
2280         }
2281
2282         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2283
2284         let mut expected_total_fee_msat = 0;
2285
2286         macro_rules! msgs_from_ev {
2287                 ($ev: expr) => {
2288                         match $ev {
2289                                 &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 } } => {
2290                                         assert!(update_add_htlcs.is_empty());
2291                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2292                                         assert!(update_fail_htlcs.is_empty());
2293                                         assert!(update_fail_malformed_htlcs.is_empty());
2294                                         assert!(update_fee.is_none());
2295                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2296                                 },
2297                                 _ => panic!("Unexpected event"),
2298                         }
2299                 }
2300         }
2301         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2302         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2303         assert_eq!(events.len(), expected_paths.len());
2304
2305         if events.len() == 1 {
2306                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2307         } else {
2308                 for expected_path in expected_paths.iter() {
2309                         // For MPP payments, we always want the message to the first node in the path.
2310                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2311                         per_path_msgs.push(msgs_from_ev!(&ev));
2312                 }
2313         }
2314
2315         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2316                 let mut next_msgs = Some(path_msgs);
2317                 let mut expected_next_node = next_hop;
2318
2319                 macro_rules! last_update_fulfill_dance {
2320                         ($node: expr, $prev_node: expr) => {
2321                                 {
2322                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2323                                         check_added_monitors!($node, 0);
2324                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2325                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2326                                 }
2327                         }
2328                 }
2329                 macro_rules! mid_update_fulfill_dance {
2330                         ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2331                                 {
2332                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2333                                         let mut fee = {
2334                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2335                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2336                                                         .unwrap().lock().unwrap();
2337                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2338                                                 if let Some(prev_config) = channel.context.prev_config() {
2339                                                         prev_config.forwarding_fee_base_msat
2340                                                 } else {
2341                                                         channel.context.config().forwarding_fee_base_msat
2342                                                 }
2343                                         };
2344                                         if $idx == 1 { fee += expected_extra_fees[i]; }
2345                                         expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2346                                         expected_total_fee_msat += fee as u64;
2347                                         check_added_monitors!($node, 1);
2348                                         let new_next_msgs = if $new_msgs {
2349                                                 let events = $node.node.get_and_clear_pending_msg_events();
2350                                                 assert_eq!(events.len(), 1);
2351                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2352                                                 expected_next_node = nexthop;
2353                                                 Some(res)
2354                                         } else {
2355                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2356                                                 None
2357                                         };
2358                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2359                                         next_msgs = new_next_msgs;
2360                                 }
2361                         }
2362                 }
2363
2364                 let mut prev_node = expected_route.last().unwrap();
2365                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2366                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2367                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2368                         if next_msgs.is_some() {
2369                                 // Since we are traversing in reverse, next_node is actually the previous node
2370                                 let next_node: &Node;
2371                                 if idx == expected_route.len() - 1 {
2372                                         next_node = origin_node;
2373                                 } else {
2374                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2375                                 }
2376                                 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2377                         } else {
2378                                 assert!(!update_next_msgs);
2379                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2380                         }
2381                         if !skip_last && idx == expected_route.len() - 1 {
2382                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2383                         }
2384
2385                         prev_node = node;
2386                 }
2387
2388                 if !skip_last {
2389                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2390                 }
2391         }
2392
2393         // Ensure that claim_funds is idempotent.
2394         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2395         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2396         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2397
2398         expected_total_fee_msat
2399 }
2400 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) {
2401         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2402         if !skip_last {
2403                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2404         }
2405 }
2406
2407 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2408         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2409 }
2410
2411 pub const TEST_FINAL_CLTV: u32 = 70;
2412
2413 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) {
2414         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2415                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2416         let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2417         assert_eq!(route.paths.len(), 1);
2418         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2419         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2420                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2421         }
2422
2423         let res = send_along_route(origin_node, route, expected_route, recv_value);
2424         (res.0, res.1, res.2)
2425 }
2426
2427 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2428         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2429                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2430         let network_graph = origin_node.network_graph.read_only();
2431         let scorer = test_utils::TestScorer::new();
2432         let seed = [0u8; 32];
2433         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2434         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2435         let route = router::get_route(
2436                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2437                 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2438         assert_eq!(route.paths.len(), 1);
2439         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2440         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2441                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2442         }
2443
2444         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2445         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2446                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2447                 true, APIError::ChannelUnavailable { ref err },
2448                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2449 }
2450
2451 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2452         let res = route_payment(&origin, expected_route, recv_value);
2453         claim_payment(&origin, expected_route, res.0);
2454         res
2455 }
2456
2457 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) {
2458         for path in expected_paths.iter() {
2459                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2460         }
2461         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2462         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2463         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2464
2465         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2466 }
2467
2468 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) {
2469         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2470         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2471
2472         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2473         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2474         assert_eq!(events.len(), expected_paths.len());
2475         for ev in events.iter() {
2476                 let (update_fail, commitment_signed, node_id) = match ev {
2477                         &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 } } => {
2478                                 assert!(update_add_htlcs.is_empty());
2479                                 assert!(update_fulfill_htlcs.is_empty());
2480                                 assert_eq!(update_fail_htlcs.len(), 1);
2481                                 assert!(update_fail_malformed_htlcs.is_empty());
2482                                 assert!(update_fee.is_none());
2483                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2484                         },
2485                         _ => panic!("Unexpected event"),
2486                 };
2487                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2488         }
2489         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2490         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()));
2491
2492         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2493                 let mut next_msgs = Some(path_msgs);
2494                 let mut expected_next_node = next_hop;
2495                 let mut prev_node = expected_route.last().unwrap();
2496
2497                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2498                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2499                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2500                         if next_msgs.is_some() {
2501                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2502                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2503                                 if !update_next_node {
2504                                         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 }]);
2505                                 }
2506                         }
2507                         let events = node.node.get_and_clear_pending_msg_events();
2508                         if update_next_node {
2509                                 assert_eq!(events.len(), 1);
2510                                 match events[0] {
2511                                         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 } } => {
2512                                                 assert!(update_add_htlcs.is_empty());
2513                                                 assert!(update_fulfill_htlcs.is_empty());
2514                                                 assert_eq!(update_fail_htlcs.len(), 1);
2515                                                 assert!(update_fail_malformed_htlcs.is_empty());
2516                                                 assert!(update_fee.is_none());
2517                                                 expected_next_node = node_id.clone();
2518                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2519                                         },
2520                                         _ => panic!("Unexpected event"),
2521                                 }
2522                         } else {
2523                                 assert!(events.is_empty());
2524                         }
2525                         if !skip_last && idx == expected_route.len() - 1 {
2526                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2527                         }
2528
2529                         prev_node = node;
2530                 }
2531
2532                 if !skip_last {
2533                         let prev_node = expected_route.first().unwrap();
2534                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2535                         check_added_monitors!(origin_node, 0);
2536                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2537                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2538                         let events = origin_node.node.get_and_clear_pending_events();
2539                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2540
2541                         let expected_payment_id = match events[0] {
2542                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2543                                         assert_eq!(payment_hash, our_payment_hash);
2544                                         assert!(payment_failed_permanently);
2545                                         for (idx, hop) in expected_route.iter().enumerate() {
2546                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2547                                         }
2548                                         payment_id.unwrap()
2549                                 },
2550                                 _ => panic!("Unexpected event"),
2551                         };
2552                         if i == expected_paths.len() - 1 {
2553                                 match events[1] {
2554                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2555                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2556                                                 assert_eq!(*payment_id, expected_payment_id);
2557                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2558                                         }
2559                                         _ => panic!("Unexpected second event"),
2560                                 }
2561                         }
2562                 }
2563         }
2564
2565         // Ensure that fail_htlc_backwards is idempotent.
2566         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2567         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2568         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2569         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2570 }
2571
2572 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2573         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2574 }
2575
2576 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2577         let mut chan_mon_cfgs = Vec::new();
2578         for i in 0..node_count {
2579                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2580                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2581                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2582                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2583                 let persister = test_utils::TestPersister::new();
2584                 let seed = [i as u8; 32];
2585                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2586                 let scorer = Mutex::new(test_utils::TestScorer::new());
2587
2588                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2589         }
2590
2591         chan_mon_cfgs
2592 }
2593
2594 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2595         let mut nodes = Vec::new();
2596
2597         for i in 0..node_count {
2598                 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);
2599                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2600                 let seed = [i as u8; 32];
2601                 nodes.push(NodeCfg {
2602                         chain_source: &chanmon_cfgs[i].chain_source,
2603                         logger: &chanmon_cfgs[i].logger,
2604                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2605                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2606                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2607                         chain_monitor,
2608                         keys_manager: &chanmon_cfgs[i].keys_manager,
2609                         node_seed: seed,
2610                         network_graph,
2611                         override_init_features: Rc::new(RefCell::new(None)),
2612                 });
2613         }
2614
2615         nodes
2616 }
2617
2618 pub fn test_default_channel_config() -> UserConfig {
2619         let mut default_config = UserConfig::default();
2620         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2621         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2622         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2623         default_config.channel_handshake_config.announced_channel = true;
2624         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2625         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2626         // It now defaults to 1, so we simply set it to the expected value here.
2627         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2628         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2629         // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2630         // feerate of 253).
2631         default_config.channel_config.max_dust_htlc_exposure =
2632                 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2633         default_config
2634 }
2635
2636 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>> {
2637         let mut chanmgrs = Vec::new();
2638         for i in 0..node_count {
2639                 let network = Network::Testnet;
2640                 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2641                 let params = ChainParameters {
2642                         network,
2643                         best_block: BestBlock::from_network(network),
2644                 };
2645                 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,
2646                         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);
2647                 chanmgrs.push(node);
2648         }
2649
2650         chanmgrs
2651 }
2652
2653 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>> {
2654         let mut nodes = Vec::new();
2655         let chan_count = Rc::new(RefCell::new(0));
2656         let payment_count = Rc::new(RefCell::new(0));
2657         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2658
2659         for i in 0..node_count {
2660                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2661                 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2662                 nodes.push(Node{
2663                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2664                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2665                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2666                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2667                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2668                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2669                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2670                         connect_style: Rc::clone(&connect_style),
2671                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2672                         wallet_source: Arc::clone(&wallet_source),
2673                         bump_tx_handler: BumpTransactionEventHandler::new(
2674                                 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2675                                 &cfgs[i].keys_manager, cfgs[i].logger,
2676                         ),
2677                 })
2678         }
2679
2680         for i in 0..node_count {
2681                 for j in (i+1)..node_count {
2682                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2683                                 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2684                                 networks: None,
2685                                 remote_network_address: None,
2686                         }, true).unwrap();
2687                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2688                                 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2689                                 networks: None,
2690                                 remote_network_address: None,
2691                         }, false).unwrap();
2692                 }
2693         }
2694
2695         nodes
2696 }
2697
2698 // Note that the following only works for CLTV values up to 128
2699 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2700
2701 #[derive(PartialEq)]
2702 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2703 /// Tests that the given node has broadcast transactions for the given Channel
2704 ///
2705 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2706 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2707 /// broadcast and the revoked outputs were claimed.
2708 ///
2709 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2710 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2711 ///
2712 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2713 /// also fail.
2714 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>  {
2715         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2716         let mut txn_seen = HashSet::new();
2717         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2718         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2719
2720         let mut res = Vec::with_capacity(2);
2721         node_txn.retain(|tx| {
2722                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2723                         check_spends!(tx, chan.3);
2724                         if commitment_tx.is_none() {
2725                                 res.push(tx.clone());
2726                         }
2727                         false
2728                 } else { true }
2729         });
2730         if let Some(explicit_tx) = commitment_tx {
2731                 res.push(explicit_tx.clone());
2732         }
2733
2734         assert_eq!(res.len(), 1);
2735
2736         if has_htlc_tx != HTLCType::NONE {
2737                 node_txn.retain(|tx| {
2738                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2739                                 check_spends!(tx, res[0]);
2740                                 if has_htlc_tx == HTLCType::TIMEOUT {
2741                                         assert!(tx.lock_time.0 != 0);
2742                                 } else {
2743                                         assert!(tx.lock_time.0 == 0);
2744                                 }
2745                                 res.push(tx.clone());
2746                                 false
2747                         } else { true }
2748                 });
2749                 assert!(res.len() == 2 || res.len() == 3);
2750                 if res.len() == 3 {
2751                         assert_eq!(res[1], res[2]);
2752                 }
2753         }
2754
2755         assert!(node_txn.is_empty());
2756         res
2757 }
2758
2759 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2760 /// HTLC transaction.
2761 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2762         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2763         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2764         // for revoked htlc outputs
2765         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2766         node_txn.retain(|tx| {
2767                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2768                         check_spends!(tx, revoked_tx);
2769                         false
2770                 } else { true }
2771         });
2772         node_txn.retain(|tx| {
2773                 check_spends!(tx, commitment_revoked_tx);
2774                 false
2775         });
2776         assert!(node_txn.is_empty());
2777 }
2778
2779 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2780         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2781         let mut txn_seen = HashSet::new();
2782         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2783
2784         let mut found_prev = false;
2785         for prev_tx in prev_txn {
2786                 for tx in &*node_txn {
2787                         if tx.input[0].previous_output.txid == prev_tx.txid() {
2788                                 check_spends!(tx, prev_tx);
2789                                 let mut iter = tx.input[0].witness.iter();
2790                                 iter.next().expect("expected 3 witness items");
2791                                 iter.next().expect("expected 3 witness items");
2792                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2793                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2794
2795                                 found_prev = true;
2796                                 break;
2797                         }
2798                 }
2799         }
2800         assert!(found_prev);
2801
2802         let mut res = Vec::new();
2803         mem::swap(&mut *node_txn, &mut res);
2804         res
2805 }
2806
2807 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)  {
2808         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2809         assert_eq!(events_1.len(), 2);
2810         let as_update = match events_1[0] {
2811                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2812                         msg.clone()
2813                 },
2814                 _ => panic!("Unexpected event"),
2815         };
2816         match events_1[1] {
2817                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2818                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2819                         assert_eq!(msg.data, expected_error);
2820                         if needs_err_handle {
2821                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2822                         }
2823                 },
2824                 _ => panic!("Unexpected event"),
2825         }
2826
2827         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2828         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2829         let bs_update = match events_2[0] {
2830                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2831                         msg.clone()
2832                 },
2833                 _ => panic!("Unexpected event"),
2834         };
2835         if !needs_err_handle {
2836                 match events_2[1] {
2837                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2838                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2839                                 assert_eq!(msg.data, expected_error);
2840                         },
2841                         _ => panic!("Unexpected event"),
2842                 }
2843         }
2844
2845         for node in nodes {
2846                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2847                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2848         }
2849 }
2850
2851 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2852         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2853 }
2854
2855 #[cfg(test)]
2856 macro_rules! get_channel_value_stat {
2857         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2858                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2859                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2860                 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2861                 chan.get_value_stat()
2862         }}
2863 }
2864
2865 macro_rules! get_chan_reestablish_msgs {
2866         ($src_node: expr, $dst_node: expr) => {
2867                 {
2868                         let mut announcements = $crate::prelude::HashSet::new();
2869                         let mut res = Vec::with_capacity(1);
2870                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2871                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2872                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2873                                         res.push(msg.clone());
2874                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2875                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2876                                         announcements.insert(msg.contents.short_channel_id);
2877                                 } else {
2878                                         panic!("Unexpected event")
2879                                 }
2880                         }
2881                         assert!(announcements.is_empty());
2882                         res
2883                 }
2884         }
2885 }
2886
2887 macro_rules! handle_chan_reestablish_msgs {
2888         ($src_node: expr, $dst_node: expr) => {
2889                 {
2890                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2891                         let mut idx = 0;
2892                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2893                                 idx += 1;
2894                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2895                                 Some(msg.clone())
2896                         } else {
2897                                 None
2898                         };
2899
2900                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2901                                 idx += 1;
2902                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2903                         }
2904
2905                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2906                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2907                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2908                                 idx += 1;
2909                                 had_channel_update = true;
2910                         }
2911
2912                         let mut revoke_and_ack = None;
2913                         let mut commitment_update = None;
2914                         let order = if let Some(ev) = msg_events.get(idx) {
2915                                 match ev {
2916                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2917                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2918                                                 revoke_and_ack = Some(msg.clone());
2919                                                 idx += 1;
2920                                                 RAACommitmentOrder::RevokeAndACKFirst
2921                                         },
2922                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2923                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2924                                                 commitment_update = Some(updates.clone());
2925                                                 idx += 1;
2926                                                 RAACommitmentOrder::CommitmentFirst
2927                                         },
2928                                         _ => RAACommitmentOrder::CommitmentFirst,
2929                                 }
2930                         } else {
2931                                 RAACommitmentOrder::CommitmentFirst
2932                         };
2933
2934                         if let Some(ev) = msg_events.get(idx) {
2935                                 match ev {
2936                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2937                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2938                                                 assert!(revoke_and_ack.is_none());
2939                                                 revoke_and_ack = Some(msg.clone());
2940                                                 idx += 1;
2941                                         },
2942                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2943                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2944                                                 assert!(commitment_update.is_none());
2945                                                 commitment_update = Some(updates.clone());
2946                                                 idx += 1;
2947                                         },
2948                                         _ => {},
2949                                 }
2950                         }
2951
2952                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2953                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2954                                 idx += 1;
2955                                 assert!(!had_channel_update);
2956                         }
2957
2958                         assert_eq!(msg_events.len(), idx);
2959
2960                         (channel_ready, revoke_and_ack, commitment_update, order)
2961                 }
2962         }
2963 }
2964
2965 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
2966         pub node_a: &'a Node<'b, 'c, 'd>,
2967         pub node_b: &'a Node<'b, 'c, 'd>,
2968         pub send_channel_ready: (bool, bool),
2969         pub pending_htlc_adds: (i64, i64),
2970         pub pending_htlc_claims: (usize, usize),
2971         pub pending_htlc_fails: (usize, usize),
2972         pub pending_cell_htlc_claims: (usize, usize),
2973         pub pending_cell_htlc_fails: (usize, usize),
2974         pub pending_raa: (bool, bool),
2975 }
2976
2977 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
2978         pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
2979                 Self {
2980                         node_a,
2981                         node_b,
2982                         send_channel_ready: (false, false),
2983                         pending_htlc_adds: (0, 0),
2984                         pending_htlc_claims: (0, 0),
2985                         pending_htlc_fails: (0, 0),
2986                         pending_cell_htlc_claims: (0, 0),
2987                         pending_cell_htlc_fails: (0, 0),
2988                         pending_raa: (false, false),
2989                 }
2990         }
2991 }
2992
2993 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2994 /// for claims/fails they are separated out.
2995 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
2996         let ReconnectArgs {
2997                 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
2998                 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa
2999         } = args;
3000         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3001                 features: node_b.node.init_features(), networks: None, remote_network_address: None
3002         }, true).unwrap();
3003         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3004         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3005                 features: node_a.node.init_features(), networks: None, remote_network_address: None
3006         }, false).unwrap();
3007         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3008
3009         if send_channel_ready.0 {
3010                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3011                 // from b
3012                 for reestablish in reestablish_1.iter() {
3013                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3014                 }
3015         }
3016         if send_channel_ready.1 {
3017                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3018                 // from a
3019                 for reestablish in reestablish_2.iter() {
3020                         assert_eq!(reestablish.next_remote_commitment_number, 0);
3021                 }
3022         }
3023         if send_channel_ready.0 || send_channel_ready.1 {
3024                 // If we expect any channel_ready's, both sides better have set
3025                 // next_holder_commitment_number to 1
3026                 for reestablish in reestablish_1.iter() {
3027                         assert_eq!(reestablish.next_local_commitment_number, 1);
3028                 }
3029                 for reestablish in reestablish_2.iter() {
3030                         assert_eq!(reestablish.next_local_commitment_number, 1);
3031                 }
3032         }
3033
3034         let mut resp_1 = Vec::new();
3035         for msg in reestablish_1 {
3036                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3037                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3038         }
3039         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3040                 check_added_monitors!(node_b, 1);
3041         } else {
3042                 check_added_monitors!(node_b, 0);
3043         }
3044
3045         let mut resp_2 = Vec::new();
3046         for msg in reestablish_2 {
3047                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3048                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3049         }
3050         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3051                 check_added_monitors!(node_a, 1);
3052         } else {
3053                 check_added_monitors!(node_a, 0);
3054         }
3055
3056         // We don't yet support both needing updates, as that would require a different commitment dance:
3057         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3058                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3059                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3060                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3061
3062         for chan_msgs in resp_1.drain(..) {
3063                 if send_channel_ready.0 {
3064                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3065                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3066                         if !announcement_event.is_empty() {
3067                                 assert_eq!(announcement_event.len(), 1);
3068                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3069                                         //TODO: Test announcement_sigs re-sending
3070                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3071                         }
3072                 } else {
3073                         assert!(chan_msgs.0.is_none());
3074                 }
3075                 if pending_raa.0 {
3076                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3077                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3078                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3079                         check_added_monitors!(node_a, 1);
3080                 } else {
3081                         assert!(chan_msgs.1.is_none());
3082                 }
3083                 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 {
3084                         let commitment_update = chan_msgs.2.unwrap();
3085                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3086                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3087                         } else {
3088                                 assert!(commitment_update.update_add_htlcs.is_empty());
3089                         }
3090                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3091                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3092                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3093                         for update_add in commitment_update.update_add_htlcs {
3094                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3095                         }
3096                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3097                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3098                         }
3099                         for update_fail in commitment_update.update_fail_htlcs {
3100                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3101                         }
3102
3103                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3104                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3105                         } else {
3106                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3107                                 check_added_monitors!(node_a, 1);
3108                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3109                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3110                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3111                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3112                                 check_added_monitors!(node_b, 1);
3113                         }
3114                 } else {
3115                         assert!(chan_msgs.2.is_none());
3116                 }
3117         }
3118
3119         for chan_msgs in resp_2.drain(..) {
3120                 if send_channel_ready.1 {
3121                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3122                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3123                         if !announcement_event.is_empty() {
3124                                 assert_eq!(announcement_event.len(), 1);
3125                                 match announcement_event[0] {
3126                                         MessageSendEvent::SendChannelUpdate { .. } => {},
3127                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3128                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3129                                 }
3130                         }
3131                 } else {
3132                         assert!(chan_msgs.0.is_none());
3133                 }
3134                 if pending_raa.1 {
3135                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3136                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3137                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3138                         check_added_monitors!(node_b, 1);
3139                 } else {
3140                         assert!(chan_msgs.1.is_none());
3141                 }
3142                 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 {
3143                         let commitment_update = chan_msgs.2.unwrap();
3144                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3145                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3146                         }
3147                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3148                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3149                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3150                         for update_add in commitment_update.update_add_htlcs {
3151                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3152                         }
3153                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3154                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3155                         }
3156                         for update_fail in commitment_update.update_fail_htlcs {
3157                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3158                         }
3159
3160                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3161                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3162                         } else {
3163                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3164                                 check_added_monitors!(node_b, 1);
3165                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3166                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3167                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3168                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3169                                 check_added_monitors!(node_a, 1);
3170                         }
3171                 } else {
3172                         assert!(chan_msgs.2.is_none());
3173                 }
3174         }
3175 }