_ 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 chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::KeysInterface};
  14 use chain::channelmonitor::ChannelMonitor;
  15 use chain::transaction::OutPoint;
  16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
  17 use ln::channelmanager::{self, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId, MIN_CLTV_EXPIRY_DELTA};
  18 use routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
  19 use routing::router::{PaymentParameters, Route, get_route};
  20 use ln::features::InitFeatures;
  21 use ln::msgs;
  22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
  23 use util::enforcing_trait_impls::EnforcingSigner;
  24 use util::scid_utils;
  25 use util::test_utils;
  26 use util::test_utils::{panicking, TestChainMonitor};
  27 use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
  28 use util::errors::APIError;
  29 use util::config::UserConfig;
  30 use 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 io;
  44 use prelude::*;
  45 use core::cell::RefCell;
  46 use alloc::rc::Rc;
  47 use 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<EnforcingSigner, &'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<EnforcingSigner, &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: u64) -> ([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         (tx, as_channel_ready.channel_id)
 745 }
 746
 747 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 {
 748         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 749         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
 750         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
 751         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
 752         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
 753         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
 754         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
 755
 756         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
 757 }
 758
 759 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) {
 760         confirm_transaction_at(node_conf, tx, conf_height);
 761         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
 762         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()));
 763 }
 764
 765 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]) {
 766         let channel_id;
 767         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 768         assert_eq!(events_6.len(), 3);
 769         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
 770                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
 771                 2
 772         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
 773                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
 774                 1
 775         } else { panic!("Unexpected event: {:?}", events_6[1]); };
 776         ((match events_6[0] {
 777                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
 778                         channel_id = msg.channel_id.clone();
 779                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 780                         msg.clone()
 781                 },
 782                 _ => panic!("Unexpected event"),
 783         }, match events_6[announcement_sigs_idx] {
 784                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 785                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 786                         msg.clone()
 787                 },
 788                 _ => panic!("Unexpected event"),
 789         }), channel_id)
 790 }
 791
 792 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]) {
 793         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
 794         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
 795         confirm_transaction_at(node_a, tx, conf_height);
 796         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
 797         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 798 }
 799
 800 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) {
 801         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 802         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 803         (msgs, chan_id, tx)
 804 }
 805
 806 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) {
 807         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 808         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 809         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 810
 811         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 812         assert_eq!(events_7.len(), 1);
 813         let (announcement, bs_update) = match events_7[0] {
 814                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 815                         (msg, update_msg)
 816                 },
 817                 _ => panic!("Unexpected event"),
 818         };
 819
 820         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 821         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 822         assert_eq!(events_8.len(), 1);
 823         let as_update = match events_8[0] {
 824                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 825                         assert!(*announcement == *msg);
 826                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 827                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 828                         update_msg
 829                 },
 830                 _ => panic!("Unexpected event"),
 831         };
 832
 833         *node_a.network_chan_count.borrow_mut() += 1;
 834
 835         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 836 }
 837
 838 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) {
 839         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 840 }
 841
 842 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) {
 843         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 844         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
 845         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 846 }
 847
 848 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) {
 849         let mut no_announce_cfg = test_default_channel_config();
 850         no_announce_cfg.channel_handshake_config.announced_channel = false;
 851         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
 852         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
 853         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
 854         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
 855         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
 856
 857         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
 858         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
 859         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()));
 860         check_added_monitors!(nodes[b], 1);
 861
 862         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
 863         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
 864         check_added_monitors!(nodes[a], 1);
 865
 866         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
 867         confirm_transaction_at(&nodes[a], &tx, conf_height);
 868         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
 869         confirm_transaction_at(&nodes[b], &tx, conf_height);
 870         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
 871         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
 872         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()));
 873         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
 874         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
 875         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
 876
 877         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
 878         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
 879
 880         let mut found_a = false;
 881         for chan in nodes[a].node.list_usable_channels() {
 882                 if chan.channel_id == as_channel_ready.channel_id {
 883                         assert!(!found_a);
 884                         found_a = true;
 885                         assert!(!chan.is_public);
 886                 }
 887         }
 888         assert!(found_a);
 889
 890         let mut found_b = false;
 891         for chan in nodes[b].node.list_usable_channels() {
 892                 if chan.channel_id == as_channel_ready.channel_id {
 893                         assert!(!found_b);
 894                         found_b = true;
 895                         assert!(!chan.is_public);
 896                 }
 897         }
 898         assert!(found_b);
 899
 900         (as_channel_ready, tx)
 901 }
 902
 903 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) {
 904         for node in nodes {
 905                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
 906                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
 907                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
 908
 909                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
 910                 // forwarding info for local channels even if its not accepted in the network graph.
 911                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
 912                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
 913         }
 914 }
 915
 916 #[macro_export]
 917 macro_rules! check_spends {
 918         ($tx: expr, $($spends_txn: expr),*) => {
 919                 {
 920                         $(
 921                         for outp in $spends_txn.output.iter() {
 922                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
 923                         }
 924                         )*
 925                         for outp in $tx.output.iter() {
 926                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
 927                         }
 928                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 929                                 $(
 930                                         if out_point.txid == $spends_txn.txid() {
 931                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 932                                         }
 933                                 )*
 934                                 None
 935                         };
 936                         let mut total_value_in = 0;
 937                         for input in $tx.input.iter() {
 938                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 939                         }
 940                         let mut total_value_out = 0;
 941                         for output in $tx.output.iter() {
 942                                 total_value_out += output.value;
 943                         }
 944                         let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 945                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 946                         assert!(total_value_out + min_fee <= total_value_in);
 947                         $tx.verify(get_output).unwrap();
 948                 }
 949         }
 950 }
 951
 952 macro_rules! get_closing_signed_broadcast {
 953         ($node: expr, $dest_pubkey: expr) => {
 954                 {
 955                         let events = $node.get_and_clear_pending_msg_events();
 956                         assert!(events.len() == 1 || events.len() == 2);
 957                         (match events[events.len() - 1] {
 958                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 959                                         assert_eq!(msg.contents.flags & 2, 2);
 960                                         msg.clone()
 961                                 },
 962                                 _ => panic!("Unexpected event"),
 963                         }, if events.len() == 2 {
 964                                 match events[0] {
 965                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 966                                                 assert_eq!(*node_id, $dest_pubkey);
 967                                                 Some(msg.clone())
 968                                         },
 969                                         _ => panic!("Unexpected event"),
 970                                 }
 971                         } else { None })
 972                 }
 973         }
 974 }
 975
 976 #[cfg(test)]
 977 macro_rules! check_warn_msg {
 978         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
 979                 let msg_events = $node.node.get_and_clear_pending_msg_events();
 980                 assert_eq!(msg_events.len(), 1);
 981                 match msg_events[0] {
 982                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
 983                                 assert_eq!(node_id, $recipient_node_id);
 984                                 assert_eq!(msg.channel_id, $chan_id);
 985                                 msg.data.clone()
 986                         },
 987                         _ => panic!("Unexpected event"),
 988                 }
 989         }}
 990 }
 991
 992 /// Check that a channel's closing channel update has been broadcasted, and optionally
 993 /// check whether an error message event has occurred.
 994 #[macro_export]
 995 macro_rules! check_closed_broadcast {
 996         ($node: expr, $with_error_msg: expr) => {{
 997                 use $crate::util::events::MessageSendEvent;
 998                 use $crate::ln::msgs::ErrorAction;
 999
1000                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1001                 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1002                 match msg_events[0] {
1003                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1004                                 assert_eq!(msg.contents.flags & 2, 2);
1005                         },
1006                         _ => panic!("Unexpected event"),
1007                 }
1008                 if $with_error_msg {
1009                         match msg_events[1] {
1010                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1011                                         // TODO: Check node_id
1012                                         Some(msg.clone())
1013                                 },
1014                                 _ => panic!("Unexpected event"),
1015                         }
1016                 } else { None }
1017         }}
1018 }
1019
1020 /// Check that a channel's closing channel events has been issued
1021 #[macro_export]
1022 macro_rules! check_closed_event {
1023         ($node: expr, $events: expr, $reason: expr) => {
1024                 check_closed_event!($node, $events, $reason, false);
1025         };
1026         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1027                 use $crate::util::events::Event;
1028
1029                 let events = $node.node.get_and_clear_pending_events();
1030                 assert_eq!(events.len(), $events);
1031                 let expected_reason = $reason;
1032                 let mut issues_discard_funding = false;
1033                 for event in events {
1034                         match event {
1035                                 Event::ChannelClosed { ref reason, .. } => {
1036                                         assert_eq!(*reason, expected_reason);
1037                                 },
1038                                 Event::DiscardFunding { .. } => {
1039                                         issues_discard_funding = true;
1040                                 }
1041                                 _ => panic!("Unexpected event"),
1042                         }
1043                 }
1044                 assert_eq!($is_check_discard_funding, issues_discard_funding);
1045         }}
1046 }
1047
1048 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) {
1049         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) };
1050         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) };
1051         let (tx_a, tx_b);
1052
1053         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1054         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()));
1055
1056         let events_1 = node_b.get_and_clear_pending_msg_events();
1057         assert!(events_1.len() >= 1);
1058         let shutdown_b = match events_1[0] {
1059                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1060                         assert_eq!(node_id, &node_a.get_our_node_id());
1061                         msg.clone()
1062                 },
1063                 _ => panic!("Unexpected event"),
1064         };
1065
1066         let closing_signed_b = if !close_inbound_first {
1067                 assert_eq!(events_1.len(), 1);
1068                 None
1069         } else {
1070                 Some(match events_1[1] {
1071                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1072                                 assert_eq!(node_id, &node_a.get_our_node_id());
1073                                 msg.clone()
1074                         },
1075                         _ => panic!("Unexpected event"),
1076                 })
1077         };
1078
1079         node_a.handle_shutdown(&node_b.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown_b);
1080         let (as_update, bs_update) = if close_inbound_first {
1081                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1082                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1083
1084                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1085                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1086                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1087                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1088
1089                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1090                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1091                 assert!(none_a.is_none());
1092                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1093                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1094                 (as_update, bs_update)
1095         } else {
1096                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1097
1098                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1099                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1100
1101                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1102                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1103                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1104
1105                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1106                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1107                 assert!(none_b.is_none());
1108                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1109                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1110                 (as_update, bs_update)
1111         };
1112         assert_eq!(tx_a, tx_b);
1113         check_spends!(tx_a, funding_tx);
1114
1115         (as_update, bs_update, tx_a)
1116 }
1117
1118 pub struct SendEvent {
1119         pub node_id: PublicKey,
1120         pub msgs: Vec<msgs::UpdateAddHTLC>,
1121         pub commitment_msg: msgs::CommitmentSigned,
1122 }
1123 impl SendEvent {
1124         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1125                 assert!(updates.update_fulfill_htlcs.is_empty());
1126                 assert!(updates.update_fail_htlcs.is_empty());
1127                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1128                 assert!(updates.update_fee.is_none());
1129                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1130         }
1131
1132         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1133                 match event {
1134                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1135                         _ => panic!("Unexpected event type!"),
1136                 }
1137         }
1138
1139         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1140                 let mut events = node.node.get_and_clear_pending_msg_events();
1141                 assert_eq!(events.len(), 1);
1142                 SendEvent::from_event(events.pop().unwrap())
1143         }
1144 }
1145
1146 #[macro_export]
1147 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1148 /// commitment update.
1149 macro_rules! commitment_signed_dance {
1150         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1151                 {
1152                         check_added_monitors!($node_a, 0);
1153                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1154                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1155                         check_added_monitors!($node_a, 1);
1156                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1157                 }
1158         };
1159         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1160                 {
1161                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1162                         check_added_monitors!($node_b, 0);
1163                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1164                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1165                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1166                         check_added_monitors!($node_b, 1);
1167                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1168                         let (bs_revoke_and_ack, extra_msg_option) = {
1169                                 let events = $node_b.node.get_and_clear_pending_msg_events();
1170                                 assert!(events.len() <= 2);
1171                                 (match events[0] {
1172                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1173                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1174                                                 (*msg).clone()
1175                                         },
1176                                         _ => panic!("Unexpected event"),
1177                                 }, events.get(1).map(|e| e.clone()))
1178                         };
1179                         check_added_monitors!($node_b, 1);
1180                         if $fail_backwards {
1181                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1182                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1183                         }
1184                         (extra_msg_option, bs_revoke_and_ack)
1185                 }
1186         };
1187         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1188                 {
1189                         check_added_monitors!($node_a, 0);
1190                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1191                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1192                         check_added_monitors!($node_a, 1);
1193                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1194                         assert!(extra_msg_option.is_none());
1195                         bs_revoke_and_ack
1196                 }
1197         };
1198         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1199                 {
1200                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1201                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1202                         check_added_monitors!($node_a, 1);
1203                         extra_msg_option
1204                 }
1205         };
1206         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1207                 {
1208                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1209                 }
1210         };
1211         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1212                 {
1213                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1214                         if $fail_backwards {
1215                                 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 }]);
1216                                 check_added_monitors!($node_a, 1);
1217
1218                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
1219                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
1220                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1221                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
1222                                 } else { panic!("Unexpected event"); }
1223                         } else {
1224                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1225                         }
1226                 }
1227         }
1228 }
1229
1230 /// Get a payment preimage and hash.
1231 #[macro_export]
1232 macro_rules! get_payment_preimage_hash {
1233         ($dest_node: expr) => {
1234                 {
1235                         get_payment_preimage_hash!($dest_node, None)
1236                 }
1237         };
1238         ($dest_node: expr, $min_value_msat: expr) => {
1239                 {
1240                         use bitcoin::hashes::Hash as _;
1241                         let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1242                         let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1243                         *payment_count += 1;
1244                         let payment_hash = $crate::ln::PaymentHash(
1245                                 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1246                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1247                         (payment_preimage, payment_hash, payment_secret)
1248                 }
1249         }
1250 }
1251
1252 #[macro_export]
1253 macro_rules! get_route {
1254         ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1255                 use $crate::chain::keysinterface::KeysInterface;
1256                 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1257                 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1258                 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1259                 $crate::routing::router::get_route(
1260                         &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1261                         Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1262                         $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1263                 )
1264         }}
1265 }
1266
1267 #[cfg(test)]
1268 #[macro_export]
1269 macro_rules! get_route_and_payment_hash {
1270         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1271                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1272                         .with_features($crate::ln::channelmanager::provided_invoice_features());
1273                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1274         }};
1275         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1276                 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1277                 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1278                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1279         }}
1280 }
1281
1282 #[macro_export]
1283 macro_rules! expect_pending_htlcs_forwardable_conditions {
1284         ($node: expr, $expected_failures: expr) => {{
1285                 let expected_failures = $expected_failures;
1286                 let events = $node.node.get_and_clear_pending_events();
1287                 match events[0] {
1288                         $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1289                         _ => panic!("Unexpected event"),
1290                 };
1291
1292                 let count = expected_failures.len() + 1;
1293                 assert_eq!(events.len(), count);
1294
1295                 if expected_failures.len() > 0 {
1296                         expect_htlc_handling_failed_destinations!(events, expected_failures)
1297                 }
1298         }}
1299 }
1300
1301 #[macro_export]
1302 macro_rules! expect_htlc_handling_failed_destinations {
1303         ($events: expr, $expected_failures: expr) => {{
1304                 for event in $events {
1305                         match event {
1306                                 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1307                                 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1308                                         assert!($expected_failures.contains(&failed_next_destination))
1309                                 },
1310                                 _ => panic!("Unexpected destination"),
1311                         }
1312                 }
1313         }}
1314 }
1315
1316 #[macro_export]
1317 /// Clears (and ignores) a PendingHTLCsForwardable event
1318 macro_rules! expect_pending_htlcs_forwardable_ignore {
1319         ($node: expr) => {{
1320                 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1321         }};
1322 }
1323
1324 #[macro_export]
1325 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1326 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1327         ($node: expr, $expected_failures: expr) => {{
1328                 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1329         }};
1330 }
1331
1332 #[macro_export]
1333 /// Handles a PendingHTLCsForwardable event
1334 macro_rules! expect_pending_htlcs_forwardable {
1335         ($node: expr) => {{
1336                 expect_pending_htlcs_forwardable_ignore!($node);
1337                 $node.node.process_pending_htlc_forwards();
1338
1339                 // Ensure process_pending_htlc_forwards is idempotent.
1340                 $node.node.process_pending_htlc_forwards();
1341         }};
1342 }
1343
1344 #[macro_export]
1345 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1346 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1347         ($node: expr, $expected_failures: expr) => {{
1348                 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1349                 $node.node.process_pending_htlc_forwards();
1350
1351                 // Ensure process_pending_htlc_forwards is idempotent.
1352                 $node.node.process_pending_htlc_forwards();
1353         }}
1354 }
1355
1356 #[cfg(test)]
1357 macro_rules! expect_pending_htlcs_forwardable_from_events {
1358         ($node: expr, $events: expr, $ignore: expr) => {{
1359                 assert_eq!($events.len(), 1);
1360                 match $events[0] {
1361                         Event::PendingHTLCsForwardable { .. } => { },
1362                         _ => panic!("Unexpected event"),
1363                 };
1364                 if $ignore {
1365                         $node.node.process_pending_htlc_forwards();
1366
1367                         // Ensure process_pending_htlc_forwards is idempotent.
1368                         $node.node.process_pending_htlc_forwards();
1369                 }
1370         }}
1371 }
1372
1373 #[macro_export]
1374 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1375 macro_rules! expect_payment_received {
1376         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1377                 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1378         };
1379         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1380                 let events = $node.node.get_and_clear_pending_events();
1381                 assert_eq!(events.len(), 1);
1382                 match events[0] {
1383                         $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1384                                 assert_eq!($expected_payment_hash, *payment_hash);
1385                                 assert_eq!($expected_recv_value, amount_msat);
1386                                 match purpose {
1387                                         $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1388                                                 assert_eq!(&$expected_payment_preimage, payment_preimage);
1389                                                 assert_eq!($expected_payment_secret, *payment_secret);
1390                                         },
1391                                         _ => {},
1392                                 }
1393                         },
1394                         _ => panic!("Unexpected event"),
1395                 }
1396         }
1397 }
1398
1399 #[macro_export]
1400 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1401 macro_rules! expect_payment_claimed {
1402         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1403                 let events = $node.node.get_and_clear_pending_events();
1404                 assert_eq!(events.len(), 1);
1405                 match events[0] {
1406                         $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1407                                 assert_eq!($expected_payment_hash, *payment_hash);
1408                                 assert_eq!($expected_recv_value, amount_msat);
1409                         },
1410                         _ => panic!("Unexpected event"),
1411                 }
1412         }
1413 }
1414
1415 #[cfg(test)]
1416 #[macro_export]
1417 macro_rules! expect_payment_sent_without_paths {
1418         ($node: expr, $expected_payment_preimage: expr) => {
1419                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1420         };
1421         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1422                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1423         }
1424 }
1425
1426 #[macro_export]
1427 macro_rules! expect_payment_sent {
1428         ($node: expr, $expected_payment_preimage: expr) => {
1429                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1430         };
1431         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1432                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1433         };
1434         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1435                 use bitcoin::hashes::Hash as _;
1436                 let events = $node.node.get_and_clear_pending_events();
1437                 let expected_payment_hash = $crate::ln::PaymentHash(
1438                         bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1439                 if $expect_paths {
1440                         assert!(events.len() > 1);
1441                 } else {
1442                         assert_eq!(events.len(), 1);
1443                 }
1444                 let expected_payment_id = match events[0] {
1445                         $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1446                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1447                                 assert_eq!(expected_payment_hash, *payment_hash);
1448                                 assert!(fee_paid_msat.is_some());
1449                                 if $expected_fee_msat_opt.is_some() {
1450                                         assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1451                                 }
1452                                 payment_id.unwrap()
1453                         },
1454                         _ => panic!("Unexpected event"),
1455                 };
1456                 if $expect_paths {
1457                         for i in 1..events.len() {
1458                                 match events[i] {
1459                                         $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1460                                                 assert_eq!(payment_id, expected_payment_id);
1461                                                 assert_eq!(payment_hash, Some(expected_payment_hash));
1462                                         },
1463                                         _ => panic!("Unexpected event"),
1464                                 }
1465                         }
1466                 }
1467         } }
1468 }
1469
1470 #[cfg(test)]
1471 #[macro_export]
1472 macro_rules! expect_payment_path_successful {
1473         ($node: expr) => {
1474                 let events = $node.node.get_and_clear_pending_events();
1475                 assert_eq!(events.len(), 1);
1476                 match events[0] {
1477                         $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1478                         _ => panic!("Unexpected event"),
1479                 }
1480         }
1481 }
1482
1483 macro_rules! expect_payment_forwarded {
1484         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1485                 let events = $node.node.get_and_clear_pending_events();
1486                 assert_eq!(events.len(), 1);
1487                 match events[0] {
1488                         Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1489                                 assert_eq!(fee_earned_msat, $expected_fee);
1490                                 if fee_earned_msat.is_some() {
1491                                         // Is the event prev_channel_id in one of the channels between the two nodes?
1492                                         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()));
1493                                 }
1494                                 // We check for force closures since a force closed channel is removed from the
1495                                 // node's channel list
1496                                 if !$downstream_force_closed {
1497                                         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()));
1498                                 }
1499                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1500                         },
1501                         _ => panic!("Unexpected event"),
1502                 }
1503         }
1504 }
1505
1506 pub struct PaymentFailedConditions<'a> {
1507         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1508         pub(crate) expected_blamed_scid: Option<u64>,
1509         pub(crate) expected_blamed_chan_closed: Option<bool>,
1510         pub(crate) expected_mpp_parts_remain: bool,
1511 }
1512
1513 impl<'a> PaymentFailedConditions<'a> {
1514         pub fn new() -> Self {
1515                 Self {
1516                         expected_htlc_error_data: None,
1517                         expected_blamed_scid: None,
1518                         expected_blamed_chan_closed: None,
1519                         expected_mpp_parts_remain: false,
1520                 }
1521         }
1522         pub fn mpp_parts_remain(mut self) -> Self {
1523                 self.expected_mpp_parts_remain = true;
1524                 self
1525         }
1526         pub fn blamed_scid(mut self, scid: u64) -> Self {
1527                 self.expected_blamed_scid = Some(scid);
1528                 self
1529         }
1530         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1531                 self.expected_blamed_chan_closed = Some(closed);
1532                 self
1533         }
1534         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1535                 self.expected_htlc_error_data = Some((code, data));
1536                 self
1537         }
1538 }
1539
1540 #[cfg(test)]
1541 macro_rules! expect_payment_failed_with_update {
1542         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1543                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1544                         &$node, $expected_payment_hash, $payment_failed_permanently,
1545                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1546                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1547         }
1548 }
1549
1550 #[cfg(test)]
1551 macro_rules! expect_payment_failed {
1552         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1553                 #[allow(unused_mut)]
1554                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1555                 $(
1556                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1557                 )*
1558                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1559         };
1560 }
1561
1562 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1563         node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1564         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1565 ) {
1566         let expected_payment_id = match payment_failed_event {
1567                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1568                         #[cfg(test)]
1569                         error_code,
1570                         #[cfg(test)]
1571                         error_data, .. } => {
1572                         assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1573                         assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1574                         assert!(retry.is_some(), "expected retry.is_some()");
1575                         assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1576                         assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1577                         if let Some(scid) = short_channel_id {
1578                                 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1579                         }
1580
1581                         #[cfg(test)]
1582                         {
1583                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1584                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1585                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
1586                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
1587                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1588                                 }
1589                         }
1590
1591                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1592                                 match network_update {
1593                                         Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1594                                                 if let Some(scid) = conditions.expected_blamed_scid {
1595                                                         assert_eq!(msg.contents.short_channel_id, scid);
1596                                                 }
1597                                                 const CHAN_DISABLED_FLAG: u8 = 2;
1598                                                 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1599                                         },
1600                                         Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1601                                                 if let Some(scid) = conditions.expected_blamed_scid {
1602                                                         assert_eq!(short_channel_id, scid);
1603                                                 }
1604                                                 assert!(is_permanent);
1605                                         },
1606                                         Some(_) => panic!("Unexpected update type"),
1607                                         None => panic!("Expected update"),
1608                                 }
1609                         }
1610
1611                         payment_id.unwrap()
1612                 },
1613                 _ => panic!("Unexpected event"),
1614         };
1615         if !conditions.expected_mpp_parts_remain {
1616                 node.node.abandon_payment(expected_payment_id);
1617                 let events = node.node.get_and_clear_pending_events();
1618                 assert_eq!(events.len(), 1);
1619                 match events[0] {
1620                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1621                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1622                                 assert_eq!(*payment_id, expected_payment_id);
1623                         }
1624                         _ => panic!("Unexpected second event"),
1625                 }
1626         }
1627 }
1628
1629 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1630         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1631         conditions: PaymentFailedConditions<'e>
1632 ) {
1633         let mut events = node.node.get_and_clear_pending_events();
1634         assert_eq!(events.len(), 1);
1635         expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1636 }
1637
1638 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 {
1639         let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1640         check_added_monitors!(origin_node, expected_paths.len());
1641         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1642         payment_id
1643 }
1644
1645 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>) {
1646         let mut payment_event = SendEvent::from_event(ev);
1647         let mut prev_node = origin_node;
1648
1649         for (idx, &node) in expected_path.iter().enumerate() {
1650                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1651
1652                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1653                 check_added_monitors!(node, 0);
1654                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1655
1656                 expect_pending_htlcs_forwardable!(node);
1657
1658                 if idx == expected_path.len() - 1 && clear_recipient_events {
1659                         let events_2 = node.node.get_and_clear_pending_events();
1660                         if payment_received_expected {
1661                                 assert_eq!(events_2.len(), 1);
1662                                 match events_2[0] {
1663                                         Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1664                                                 assert_eq!(our_payment_hash, *payment_hash);
1665                                                 match &purpose {
1666                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1667                                                                 assert_eq!(expected_preimage, *payment_preimage);
1668                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1669                                                         },
1670                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1671                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1672                                                                 assert!(our_payment_secret.is_none());
1673                                                         },
1674                                                 }
1675                                                 assert_eq!(amount_msat, recv_value);
1676                                         },
1677                                         _ => panic!("Unexpected event"),
1678                                 }
1679                         } else {
1680                                 assert!(events_2.is_empty());
1681                         }
1682                 } else if idx != expected_path.len() - 1 {
1683                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1684                         assert_eq!(events_2.len(), 1);
1685                         check_added_monitors!(node, 1);
1686                         payment_event = SendEvent::from_event(events_2.remove(0));
1687                         assert_eq!(payment_event.msgs.len(), 1);
1688                 }
1689
1690                 prev_node = node;
1691         }
1692 }
1693
1694 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>) {
1695         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1696 }
1697
1698 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) {
1699         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1700         assert_eq!(events.len(), expected_route.len());
1701         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1702                 // Once we've gotten through all the HTLCs, the last one should result in a
1703                 // PaymentReceived (but each previous one should not!), .
1704                 let expect_payment = path_idx == expected_route.len() - 1;
1705                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1706         }
1707 }
1708
1709 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) {
1710         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1711         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1712         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1713 }
1714
1715 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 {
1716         for path in expected_paths.iter() {
1717                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1718         }
1719         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1720
1721         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1722         assert_eq!(claim_event.len(), 1);
1723         match claim_event[0] {
1724                 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1725                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1726                         assert_eq!(preimage, our_payment_preimage),
1727                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1728                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1729                 _ => panic!(),
1730         }
1731
1732         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1733
1734         let mut expected_total_fee_msat = 0;
1735
1736         macro_rules! msgs_from_ev {
1737                 ($ev: expr) => {
1738                         match $ev {
1739                                 &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 } } => {
1740                                         assert!(update_add_htlcs.is_empty());
1741                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1742                                         assert!(update_fail_htlcs.is_empty());
1743                                         assert!(update_fail_malformed_htlcs.is_empty());
1744                                         assert!(update_fee.is_none());
1745                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1746                                 },
1747                                 _ => panic!("Unexpected event"),
1748                         }
1749                 }
1750         }
1751         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1752         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1753         assert_eq!(events.len(), expected_paths.len());
1754         for ev in events.iter() {
1755                 per_path_msgs.push(msgs_from_ev!(ev));
1756         }
1757
1758         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1759                 let mut next_msgs = Some(path_msgs);
1760                 let mut expected_next_node = next_hop;
1761
1762                 macro_rules! last_update_fulfill_dance {
1763                         ($node: expr, $prev_node: expr) => {
1764                                 {
1765                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1766                                         check_added_monitors!($node, 0);
1767                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1768                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1769                                 }
1770                         }
1771                 }
1772                 macro_rules! mid_update_fulfill_dance {
1773                         ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1774                                 {
1775                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1776                                         let fee = {
1777                                                 let channel_state = $node.node.channel_state.lock().unwrap();
1778                                                 let channel = channel_state
1779                                                         .by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1780                                                 if let Some(prev_config) = channel.prev_config() {
1781                                                         prev_config.forwarding_fee_base_msat
1782                                                 } else {
1783                                                         channel.config().forwarding_fee_base_msat
1784                                                 }
1785                                         };
1786                                         expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1787                                         expected_total_fee_msat += fee as u64;
1788                                         check_added_monitors!($node, 1);
1789                                         let new_next_msgs = if $new_msgs {
1790                                                 let events = $node.node.get_and_clear_pending_msg_events();
1791                                                 assert_eq!(events.len(), 1);
1792                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1793                                                 expected_next_node = nexthop;
1794                                                 Some(res)
1795                                         } else {
1796                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1797                                                 None
1798                                         };
1799                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1800                                         next_msgs = new_next_msgs;
1801                                 }
1802                         }
1803                 }
1804
1805                 let mut prev_node = expected_route.last().unwrap();
1806                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1807                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1808                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1809                         if next_msgs.is_some() {
1810                                 // Since we are traversing in reverse, next_node is actually the previous node
1811                                 let next_node: &Node;
1812                                 if idx == expected_route.len() - 1 {
1813                                         next_node = origin_node;
1814                                 } else {
1815                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
1816                                 }
1817                                 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1818                         } else {
1819                                 assert!(!update_next_msgs);
1820                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1821                         }
1822                         if !skip_last && idx == expected_route.len() - 1 {
1823                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1824                         }
1825
1826                         prev_node = node;
1827                 }
1828
1829                 if !skip_last {
1830                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1831                 }
1832         }
1833
1834         // Ensure that claim_funds is idempotent.
1835         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1836         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1837         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1838
1839         expected_total_fee_msat
1840 }
1841 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) {
1842         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1843         if !skip_last {
1844                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1845         }
1846 }
1847
1848 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1849         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1850 }
1851
1852 pub const TEST_FINAL_CLTV: u32 = 70;
1853
1854 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) {
1855         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1856                 .with_features(channelmanager::provided_invoice_features());
1857         let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1858         assert_eq!(route.paths.len(), 1);
1859         assert_eq!(route.paths[0].len(), expected_route.len());
1860         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1861                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1862         }
1863
1864         let res = send_along_route(origin_node, route, expected_route, recv_value);
1865         (res.0, res.1, res.2)
1866 }
1867
1868 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1869         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1870                 .with_features(channelmanager::provided_invoice_features());
1871         let network_graph = origin_node.network_graph.read_only();
1872         let scorer = test_utils::TestScorer::with_penalty(0);
1873         let seed = [0u8; 32];
1874         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1875         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1876         let route = get_route(
1877                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1878                 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1879         assert_eq!(route.paths.len(), 1);
1880         assert_eq!(route.paths[0].len(), expected_route.len());
1881         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1882                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1883         }
1884
1885         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1886         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1887                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1888 }
1889
1890 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1891         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1892         claim_payment(&origin, expected_route, our_payment_preimage);
1893 }
1894
1895 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) {
1896         for path in expected_paths.iter() {
1897                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1898         }
1899         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1900         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
1901         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
1902
1903         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1904 }
1905
1906 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) {
1907         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1908         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1909
1910         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1911         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1912         assert_eq!(events.len(), expected_paths.len());
1913         for ev in events.iter() {
1914                 let (update_fail, commitment_signed, node_id) = match ev {
1915                         &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 } } => {
1916                                 assert!(update_add_htlcs.is_empty());
1917                                 assert!(update_fulfill_htlcs.is_empty());
1918                                 assert_eq!(update_fail_htlcs.len(), 1);
1919                                 assert!(update_fail_malformed_htlcs.is_empty());
1920                                 assert!(update_fee.is_none());
1921                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1922                         },
1923                         _ => panic!("Unexpected event"),
1924                 };
1925                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1926         }
1927         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1928         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()));
1929
1930         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1931                 let mut next_msgs = Some(path_msgs);
1932                 let mut expected_next_node = next_hop;
1933                 let mut prev_node = expected_route.last().unwrap();
1934
1935                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1936                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1937                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
1938                         if next_msgs.is_some() {
1939                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1940                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1941                                 if !update_next_node {
1942                                         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 }]);
1943                                 }
1944                         }
1945                         let events = node.node.get_and_clear_pending_msg_events();
1946                         if update_next_node {
1947                                 assert_eq!(events.len(), 1);
1948                                 match events[0] {
1949                                         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 } } => {
1950                                                 assert!(update_add_htlcs.is_empty());
1951                                                 assert!(update_fulfill_htlcs.is_empty());
1952                                                 assert_eq!(update_fail_htlcs.len(), 1);
1953                                                 assert!(update_fail_malformed_htlcs.is_empty());
1954                                                 assert!(update_fee.is_none());
1955                                                 expected_next_node = node_id.clone();
1956                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1957                                         },
1958                                         _ => panic!("Unexpected event"),
1959                                 }
1960                         } else {
1961                                 assert!(events.is_empty());
1962                         }
1963                         if !skip_last && idx == expected_route.len() - 1 {
1964                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1965                         }
1966
1967                         prev_node = node;
1968                 }
1969
1970                 if !skip_last {
1971                         let prev_node = expected_route.first().unwrap();
1972                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1973                         check_added_monitors!(origin_node, 0);
1974                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1975                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1976                         let events = origin_node.node.get_and_clear_pending_events();
1977                         assert_eq!(events.len(), 1);
1978                         let expected_payment_id = match events[0] {
1979                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
1980                                         assert_eq!(payment_hash, our_payment_hash);
1981                                         assert!(payment_failed_permanently);
1982                                         assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1983                                         for (idx, hop) in expected_route.iter().enumerate() {
1984                                                 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1985                                         }
1986                                         payment_id.unwrap()
1987                                 },
1988                                 _ => panic!("Unexpected event"),
1989                         };
1990                         if i == expected_paths.len() - 1 {
1991                                 origin_node.node.abandon_payment(expected_payment_id);
1992                                 let events = origin_node.node.get_and_clear_pending_events();
1993                                 assert_eq!(events.len(), 1);
1994                                 match events[0] {
1995                                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1996                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1997                                                 assert_eq!(*payment_id, expected_payment_id);
1998                                         }
1999                                         _ => panic!("Unexpected second event"),
2000                                 }
2001                         }
2002                 }
2003         }
2004
2005         // Ensure that fail_htlc_backwards is idempotent.
2006         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2007         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2008         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2009         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2010 }
2011
2012 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2013         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2014 }
2015
2016 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2017         let mut chan_mon_cfgs = Vec::new();
2018         for i in 0..node_count {
2019                 let tx_broadcaster = test_utils::TestBroadcaster {
2020                         txn_broadcasted: Mutex::new(Vec::new()),
2021                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2022                 };
2023                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2024                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2025                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2026                 let persister = test_utils::TestPersister::new();
2027                 let seed = [i as u8; 32];
2028                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2029
2030                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2031         }
2032
2033         chan_mon_cfgs
2034 }
2035
2036 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2037         let mut nodes = Vec::new();
2038
2039         for i in 0..node_count {
2040                 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);
2041                 let seed = [i as u8; 32];
2042                 nodes.push(NodeCfg {
2043                         chain_source: &chanmon_cfgs[i].chain_source,
2044                         logger: &chanmon_cfgs[i].logger,
2045                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2046                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2047                         chain_monitor,
2048                         keys_manager: &chanmon_cfgs[i].keys_manager,
2049                         node_seed: seed,
2050                         features: channelmanager::provided_init_features(),
2051                         network_graph: NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger),
2052                 });
2053         }
2054
2055         nodes
2056 }
2057
2058 pub fn test_default_channel_config() -> UserConfig {
2059         let mut default_config = UserConfig::default();
2060         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2061         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2062         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2063         default_config.channel_handshake_config.announced_channel = true;
2064         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2065         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2066         // It now defaults to 1, so we simply set it to the expected value here.
2067         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2068         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2069         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2070         default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2071         default_config
2072 }
2073
2074 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
2075         let mut chanmgrs = Vec::new();
2076         for i in 0..node_count {
2077                 let network = Network::Testnet;
2078                 let params = ChainParameters {
2079                         network,
2080                         best_block: BestBlock::from_genesis(network),
2081                 };
2082                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
2083                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2084                 chanmgrs.push(node);
2085         }
2086
2087         chanmgrs
2088 }
2089
2090 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
2091         let mut nodes = Vec::new();
2092         let chan_count = Rc::new(RefCell::new(0));
2093         let payment_count = Rc::new(RefCell::new(0));
2094         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2095
2096         for i in 0..node_count {
2097                 let gossip_sync = P2PGossipSync::new(&cfgs[i].network_graph, None, cfgs[i].logger);
2098                 nodes.push(Node{
2099                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2100                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2101                         node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, gossip_sync,
2102                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2103                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2104                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2105                         connect_style: Rc::clone(&connect_style),
2106                 })
2107         }
2108
2109         for i in 0..node_count {
2110                 for j in (i+1)..node_count {
2111                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None }).unwrap();
2112                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None }).unwrap();
2113                 }
2114         }
2115
2116         nodes
2117 }
2118
2119 // Note that the following only works for CLTV values up to 128
2120 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2121
2122 #[derive(PartialEq)]
2123 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2124 /// Tests that the given node has broadcast transactions for the given Channel
2125 ///
2126 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2127 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2128 /// broadcast and the revoked outputs were claimed.
2129 ///
2130 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2131 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2132 ///
2133 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2134 /// also fail.
2135 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>  {
2136         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2137         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2138
2139         let mut res = Vec::with_capacity(2);
2140         node_txn.retain(|tx| {
2141                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2142                         check_spends!(tx, chan.3);
2143                         if commitment_tx.is_none() {
2144                                 res.push(tx.clone());
2145                         }
2146                         false
2147                 } else { true }
2148         });
2149         if let Some(explicit_tx) = commitment_tx {
2150                 res.push(explicit_tx.clone());
2151         }
2152
2153         assert_eq!(res.len(), 1);
2154
2155         if has_htlc_tx != HTLCType::NONE {
2156                 node_txn.retain(|tx| {
2157                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2158                                 check_spends!(tx, res[0]);
2159                                 if has_htlc_tx == HTLCType::TIMEOUT {
2160                                         assert!(tx.lock_time.0 != 0);
2161                                 } else {
2162                                         assert!(tx.lock_time.0 == 0);
2163                                 }
2164                                 res.push(tx.clone());
2165                                 false
2166                         } else { true }
2167                 });
2168                 assert!(res.len() == 2 || res.len() == 3);
2169                 if res.len() == 3 {
2170                         assert_eq!(res[1], res[2]);
2171                 }
2172         }
2173
2174         assert!(node_txn.is_empty());
2175         res
2176 }
2177
2178 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2179 /// HTLC transaction.
2180 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2181         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2182         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2183         // for revoked htlc outputs
2184         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2185         node_txn.retain(|tx| {
2186                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2187                         check_spends!(tx, revoked_tx);
2188                         false
2189                 } else { true }
2190         });
2191         node_txn.retain(|tx| {
2192                 check_spends!(tx, commitment_revoked_tx);
2193                 false
2194         });
2195         assert!(node_txn.is_empty());
2196 }
2197
2198 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2199         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2200
2201         assert!(node_txn.len() >= 1);
2202         assert_eq!(node_txn[0].input.len(), 1);
2203         let mut found_prev = false;
2204
2205         for tx in prev_txn {
2206                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2207                         check_spends!(node_txn[0], tx);
2208                         let mut iter = node_txn[0].input[0].witness.iter();
2209                         iter.next().expect("expected 3 witness items");
2210                         iter.next().expect("expected 3 witness items");
2211                         assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2212                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2213
2214                         found_prev = true;
2215                         break;
2216                 }
2217         }
2218         assert!(found_prev);
2219
2220         let mut res = Vec::new();
2221         mem::swap(&mut *node_txn, &mut res);
2222         res
2223 }
2224
2225 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)  {
2226         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2227         assert_eq!(events_1.len(), 2);
2228         let as_update = match events_1[0] {
2229                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2230                         msg.clone()
2231                 },
2232                 _ => panic!("Unexpected event"),
2233         };
2234         match events_1[1] {
2235                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2236                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2237                         assert_eq!(msg.data, expected_error);
2238                         if needs_err_handle {
2239                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2240                         }
2241                 },
2242                 _ => panic!("Unexpected event"),
2243         }
2244
2245         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2246         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2247         let bs_update = match events_2[0] {
2248                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2249                         msg.clone()
2250                 },
2251                 _ => panic!("Unexpected event"),
2252         };
2253         if !needs_err_handle {
2254                 match events_2[1] {
2255                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2256                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2257                                 assert_eq!(msg.data, expected_error);
2258                         },
2259                         _ => panic!("Unexpected event"),
2260                 }
2261         }
2262
2263         for node in nodes {
2264                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2265                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2266         }
2267 }
2268
2269 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2270         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2271 }
2272
2273 #[cfg(test)]
2274 macro_rules! get_channel_value_stat {
2275         ($node: expr, $channel_id: expr) => {{
2276                 let chan_lock = $node.node.channel_state.lock().unwrap();
2277                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2278                 chan.get_value_stat()
2279         }}
2280 }
2281
2282 macro_rules! get_chan_reestablish_msgs {
2283         ($src_node: expr, $dst_node: expr) => {
2284                 {
2285                         let mut announcements = $crate::prelude::HashSet::new();
2286                         let mut res = Vec::with_capacity(1);
2287                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2288                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2289                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2290                                         res.push(msg.clone());
2291                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2292                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2293                                         announcements.insert(msg.contents.short_channel_id);
2294                                 } else {
2295                                         panic!("Unexpected event")
2296                                 }
2297                         }
2298                         for chan in $src_node.node.list_channels() {
2299                                 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2300                                         if let Some(scid) = chan.short_channel_id {
2301                                                 assert!(announcements.remove(&scid));
2302                                         }
2303                                 }
2304                         }
2305                         assert!(announcements.is_empty());
2306                         res
2307                 }
2308         }
2309 }
2310
2311 macro_rules! handle_chan_reestablish_msgs {
2312         ($src_node: expr, $dst_node: expr) => {
2313                 {
2314                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2315                         let mut idx = 0;
2316                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2317                                 idx += 1;
2318                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2319                                 Some(msg.clone())
2320                         } else {
2321                                 None
2322                         };
2323
2324                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2325                                 idx += 1;
2326                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2327                         }
2328
2329                         let mut revoke_and_ack = None;
2330                         let mut commitment_update = None;
2331                         let order = if let Some(ev) = msg_events.get(idx) {
2332                                 match ev {
2333                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2334                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2335                                                 revoke_and_ack = Some(msg.clone());
2336                                                 idx += 1;
2337                                                 RAACommitmentOrder::RevokeAndACKFirst
2338                                         },
2339                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2340                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2341                                                 commitment_update = Some(updates.clone());
2342                                                 idx += 1;
2343                                                 RAACommitmentOrder::CommitmentFirst
2344                                         },
2345                                         _ => RAACommitmentOrder::CommitmentFirst,
2346                                 }
2347                         } else {
2348                                 RAACommitmentOrder::CommitmentFirst
2349                         };
2350
2351                         if let Some(ev) = msg_events.get(idx) {
2352                                 match ev {
2353                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2354                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2355                                                 assert!(revoke_and_ack.is_none());
2356                                                 revoke_and_ack = Some(msg.clone());
2357                                                 idx += 1;
2358                                         },
2359                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2360                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2361                                                 assert!(commitment_update.is_none());
2362                                                 commitment_update = Some(updates.clone());
2363                                                 idx += 1;
2364                                         },
2365                                         _ => {},
2366                                 }
2367                         }
2368
2369                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2370                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2371                                 idx += 1;
2372                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2373                         }
2374
2375                         assert_eq!(msg_events.len(), idx);
2376
2377                         (channel_ready, revoke_and_ack, commitment_update, order)
2378                 }
2379         }
2380 }
2381
2382 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2383 /// for claims/fails they are separated out.
2384 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))  {
2385         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2386         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2387         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2388         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2389
2390         if send_channel_ready.0 {
2391                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2392                 // from b
2393                 for reestablish in reestablish_1.iter() {
2394                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2395                 }
2396         }
2397         if send_channel_ready.1 {
2398                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2399                 // from a
2400                 for reestablish in reestablish_2.iter() {
2401                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2402                 }
2403         }
2404         if send_channel_ready.0 || send_channel_ready.1 {
2405                 // If we expect any channel_ready's, both sides better have set
2406                 // next_holder_commitment_number to 1
2407                 for reestablish in reestablish_1.iter() {
2408                         assert_eq!(reestablish.next_local_commitment_number, 1);
2409                 }
2410                 for reestablish in reestablish_2.iter() {
2411                         assert_eq!(reestablish.next_local_commitment_number, 1);
2412                 }
2413         }
2414
2415         let mut resp_1 = Vec::new();
2416         for msg in reestablish_1 {
2417                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2418                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2419         }
2420         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2421                 check_added_monitors!(node_b, 1);
2422         } else {
2423                 check_added_monitors!(node_b, 0);
2424         }
2425
2426         let mut resp_2 = Vec::new();
2427         for msg in reestablish_2 {
2428                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2429                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2430         }
2431         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2432                 check_added_monitors!(node_a, 1);
2433         } else {
2434                 check_added_monitors!(node_a, 0);
2435         }
2436
2437         // We don't yet support both needing updates, as that would require a different commitment dance:
2438         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2439                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2440                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2441                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2442
2443         for chan_msgs in resp_1.drain(..) {
2444                 if send_channel_ready.0 {
2445                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2446                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2447                         if !announcement_event.is_empty() {
2448                                 assert_eq!(announcement_event.len(), 1);
2449                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2450                                         //TODO: Test announcement_sigs re-sending
2451                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2452                         }
2453                 } else {
2454                         assert!(chan_msgs.0.is_none());
2455                 }
2456                 if pending_raa.0 {
2457                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2458                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2459                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2460                         check_added_monitors!(node_a, 1);
2461                 } else {
2462                         assert!(chan_msgs.1.is_none());
2463                 }
2464                 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 {
2465                         let commitment_update = chan_msgs.2.unwrap();
2466                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2467                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2468                         } else {
2469                                 assert!(commitment_update.update_add_htlcs.is_empty());
2470                         }
2471                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2472                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2473                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2474                         for update_add in commitment_update.update_add_htlcs {
2475                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2476                         }
2477                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2478                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2479                         }
2480                         for update_fail in commitment_update.update_fail_htlcs {
2481                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2482                         }
2483
2484                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2485                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2486                         } else {
2487                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2488                                 check_added_monitors!(node_a, 1);
2489                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2490                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2491                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2492                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2493                                 check_added_monitors!(node_b, 1);
2494                         }
2495                 } else {
2496                         assert!(chan_msgs.2.is_none());
2497                 }
2498         }
2499
2500         for chan_msgs in resp_2.drain(..) {
2501                 if send_channel_ready.1 {
2502                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2503                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2504                         if !announcement_event.is_empty() {
2505                                 assert_eq!(announcement_event.len(), 1);
2506                                 match announcement_event[0] {
2507                                         MessageSendEvent::SendChannelUpdate { .. } => {},
2508                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2509                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2510                                 }
2511                         }
2512                 } else {
2513                         assert!(chan_msgs.0.is_none());
2514                 }
2515                 if pending_raa.1 {
2516                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2517                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2518                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2519                         check_added_monitors!(node_b, 1);
2520                 } else {
2521                         assert!(chan_msgs.1.is_none());
2522                 }
2523                 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 {
2524                         let commitment_update = chan_msgs.2.unwrap();
2525                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2526                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2527                         }
2528                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2529                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2530                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2531                         for update_add in commitment_update.update_add_htlcs {
2532                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2533                         }
2534                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2535                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2536                         }
2537                         for update_fail in commitment_update.update_fail_htlcs {
2538                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2539                         }
2540
2541                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2542                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2543                         } else {
2544                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2545                                 check_added_monitors!(node_b, 1);
2546                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2547                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2548                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2549                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2550                                 check_added_monitors!(node_a, 1);
2551                         }
2552                 } else {
2553                         assert!(chan_msgs.2.is_none());
2554                 }
2555         }
2556 }