_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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