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