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