_ 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, '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, '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, '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, '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, '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, '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         let events = node.node.get_and_clear_pending_events();
1423         assert_eq!(events.len(), events_count, "{:?}", events);
1424         let mut issues_discard_funding = false;
1425         for event in events {
1426                 match event {
1427                         Event::ChannelClosed { ref reason, .. } => {
1428                                 assert_eq!(*reason, expected_reason);
1429                         },
1430                         Event::DiscardFunding { .. } => {
1431                                 issues_discard_funding = true;
1432                         }
1433                         _ => panic!("Unexpected event"),
1434                 }
1435         }
1436         assert_eq!(is_check_discard_funding, issues_discard_funding);
1437 }
1438
1439 /// Check that a channel's closing channel events has been issued
1440 ///
1441 /// Don't use this, use the identically-named function instead.
1442 #[macro_export]
1443 macro_rules! check_closed_event {
1444         ($node: expr, $events: expr, $reason: expr) => {
1445                 check_closed_event!($node, $events, $reason, false);
1446         };
1447         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1448                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1449         }
1450 }
1451
1452 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) {
1453         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) };
1454         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) };
1455         let (tx_a, tx_b);
1456
1457         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1458         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1459
1460         let events_1 = node_b.get_and_clear_pending_msg_events();
1461         assert!(events_1.len() >= 1);
1462         let shutdown_b = match events_1[0] {
1463                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1464                         assert_eq!(node_id, &node_a.get_our_node_id());
1465                         msg.clone()
1466                 },
1467                 _ => panic!("Unexpected event"),
1468         };
1469
1470         let closing_signed_b = if !close_inbound_first {
1471                 assert_eq!(events_1.len(), 1);
1472                 None
1473         } else {
1474                 Some(match events_1[1] {
1475                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1476                                 assert_eq!(node_id, &node_a.get_our_node_id());
1477                                 msg.clone()
1478                         },
1479                         _ => panic!("Unexpected event"),
1480                 })
1481         };
1482
1483         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1484         let (as_update, bs_update) = if close_inbound_first {
1485                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1486                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1487
1488                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1489                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1490                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1491                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1492
1493                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1494                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1495                 assert!(none_a.is_none());
1496                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1497                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1498                 (as_update, bs_update)
1499         } else {
1500                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1501
1502                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1503                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1504
1505                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1506                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1507                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1508
1509                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1510                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1511                 assert!(none_b.is_none());
1512                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1513                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1514                 (as_update, bs_update)
1515         };
1516         assert_eq!(tx_a, tx_b);
1517         check_spends!(tx_a, funding_tx);
1518
1519         (as_update, bs_update, tx_a)
1520 }
1521
1522 pub struct SendEvent {
1523         pub node_id: PublicKey,
1524         pub msgs: Vec<msgs::UpdateAddHTLC>,
1525         pub commitment_msg: msgs::CommitmentSigned,
1526 }
1527 impl SendEvent {
1528         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1529                 assert!(updates.update_fulfill_htlcs.is_empty());
1530                 assert!(updates.update_fail_htlcs.is_empty());
1531                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1532                 assert!(updates.update_fee.is_none());
1533                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1534         }
1535
1536         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1537                 match event {
1538                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1539                         _ => panic!("Unexpected event type!"),
1540                 }
1541         }
1542
1543         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1544                 let mut events = node.node.get_and_clear_pending_msg_events();
1545                 assert_eq!(events.len(), 1);
1546                 SendEvent::from_event(events.pop().unwrap())
1547         }
1548 }
1549
1550 #[macro_export]
1551 /// Don't use this, use the identically-named function instead.
1552 macro_rules! expect_pending_htlcs_forwardable_conditions {
1553         ($node: expr, $expected_failures: expr) => {
1554                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1555         }
1556 }
1557
1558 #[macro_export]
1559 macro_rules! expect_htlc_handling_failed_destinations {
1560         ($events: expr, $expected_failures: expr) => {{
1561                 for event in $events {
1562                         match event {
1563                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1564                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1565                                         assert!($expected_failures.contains(&failed_next_destination))
1566                                 },
1567                                 _ => panic!("Unexpected destination"),
1568                         }
1569                 }
1570         }}
1571 }
1572
1573 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1574 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1575 /// `expected_failures` set.
1576 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1577         match events[0] {
1578                 Event::PendingHTLCsForwardable { .. } => { },
1579                 _ => panic!("Unexpected event {:?}", events),
1580         };
1581
1582         let count = expected_failures.len() + 1;
1583         assert_eq!(events.len(), count);
1584
1585         if expected_failures.len() > 0 {
1586                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1587         }
1588 }
1589
1590 #[macro_export]
1591 /// Clears (and ignores) a PendingHTLCsForwardable event
1592 ///
1593 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1594 /// set instead.
1595 macro_rules! expect_pending_htlcs_forwardable_ignore {
1596         ($node: expr) => {
1597                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1598         }
1599 }
1600
1601 #[macro_export]
1602 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1603 ///
1604 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1605 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1606         ($node: expr, $expected_failures: expr) => {
1607                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1608         }
1609 }
1610
1611 #[macro_export]
1612 /// Handles a PendingHTLCsForwardable event
1613 macro_rules! expect_pending_htlcs_forwardable {
1614         ($node: expr) => {{
1615                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1616                 $node.node.process_pending_htlc_forwards();
1617
1618                 // Ensure process_pending_htlc_forwards is idempotent.
1619                 $node.node.process_pending_htlc_forwards();
1620         }};
1621 }
1622
1623 #[macro_export]
1624 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1625 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1626         ($node: expr, $expected_failures: expr) => {{
1627                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1628                 $node.node.process_pending_htlc_forwards();
1629
1630                 // Ensure process_pending_htlc_forwards is idempotent.
1631                 $node.node.process_pending_htlc_forwards();
1632         }}
1633 }
1634
1635 #[cfg(test)]
1636 macro_rules! expect_pending_htlcs_forwardable_from_events {
1637         ($node: expr, $events: expr, $ignore: expr) => {{
1638                 assert_eq!($events.len(), 1);
1639                 match $events[0] {
1640                         Event::PendingHTLCsForwardable { .. } => { },
1641                         _ => panic!("Unexpected event"),
1642                 };
1643                 if $ignore {
1644                         $node.node.process_pending_htlc_forwards();
1645
1646                         // Ensure process_pending_htlc_forwards is idempotent.
1647                         $node.node.process_pending_htlc_forwards();
1648                 }
1649         }}
1650 }
1651
1652 #[macro_export]
1653 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1654 /// commitment update.
1655 macro_rules! commitment_signed_dance {
1656         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1657                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1658         };
1659         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1660                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1661         };
1662         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1663                 {
1664                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1665                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1666                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1667                         check_added_monitors(&$node_a, 1);
1668                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1669                         assert!(extra_msg_option.is_none());
1670                         bs_revoke_and_ack
1671                 }
1672         };
1673         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1674                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1675         };
1676         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1677                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1678         }
1679 }
1680
1681 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1682 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1683 /// `revoke_and_ack` response to it.
1684 ///
1685 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1686 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1687         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1688         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1689         check_added_monitors(node_a, 1);
1690         extra_msg_option
1691 }
1692
1693 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1694 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1695 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1696 /// have included.
1697 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1698         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1699         check_added_monitors!(node_b, 0);
1700         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1701         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1702         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1703         check_added_monitors!(node_b, 1);
1704         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1705         let (bs_revoke_and_ack, extra_msg_option) = {
1706                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1707                 assert!(events.len() <= 2);
1708                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1709                 (match node_a_event {
1710                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1711                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1712                                 (*msg).clone()
1713                         },
1714                         _ => panic!("Unexpected event"),
1715                 }, events.get(0).map(|e| e.clone()))
1716         };
1717         check_added_monitors!(node_b, 1);
1718         if fail_backwards {
1719                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1720                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1721         }
1722         (extra_msg_option, bs_revoke_and_ack)
1723 }
1724
1725 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1726 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1727 ///
1728 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1729 /// on failure or that no new messages are left over on success.
1730 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1731         check_added_monitors!(node_a, 0);
1732         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1733         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1734         check_added_monitors!(node_a, 1);
1735
1736         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1737
1738         if skip_last_step { return; }
1739
1740         if fail_backwards {
1741                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1742                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1743                 check_added_monitors!(node_a, 1);
1744
1745                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1746                 let mut number_of_msg_events = 0;
1747                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1748                         let peer_state = peer_state_mutex.lock().unwrap();
1749                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1750                         number_of_msg_events += cp_pending_msg_events.len();
1751                         if cp_pending_msg_events.len() == 1 {
1752                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1753                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1754                                 } else { panic!("Unexpected event"); }
1755                         }
1756                 }
1757                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1758                 assert_eq!(number_of_msg_events, 1);
1759         } else {
1760                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1761         }
1762 }
1763
1764 /// Get a payment preimage and hash.
1765 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1766         let mut payment_count = recipient.network_payment_count.borrow_mut();
1767         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1768         *payment_count += 1;
1769         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1770         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1771         (payment_preimage, payment_hash, payment_secret)
1772 }
1773
1774 /// Get a payment preimage and hash.
1775 ///
1776 /// Don't use this, use the identically-named function instead.
1777 #[macro_export]
1778 macro_rules! get_payment_preimage_hash {
1779         ($dest_node: expr) => {
1780                 get_payment_preimage_hash!($dest_node, None)
1781         };
1782         ($dest_node: expr, $min_value_msat: expr) => {
1783                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1784         };
1785         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1786                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1787         };
1788 }
1789
1790 /// Gets a route from the given sender to the node described in `payment_params`.
1791 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1792         let scorer = TestScorer::new();
1793         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1794         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1795         router::get_route(
1796                 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1797                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1798                 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1799         )
1800 }
1801
1802 /// Gets a route from the given sender to the node described in `payment_params`.
1803 ///
1804 /// Don't use this, use the identically-named function instead.
1805 #[macro_export]
1806 macro_rules! get_route {
1807         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1808                 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1809         }
1810 }
1811
1812 #[cfg(test)]
1813 #[macro_export]
1814 macro_rules! get_route_and_payment_hash {
1815         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1816                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1817                         .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1818                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1819         }};
1820         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1821                 let (payment_preimage, payment_hash, payment_secret) =
1822                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1823                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1824                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1825         }}
1826 }
1827
1828 pub fn check_payment_claimable(
1829         event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1830         expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1831         expected_receiver_node_id: PublicKey,
1832 ) {
1833         match event {
1834                 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1835                         assert_eq!(expected_payment_hash, *payment_hash);
1836                         assert_eq!(expected_recv_value, *amount_msat);
1837                         assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1838                         match purpose {
1839                                 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1840                                         assert_eq!(&expected_payment_preimage, payment_preimage);
1841                                         assert_eq!(expected_payment_secret, *payment_secret);
1842                                 },
1843                                 _ => {},
1844                         }
1845                 },
1846                 _ => panic!("Unexpected event"),
1847         }
1848 }
1849
1850 #[macro_export]
1851 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1852 macro_rules! expect_payment_claimable {
1853         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1854                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1855         };
1856         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1857                 let events = $node.node.get_and_clear_pending_events();
1858                 assert_eq!(events.len(), 1);
1859                 $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)
1860         };
1861 }
1862
1863 #[macro_export]
1864 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1865 macro_rules! expect_payment_claimed {
1866         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1867                 let events = $node.node.get_and_clear_pending_events();
1868                 assert_eq!(events.len(), 1);
1869                 match events[0] {
1870                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1871                                 assert_eq!($expected_payment_hash, *payment_hash);
1872                                 assert_eq!($expected_recv_value, amount_msat);
1873                         },
1874                         _ => panic!("Unexpected event"),
1875                 }
1876         }
1877 }
1878
1879 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1880         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1881         expect_per_path_claims: bool,
1882 ) {
1883         let events = node.node().get_and_clear_pending_events();
1884         let expected_payment_hash = PaymentHash(
1885                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1886         if expect_per_path_claims {
1887                 assert!(events.len() > 1);
1888         } else {
1889                 assert_eq!(events.len(), 1);
1890         }
1891         let expected_payment_id = match events[0] {
1892                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1893                         assert_eq!(expected_payment_preimage, *payment_preimage);
1894                         assert_eq!(expected_payment_hash, *payment_hash);
1895                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
1896                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
1897                         } else {
1898                                 assert!(fee_paid_msat.is_some());
1899                         }
1900                         payment_id.unwrap()
1901                 },
1902                 _ => panic!("Unexpected event"),
1903         };
1904         if expect_per_path_claims {
1905                 for i in 1..events.len() {
1906                         match events[i] {
1907                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1908                                         assert_eq!(payment_id, expected_payment_id);
1909                                         assert_eq!(payment_hash, Some(expected_payment_hash));
1910                                 },
1911                                 _ => panic!("Unexpected event"),
1912                         }
1913                 }
1914         }
1915 }
1916
1917 #[cfg(test)]
1918 #[macro_export]
1919 macro_rules! expect_payment_sent_without_paths {
1920         ($node: expr, $expected_payment_preimage: expr) => {
1921                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1922         };
1923         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1924                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1925         }
1926 }
1927
1928 #[macro_export]
1929 macro_rules! expect_payment_sent {
1930         ($node: expr, $expected_payment_preimage: expr) => {
1931                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1932         };
1933         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1934                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1935         };
1936         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1937                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1938                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1939         }
1940 }
1941
1942 #[cfg(test)]
1943 #[macro_export]
1944 macro_rules! expect_payment_path_successful {
1945         ($node: expr) => {
1946                 let events = $node.node.get_and_clear_pending_events();
1947                 assert_eq!(events.len(), 1);
1948                 match events[0] {
1949                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
1950                         _ => panic!("Unexpected event"),
1951                 }
1952         }
1953 }
1954
1955 macro_rules! expect_payment_forwarded {
1956         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1957                 let events = $node.node.get_and_clear_pending_events();
1958                 assert_eq!(events.len(), 1);
1959                 match events[0] {
1960                         Event::PaymentForwarded {
1961                                 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1962                                 outbound_amount_forwarded_msat: _
1963                         } => {
1964                                 assert_eq!(fee_earned_msat, $expected_fee);
1965                                 if fee_earned_msat.is_some() {
1966                                         // Is the event prev_channel_id in one of the channels between the two nodes?
1967                                         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()));
1968                                 }
1969                                 // We check for force closures since a force closed channel is removed from the
1970                                 // node's channel list
1971                                 if !$downstream_force_closed {
1972                                         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()));
1973                                 }
1974                                 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1975                         },
1976                         _ => panic!("Unexpected event"),
1977                 }
1978         }
1979 }
1980
1981 #[cfg(test)]
1982 #[macro_export]
1983 macro_rules! expect_channel_shutdown_state {
1984         ($node: expr, $chan_id: expr, $state: path) => {
1985                 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
1986                 assert_eq!(chan_details.len(), 1);
1987                 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
1988         }
1989 }
1990
1991 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1992 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1993         let events = node.node.get_and_clear_pending_events();
1994         assert_eq!(events.len(), 1);
1995         match events[0] {
1996                 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1997                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1998                 },
1999                 _ => panic!("Unexpected event"),
2000         }
2001 }
2002
2003 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2004 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2005         let events = node.node.get_and_clear_pending_events();
2006         assert_eq!(events.len(), 1);
2007         match events[0] {
2008                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2009                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2010                 },
2011                 _ => panic!("Unexpected event"),
2012         }
2013 }
2014
2015 pub struct PaymentFailedConditions<'a> {
2016         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2017         pub(crate) expected_blamed_scid: Option<u64>,
2018         pub(crate) expected_blamed_chan_closed: Option<bool>,
2019         pub(crate) expected_mpp_parts_remain: bool,
2020 }
2021
2022 impl<'a> PaymentFailedConditions<'a> {
2023         pub fn new() -> Self {
2024                 Self {
2025                         expected_htlc_error_data: None,
2026                         expected_blamed_scid: None,
2027                         expected_blamed_chan_closed: None,
2028                         expected_mpp_parts_remain: false,
2029                 }
2030         }
2031         pub fn mpp_parts_remain(mut self) -> Self {
2032                 self.expected_mpp_parts_remain = true;
2033                 self
2034         }
2035         pub fn blamed_scid(mut self, scid: u64) -> Self {
2036                 self.expected_blamed_scid = Some(scid);
2037                 self
2038         }
2039         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2040                 self.expected_blamed_chan_closed = Some(closed);
2041                 self
2042         }
2043         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2044                 self.expected_htlc_error_data = Some((code, data));
2045                 self
2046         }
2047 }
2048
2049 #[cfg(test)]
2050 macro_rules! expect_payment_failed_with_update {
2051         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2052                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2053                         &$node, $expected_payment_hash, $payment_failed_permanently,
2054                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2055                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2056         }
2057 }
2058
2059 #[cfg(test)]
2060 macro_rules! expect_payment_failed {
2061         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2062                 #[allow(unused_mut)]
2063                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2064                 $(
2065                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2066                 )*
2067                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2068         };
2069 }
2070
2071 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2072         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2073         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2074 ) {
2075         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2076         let expected_payment_id = match &payment_failed_events[0] {
2077                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2078                         #[cfg(test)]
2079                         error_code,
2080                         #[cfg(test)]
2081                         error_data, .. } => {
2082                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2083                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2084                         #[cfg(test)]
2085                         {
2086                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2087                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2088                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2089                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2090                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2091                                 }
2092                         }
2093
2094                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2095                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2096                                         match upd {
2097                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2098                                                         if let Some(scid) = conditions.expected_blamed_scid {
2099                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2100                                                         }
2101                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2102                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2103                                                 },
2104                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2105                                                         if let Some(scid) = conditions.expected_blamed_scid {
2106                                                                 assert_eq!(*short_channel_id, scid);
2107                                                         }
2108                                                         assert!(is_permanent);
2109                                                 },
2110                                                 _ => panic!("Unexpected update type"),
2111                                         }
2112                                 } else { panic!("Expected network update"); }
2113                         }
2114
2115                         payment_id.unwrap()
2116                 },
2117                 _ => panic!("Unexpected event"),
2118         };
2119         if !conditions.expected_mpp_parts_remain {
2120                 match &payment_failed_events[1] {
2121                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2122                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2123                                 assert_eq!(*payment_id, expected_payment_id);
2124                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2125                                         PaymentFailureReason::RecipientRejected
2126                                 } else {
2127                                         PaymentFailureReason::RetriesExhausted
2128                                 });
2129                         }
2130                         _ => panic!("Unexpected second event"),
2131                 }
2132         }
2133 }
2134
2135 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2136         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2137         conditions: PaymentFailedConditions<'e>
2138 ) {
2139         let events = node.node.get_and_clear_pending_events();
2140         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2141 }
2142
2143 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 {
2144         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2145         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2146                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2147         check_added_monitors!(origin_node, expected_paths.len());
2148         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2149         payment_id
2150 }
2151
2152 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> {
2153         let mut payment_event = SendEvent::from_event(ev);
2154         let mut prev_node = origin_node;
2155         let mut event = None;
2156
2157         for (idx, &node) in expected_path.iter().enumerate() {
2158                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2159
2160                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2161                 check_added_monitors!(node, 0);
2162                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2163
2164                 expect_pending_htlcs_forwardable!(node);
2165
2166                 if idx == expected_path.len() - 1 && clear_recipient_events {
2167                         let events_2 = node.node.get_and_clear_pending_events();
2168                         if payment_claimable_expected {
2169                                 assert_eq!(events_2.len(), 1);
2170                                 match &events_2[0] {
2171                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2172                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2173                                                 claim_deadline, onion_fields, ..
2174                                         } => {
2175                                                 assert_eq!(our_payment_hash, *payment_hash);
2176                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2177                                                 assert!(onion_fields.is_some());
2178                                                 match &purpose {
2179                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2180                                                                 assert_eq!(expected_preimage, *payment_preimage);
2181                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2182                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2183                                                         },
2184                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2185                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2186                                                                 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2187                                                         },
2188                                                 }
2189                                                 assert_eq!(*amount_msat, recv_value);
2190                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2191                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2192                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2193                                         },
2194                                         _ => panic!("Unexpected event"),
2195                                 }
2196                                 event = Some(events_2[0].clone());
2197                         } else {
2198                                 assert!(events_2.is_empty());
2199                         }
2200                 } else if idx != expected_path.len() - 1 {
2201                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2202                         assert_eq!(events_2.len(), 1);
2203                         check_added_monitors!(node, 1);
2204                         payment_event = SendEvent::from_event(events_2.remove(0));
2205                         assert_eq!(payment_event.msgs.len(), 1);
2206                 }
2207
2208                 prev_node = node;
2209         }
2210         event
2211 }
2212
2213 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> {
2214         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2215 }
2216
2217 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) {
2218         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2219         assert_eq!(events.len(), expected_route.len());
2220         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2221                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2222                 // Once we've gotten through all the HTLCs, the last one should result in a
2223                 // PaymentClaimable (but each previous one should not!), .
2224                 let expect_payment = path_idx == expected_route.len() - 1;
2225                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2226         }
2227 }
2228
2229 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) {
2230         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2231         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2232         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2233 }
2234
2235 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2236         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2237         our_payment_preimage: PaymentPreimage
2238 ) -> u64 {
2239         let extra_fees = vec![0; expected_paths.len()];
2240         do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2241                 &extra_fees[..], skip_last, our_payment_preimage)
2242 }
2243
2244 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2245         origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2246         &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2247 ) -> u64 {
2248         assert_eq!(expected_paths.len(), expected_extra_fees.len());
2249         for path in expected_paths.iter() {
2250                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2251         }
2252         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2253
2254         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2255         assert_eq!(claim_event.len(), 1);
2256         match claim_event[0] {
2257                 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2258                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2259                         assert_eq!(preimage, our_payment_preimage),
2260                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2261                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2262                 _ => panic!(),
2263         }
2264
2265         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2266
2267         let mut expected_total_fee_msat = 0;
2268
2269         macro_rules! msgs_from_ev {
2270                 ($ev: expr) => {
2271                         match $ev {
2272                                 &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 } } => {
2273                                         assert!(update_add_htlcs.is_empty());
2274                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2275                                         assert!(update_fail_htlcs.is_empty());
2276                                         assert!(update_fail_malformed_htlcs.is_empty());
2277                                         assert!(update_fee.is_none());
2278                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2279                                 },
2280                                 _ => panic!("Unexpected event"),
2281                         }
2282                 }
2283         }
2284         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2285         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2286         assert_eq!(events.len(), expected_paths.len());
2287
2288         if events.len() == 1 {
2289                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2290         } else {
2291                 for expected_path in expected_paths.iter() {
2292                         // For MPP payments, we always want the message to the first node in the path.
2293                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2294                         per_path_msgs.push(msgs_from_ev!(&ev));
2295                 }
2296         }
2297
2298         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2299                 let mut next_msgs = Some(path_msgs);
2300                 let mut expected_next_node = next_hop;
2301
2302                 macro_rules! last_update_fulfill_dance {
2303                         ($node: expr, $prev_node: expr) => {
2304                                 {
2305                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2306                                         check_added_monitors!($node, 0);
2307                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2308                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2309                                 }
2310                         }
2311                 }
2312                 macro_rules! mid_update_fulfill_dance {
2313                         ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2314                                 {
2315                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2316                                         let mut fee = {
2317                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2318                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2319                                                         .unwrap().lock().unwrap();
2320                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2321                                                 if let Some(prev_config) = channel.context.prev_config() {
2322                                                         prev_config.forwarding_fee_base_msat
2323                                                 } else {
2324                                                         channel.context.config().forwarding_fee_base_msat
2325                                                 }
2326                                         };
2327                                         if $idx == 1 { fee += expected_extra_fees[i]; }
2328                                         expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2329                                         expected_total_fee_msat += fee as u64;
2330                                         check_added_monitors!($node, 1);
2331                                         let new_next_msgs = if $new_msgs {
2332                                                 let events = $node.node.get_and_clear_pending_msg_events();
2333                                                 assert_eq!(events.len(), 1);
2334                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2335                                                 expected_next_node = nexthop;
2336                                                 Some(res)
2337                                         } else {
2338                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2339                                                 None
2340                                         };
2341                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2342                                         next_msgs = new_next_msgs;
2343                                 }
2344                         }
2345                 }
2346
2347                 let mut prev_node = expected_route.last().unwrap();
2348                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2349                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2350                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2351                         if next_msgs.is_some() {
2352                                 // Since we are traversing in reverse, next_node is actually the previous node
2353                                 let next_node: &Node;
2354                                 if idx == expected_route.len() - 1 {
2355                                         next_node = origin_node;
2356                                 } else {
2357                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2358                                 }
2359                                 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2360                         } else {
2361                                 assert!(!update_next_msgs);
2362                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2363                         }
2364                         if !skip_last && idx == expected_route.len() - 1 {
2365                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2366                         }
2367
2368                         prev_node = node;
2369                 }
2370
2371                 if !skip_last {
2372                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2373                 }
2374         }
2375
2376         // Ensure that claim_funds is idempotent.
2377         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2378         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2379         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2380
2381         expected_total_fee_msat
2382 }
2383 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) {
2384         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2385         if !skip_last {
2386                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2387         }
2388 }
2389
2390 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2391         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2392 }
2393
2394 pub const TEST_FINAL_CLTV: u32 = 70;
2395
2396 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) {
2397         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2398                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2399         let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2400         assert_eq!(route.paths.len(), 1);
2401         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2402         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2403                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2404         }
2405
2406         let res = send_along_route(origin_node, route, expected_route, recv_value);
2407         (res.0, res.1, res.2)
2408 }
2409
2410 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2411         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2412                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2413         let network_graph = origin_node.network_graph.read_only();
2414         let scorer = test_utils::TestScorer::new();
2415         let seed = [0u8; 32];
2416         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2417         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2418         let route = router::get_route(
2419                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2420                 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2421         assert_eq!(route.paths.len(), 1);
2422         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2423         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2424                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2425         }
2426
2427         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2428         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2429                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2430                 true, APIError::ChannelUnavailable { ref err },
2431                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2432 }
2433
2434 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2435         let res = route_payment(&origin, expected_route, recv_value);
2436         claim_payment(&origin, expected_route, res.0);
2437         res
2438 }
2439
2440 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) {
2441         for path in expected_paths.iter() {
2442                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2443         }
2444         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2445         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2446         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2447
2448         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2449 }
2450
2451 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) {
2452         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2453         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2454
2455         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2456         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2457         assert_eq!(events.len(), expected_paths.len());
2458         for ev in events.iter() {
2459                 let (update_fail, commitment_signed, node_id) = match ev {
2460                         &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 } } => {
2461                                 assert!(update_add_htlcs.is_empty());
2462                                 assert!(update_fulfill_htlcs.is_empty());
2463                                 assert_eq!(update_fail_htlcs.len(), 1);
2464                                 assert!(update_fail_malformed_htlcs.is_empty());
2465                                 assert!(update_fee.is_none());
2466                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2467                         },
2468                         _ => panic!("Unexpected event"),
2469                 };
2470                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2471         }
2472         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2473         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()));
2474
2475         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2476                 let mut next_msgs = Some(path_msgs);
2477                 let mut expected_next_node = next_hop;
2478                 let mut prev_node = expected_route.last().unwrap();
2479
2480                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2481                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2482                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2483                         if next_msgs.is_some() {
2484                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2485                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2486                                 if !update_next_node {
2487                                         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 }]);
2488                                 }
2489                         }
2490                         let events = node.node.get_and_clear_pending_msg_events();
2491                         if update_next_node {
2492                                 assert_eq!(events.len(), 1);
2493                                 match events[0] {
2494                                         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 } } => {
2495                                                 assert!(update_add_htlcs.is_empty());
2496                                                 assert!(update_fulfill_htlcs.is_empty());
2497                                                 assert_eq!(update_fail_htlcs.len(), 1);
2498                                                 assert!(update_fail_malformed_htlcs.is_empty());
2499                                                 assert!(update_fee.is_none());
2500                                                 expected_next_node = node_id.clone();
2501                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2502                                         },
2503                                         _ => panic!("Unexpected event"),
2504                                 }
2505                         } else {
2506                                 assert!(events.is_empty());
2507                         }
2508                         if !skip_last && idx == expected_route.len() - 1 {
2509                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2510                         }
2511
2512                         prev_node = node;
2513                 }
2514
2515                 if !skip_last {
2516                         let prev_node = expected_route.first().unwrap();
2517                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2518                         check_added_monitors!(origin_node, 0);
2519                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2520                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2521                         let events = origin_node.node.get_and_clear_pending_events();
2522                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2523
2524                         let expected_payment_id = match events[0] {
2525                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2526                                         assert_eq!(payment_hash, our_payment_hash);
2527                                         assert!(payment_failed_permanently);
2528                                         for (idx, hop) in expected_route.iter().enumerate() {
2529                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2530                                         }
2531                                         payment_id.unwrap()
2532                                 },
2533                                 _ => panic!("Unexpected event"),
2534                         };
2535                         if i == expected_paths.len() - 1 {
2536                                 match events[1] {
2537                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2538                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2539                                                 assert_eq!(*payment_id, expected_payment_id);
2540                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2541                                         }
2542                                         _ => panic!("Unexpected second event"),
2543                                 }
2544                         }
2545                 }
2546         }
2547
2548         // Ensure that fail_htlc_backwards is idempotent.
2549         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2550         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2551         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2552         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2553 }
2554
2555 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2556         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2557 }
2558
2559 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2560         let mut chan_mon_cfgs = Vec::new();
2561         for i in 0..node_count {
2562                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2563                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2564                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2565                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2566                 let persister = test_utils::TestPersister::new();
2567                 let seed = [i as u8; 32];
2568                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2569                 let scorer = Mutex::new(test_utils::TestScorer::new());
2570
2571                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2572         }
2573
2574         chan_mon_cfgs
2575 }
2576
2577 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2578         let mut nodes = Vec::new();
2579
2580         for i in 0..node_count {
2581                 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);
2582                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2583                 let seed = [i as u8; 32];
2584                 nodes.push(NodeCfg {
2585                         chain_source: &chanmon_cfgs[i].chain_source,
2586                         logger: &chanmon_cfgs[i].logger,
2587                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2588                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2589                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2590                         chain_monitor,
2591                         keys_manager: &chanmon_cfgs[i].keys_manager,
2592                         node_seed: seed,
2593                         network_graph,
2594                         override_init_features: Rc::new(RefCell::new(None)),
2595                 });
2596         }
2597
2598         nodes
2599 }
2600
2601 pub fn test_default_channel_config() -> UserConfig {
2602         let mut default_config = UserConfig::default();
2603         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2604         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2605         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2606         default_config.channel_handshake_config.announced_channel = true;
2607         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2608         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2609         // It now defaults to 1, so we simply set it to the expected value here.
2610         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2611         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2612         // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2613         // feerate of 253).
2614         default_config.channel_config.max_dust_htlc_exposure =
2615                 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2616         default_config
2617 }
2618
2619 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>> {
2620         let mut chanmgrs = Vec::new();
2621         for i in 0..node_count {
2622                 let network = Network::Testnet;
2623                 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2624                 let params = ChainParameters {
2625                         network,
2626                         best_block: BestBlock::from_network(network),
2627                 };
2628                 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,
2629                         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);
2630                 chanmgrs.push(node);
2631         }
2632
2633         chanmgrs
2634 }
2635
2636 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>> {
2637         let mut nodes = Vec::new();
2638         let chan_count = Rc::new(RefCell::new(0));
2639         let payment_count = Rc::new(RefCell::new(0));
2640         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2641
2642         for i in 0..node_count {
2643                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2644                 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2645                 nodes.push(Node{
2646                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2647                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2648                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2649                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2650                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2651                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2652                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2653                         connect_style: Rc::clone(&connect_style),
2654                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2655                         wallet_source: Arc::clone(&wallet_source),
2656                         bump_tx_handler: BumpTransactionEventHandler::new(
2657                                 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2658                                 &cfgs[i].keys_manager, cfgs[i].logger,
2659                         ),
2660                 })
2661         }
2662
2663         for i in 0..node_count {
2664                 for j in (i+1)..node_count {
2665                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2666                                 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2667                                 networks: None,
2668                                 remote_network_address: None,
2669                         }, true).unwrap();
2670                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2671                                 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2672                                 networks: None,
2673                                 remote_network_address: None,
2674                         }, false).unwrap();
2675                 }
2676         }
2677
2678         nodes
2679 }
2680
2681 // Note that the following only works for CLTV values up to 128
2682 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2683
2684 #[derive(PartialEq)]
2685 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2686 /// Tests that the given node has broadcast transactions for the given Channel
2687 ///
2688 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2689 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2690 /// broadcast and the revoked outputs were claimed.
2691 ///
2692 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2693 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2694 ///
2695 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2696 /// also fail.
2697 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>  {
2698         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2699         let mut txn_seen = HashSet::new();
2700         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2701         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2702
2703         let mut res = Vec::with_capacity(2);
2704         node_txn.retain(|tx| {
2705                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2706                         check_spends!(tx, chan.3);
2707                         if commitment_tx.is_none() {
2708                                 res.push(tx.clone());
2709                         }
2710                         false
2711                 } else { true }
2712         });
2713         if let Some(explicit_tx) = commitment_tx {
2714                 res.push(explicit_tx.clone());
2715         }
2716
2717         assert_eq!(res.len(), 1);
2718
2719         if has_htlc_tx != HTLCType::NONE {
2720                 node_txn.retain(|tx| {
2721                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2722                                 check_spends!(tx, res[0]);
2723                                 if has_htlc_tx == HTLCType::TIMEOUT {
2724                                         assert!(tx.lock_time.0 != 0);
2725                                 } else {
2726                                         assert!(tx.lock_time.0 == 0);
2727                                 }
2728                                 res.push(tx.clone());
2729                                 false
2730                         } else { true }
2731                 });
2732                 assert!(res.len() == 2 || res.len() == 3);
2733                 if res.len() == 3 {
2734                         assert_eq!(res[1], res[2]);
2735                 }
2736         }
2737
2738         assert!(node_txn.is_empty());
2739         res
2740 }
2741
2742 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2743 /// HTLC transaction.
2744 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2745         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2746         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2747         // for revoked htlc outputs
2748         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2749         node_txn.retain(|tx| {
2750                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2751                         check_spends!(tx, revoked_tx);
2752                         false
2753                 } else { true }
2754         });
2755         node_txn.retain(|tx| {
2756                 check_spends!(tx, commitment_revoked_tx);
2757                 false
2758         });
2759         assert!(node_txn.is_empty());
2760 }
2761
2762 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2763         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2764         let mut txn_seen = HashSet::new();
2765         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2766
2767         let mut found_prev = false;
2768         for prev_tx in prev_txn {
2769                 for tx in &*node_txn {
2770                         if tx.input[0].previous_output.txid == prev_tx.txid() {
2771                                 check_spends!(tx, prev_tx);
2772                                 let mut iter = tx.input[0].witness.iter();
2773                                 iter.next().expect("expected 3 witness items");
2774                                 iter.next().expect("expected 3 witness items");
2775                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2776                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2777
2778                                 found_prev = true;
2779                                 break;
2780                         }
2781                 }
2782         }
2783         assert!(found_prev);
2784
2785         let mut res = Vec::new();
2786         mem::swap(&mut *node_txn, &mut res);
2787         res
2788 }
2789
2790 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)  {
2791         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2792         assert_eq!(events_1.len(), 2);
2793         let as_update = match events_1[0] {
2794                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2795                         msg.clone()
2796                 },
2797                 _ => panic!("Unexpected event"),
2798         };
2799         match events_1[1] {
2800                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2801                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2802                         assert_eq!(msg.data, expected_error);
2803                         if needs_err_handle {
2804                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2805                         }
2806                 },
2807                 _ => panic!("Unexpected event"),
2808         }
2809
2810         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2811         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2812         let bs_update = match events_2[0] {
2813                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2814                         msg.clone()
2815                 },
2816                 _ => panic!("Unexpected event"),
2817         };
2818         if !needs_err_handle {
2819                 match events_2[1] {
2820                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2821                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2822                                 assert_eq!(msg.data, expected_error);
2823                         },
2824                         _ => panic!("Unexpected event"),
2825                 }
2826         }
2827
2828         for node in nodes {
2829                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2830                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2831         }
2832 }
2833
2834 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2835         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2836 }
2837
2838 #[cfg(test)]
2839 macro_rules! get_channel_value_stat {
2840         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2841                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2842                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2843                 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2844                 chan.get_value_stat()
2845         }}
2846 }
2847
2848 macro_rules! get_chan_reestablish_msgs {
2849         ($src_node: expr, $dst_node: expr) => {
2850                 {
2851                         let mut announcements = $crate::prelude::HashSet::new();
2852                         let mut res = Vec::with_capacity(1);
2853                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2854                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2855                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2856                                         res.push(msg.clone());
2857                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2858                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2859                                         announcements.insert(msg.contents.short_channel_id);
2860                                 } else {
2861                                         panic!("Unexpected event")
2862                                 }
2863                         }
2864                         assert!(announcements.is_empty());
2865                         res
2866                 }
2867         }
2868 }
2869
2870 macro_rules! handle_chan_reestablish_msgs {
2871         ($src_node: expr, $dst_node: expr) => {
2872                 {
2873                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2874                         let mut idx = 0;
2875                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2876                                 idx += 1;
2877                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2878                                 Some(msg.clone())
2879                         } else {
2880                                 None
2881                         };
2882
2883                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2884                                 idx += 1;
2885                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2886                         }
2887
2888                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2889                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2890                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2891                                 idx += 1;
2892                                 had_channel_update = true;
2893                         }
2894
2895                         let mut revoke_and_ack = None;
2896                         let mut commitment_update = None;
2897                         let order = if let Some(ev) = msg_events.get(idx) {
2898                                 match ev {
2899                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2900                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2901                                                 revoke_and_ack = Some(msg.clone());
2902                                                 idx += 1;
2903                                                 RAACommitmentOrder::RevokeAndACKFirst
2904                                         },
2905                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2906                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2907                                                 commitment_update = Some(updates.clone());
2908                                                 idx += 1;
2909                                                 RAACommitmentOrder::CommitmentFirst
2910                                         },
2911                                         _ => RAACommitmentOrder::CommitmentFirst,
2912                                 }
2913                         } else {
2914                                 RAACommitmentOrder::CommitmentFirst
2915                         };
2916
2917                         if let Some(ev) = msg_events.get(idx) {
2918                                 match ev {
2919                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2920                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2921                                                 assert!(revoke_and_ack.is_none());
2922                                                 revoke_and_ack = Some(msg.clone());
2923                                                 idx += 1;
2924                                         },
2925                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2926                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2927                                                 assert!(commitment_update.is_none());
2928                                                 commitment_update = Some(updates.clone());
2929                                                 idx += 1;
2930                                         },
2931                                         _ => {},
2932                                 }
2933                         }
2934
2935                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2936                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2937                                 idx += 1;
2938                                 assert!(!had_channel_update);
2939                         }
2940
2941                         assert_eq!(msg_events.len(), idx);
2942
2943                         (channel_ready, revoke_and_ack, commitment_update, order)
2944                 }
2945         }
2946 }
2947
2948 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2949 /// for claims/fails they are separated out.
2950 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_channel_ready: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
2951         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
2952                 features: node_b.node.init_features(), networks: None, remote_network_address: None
2953         }, true).unwrap();
2954         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2955         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
2956                 features: node_a.node.init_features(), networks: None, remote_network_address: None
2957         }, false).unwrap();
2958         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2959
2960         if send_channel_ready.0 {
2961                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2962                 // from b
2963                 for reestablish in reestablish_1.iter() {
2964                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2965                 }
2966         }
2967         if send_channel_ready.1 {
2968                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2969                 // from a
2970                 for reestablish in reestablish_2.iter() {
2971                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2972                 }
2973         }
2974         if send_channel_ready.0 || send_channel_ready.1 {
2975                 // If we expect any channel_ready's, both sides better have set
2976                 // next_holder_commitment_number to 1
2977                 for reestablish in reestablish_1.iter() {
2978                         assert_eq!(reestablish.next_local_commitment_number, 1);
2979                 }
2980                 for reestablish in reestablish_2.iter() {
2981                         assert_eq!(reestablish.next_local_commitment_number, 1);
2982                 }
2983         }
2984
2985         let mut resp_1 = Vec::new();
2986         for msg in reestablish_1 {
2987                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2988                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2989         }
2990         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2991                 check_added_monitors!(node_b, 1);
2992         } else {
2993                 check_added_monitors!(node_b, 0);
2994         }
2995
2996         let mut resp_2 = Vec::new();
2997         for msg in reestablish_2 {
2998                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2999                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3000         }
3001         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3002                 check_added_monitors!(node_a, 1);
3003         } else {
3004                 check_added_monitors!(node_a, 0);
3005         }
3006
3007         // We don't yet support both needing updates, as that would require a different commitment dance:
3008         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3009                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3010                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3011                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3012
3013         for chan_msgs in resp_1.drain(..) {
3014                 if send_channel_ready.0 {
3015                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3016                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3017                         if !announcement_event.is_empty() {
3018                                 assert_eq!(announcement_event.len(), 1);
3019                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3020                                         //TODO: Test announcement_sigs re-sending
3021                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3022                         }
3023                 } else {
3024                         assert!(chan_msgs.0.is_none());
3025                 }
3026                 if pending_raa.0 {
3027                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3028                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3029                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3030                         check_added_monitors!(node_a, 1);
3031                 } else {
3032                         assert!(chan_msgs.1.is_none());
3033                 }
3034                 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 {
3035                         let commitment_update = chan_msgs.2.unwrap();
3036                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3037                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3038                         } else {
3039                                 assert!(commitment_update.update_add_htlcs.is_empty());
3040                         }
3041                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3042                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3043                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3044                         for update_add in commitment_update.update_add_htlcs {
3045                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3046                         }
3047                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3048                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3049                         }
3050                         for update_fail in commitment_update.update_fail_htlcs {
3051                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3052                         }
3053
3054                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3055                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3056                         } else {
3057                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3058                                 check_added_monitors!(node_a, 1);
3059                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3060                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3061                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3062                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3063                                 check_added_monitors!(node_b, 1);
3064                         }
3065                 } else {
3066                         assert!(chan_msgs.2.is_none());
3067                 }
3068         }
3069
3070         for chan_msgs in resp_2.drain(..) {
3071                 if send_channel_ready.1 {
3072                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3073                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3074                         if !announcement_event.is_empty() {
3075                                 assert_eq!(announcement_event.len(), 1);
3076                                 match announcement_event[0] {
3077                                         MessageSendEvent::SendChannelUpdate { .. } => {},
3078                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3079                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3080                                 }
3081                         }
3082                 } else {
3083                         assert!(chan_msgs.0.is_none());
3084                 }
3085                 if pending_raa.1 {
3086                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3087                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3088                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3089                         check_added_monitors!(node_b, 1);
3090                 } else {
3091                         assert!(chan_msgs.1.is_none());
3092                 }
3093                 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 {
3094                         let commitment_update = chan_msgs.2.unwrap();
3095                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3096                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3097                         }
3098                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3099                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3100                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3101                         for update_add in commitment_update.update_add_htlcs {
3102                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3103                         }
3104                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3105                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3106                         }
3107                         for update_fail in commitment_update.update_fail_htlcs {
3108                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3109                         }
3110
3111                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3112                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3113                         } else {
3114                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3115                                 check_added_monitors!(node_b, 1);
3116                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3117                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3118                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3119                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3120                                 check_added_monitors!(node_a, 1);
3121                         }
3122                 } else {
3123                         assert!(chan_msgs.2.is_none());
3124                 }
3125         }
3126 }