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