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