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