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

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