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