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