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