git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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