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