_ 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         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
 887
 888         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()));
 889         {
 890                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
 891                 assert_eq!(added_monitors.len(), 1);
 892                 assert_eq!(added_monitors[0].0, funding_output);
 893                 added_monitors.clear();
 894         }
 895         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
 896
 897         let events_4 = node_a.node.get_and_clear_pending_events();
 898         assert_eq!(events_4.len(), 0);
 899
 900         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 901         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
 902         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 903
 904         // Ensure that funding_transaction_generated is idempotent.
 905         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
 906         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
 907         check_added_monitors!(node_a, 0);
 908
 909         tx
 910 }
 911
 912 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
 913 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]) {
 914         let initiator_channels = initiator.node.list_usable_channels().len();
 915         let receiver_channels = receiver.node.list_usable_channels().len();
 916
 917         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
 918         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
 919
 920         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
 921         let events = receiver.node.get_and_clear_pending_events();
 922         assert_eq!(events.len(), 1);
 923         match events[0] {
 924                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
 925                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
 926                 },
 927                 _ => panic!("Unexpected event"),
 928         };
 929
 930         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
 931         assert_eq!(accept_channel.minimum_depth, 0);
 932         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
 933
 934         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
 935         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
 936         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
 937
 938         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
 939         check_added_monitors!(receiver, 1);
 940         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
 941         assert_eq!(bs_signed_locked.len(), 2);
 942         let as_channel_ready;
 943         match &bs_signed_locked[0] {
 944                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
 945                         assert_eq!(*node_id, initiator.node.get_our_node_id());
 946                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
 947                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
 948                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
 949                         check_added_monitors!(initiator, 1);
 950
 951                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 952                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
 953
 954                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
 955                 }
 956                 _ => panic!("Unexpected event"),
 957         }
 958         match &bs_signed_locked[1] {
 959                 MessageSendEvent::SendChannelReady { node_id, msg } => {
 960                         assert_eq!(*node_id, initiator.node.get_our_node_id());
 961                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
 962                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
 963                 }
 964                 _ => panic!("Unexpected event"),
 965         }
 966
 967         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
 968         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
 969
 970         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
 971         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
 972
 973         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
 974         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
 975
 976         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
 977         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
 978
 979         (tx, as_channel_ready.channel_id)
 980 }
 981
 982 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 {
 983         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 984         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
 985         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
 986         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
 987         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
 988         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
 989         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
 990         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
 991         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
 992
 993         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
 994 }
 995
 996 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) {
 997         confirm_transaction_at(node_conf, tx, conf_height);
 998         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
 999         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()));
1000 }
1001
1002 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]) {
1003         let channel_id;
1004         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1005         assert_eq!(events_6.len(), 3);
1006         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1007                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1008                 2
1009         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1010                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1011                 1
1012         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1013         ((match events_6[0] {
1014                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1015                         channel_id = msg.channel_id.clone();
1016                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1017                         msg.clone()
1018                 },
1019                 _ => panic!("Unexpected event"),
1020         }, match events_6[announcement_sigs_idx] {
1021                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1022                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1023                         msg.clone()
1024                 },
1025                 _ => panic!("Unexpected event"),
1026         }), channel_id)
1027 }
1028
1029 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]) {
1030         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1031         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1032         confirm_transaction_at(node_a, tx, conf_height);
1033         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1034         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1035         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1036 }
1037
1038 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) {
1039         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1040         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1041         (msgs, chan_id, tx)
1042 }
1043
1044 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) {
1045         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1046         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1047         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1048
1049         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1050         assert_eq!(events_7.len(), 1);
1051         let (announcement, bs_update) = match events_7[0] {
1052                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1053                         (msg, update_msg.clone().unwrap())
1054                 },
1055                 _ => panic!("Unexpected event"),
1056         };
1057
1058         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1059         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1060         assert_eq!(events_8.len(), 1);
1061         let as_update = match events_8[0] {
1062                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1063                         assert!(*announcement == *msg);
1064                         let update_msg = update_msg.clone().unwrap();
1065                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1066                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1067                         update_msg
1068                 },
1069                 _ => panic!("Unexpected event"),
1070         };
1071
1072         *node_a.network_chan_count.borrow_mut() += 1;
1073
1074         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1075         ((*announcement).clone(), as_update, bs_update)
1076 }
1077
1078 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) {
1079         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1080 }
1081
1082 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) {
1083         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1084         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1085         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1086 }
1087
1088 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) {
1089         let mut no_announce_cfg = test_default_channel_config();
1090         no_announce_cfg.channel_handshake_config.announced_channel = false;
1091         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1092         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1093         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1094         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1095         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1096
1097         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1098         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1099         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()));
1100         check_added_monitors!(nodes[b], 1);
1101
1102         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1103         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1104
1105         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1106         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1107         check_added_monitors!(nodes[a], 1);
1108
1109         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1110         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1111         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1112
1113         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1114         confirm_transaction_at(&nodes[a], &tx, conf_height);
1115         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1116         confirm_transaction_at(&nodes[b], &tx, conf_height);
1117         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1118         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1119         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()));
1120         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1121         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1122         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1123         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1124         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1125
1126         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1127         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1128
1129         let mut found_a = false;
1130         for chan in nodes[a].node.list_usable_channels() {
1131                 if chan.channel_id == as_channel_ready.channel_id {
1132                         assert!(!found_a);
1133                         found_a = true;
1134                         assert!(!chan.is_public);
1135                 }
1136         }
1137         assert!(found_a);
1138
1139         let mut found_b = false;
1140         for chan in nodes[b].node.list_usable_channels() {
1141                 if chan.channel_id == as_channel_ready.channel_id {
1142                         assert!(!found_b);
1143                         found_b = true;
1144                         assert!(!chan.is_public);
1145                 }
1146         }
1147         assert!(found_b);
1148
1149         (as_channel_ready, tx)
1150 }
1151
1152 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) {
1153         for node in nodes {
1154                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1155                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1156                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1157
1158                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1159                 // forwarding info for local channels even if its not accepted in the network graph.
1160                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1161                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1162         }
1163 }
1164
1165 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1166         for outp in tx.output.iter() {
1167                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1168         }
1169         let mut total_value_in = 0;
1170         for input in tx.input.iter() {
1171                 total_value_in += get_output(&input.previous_output).unwrap().value;
1172         }
1173         let mut total_value_out = 0;
1174         for output in tx.output.iter() {
1175                 total_value_out += output.value;
1176         }
1177         let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1178         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1179         assert!(total_value_out + min_fee <= total_value_in);
1180         tx.verify(get_output).unwrap();
1181 }
1182
1183 #[macro_export]
1184 macro_rules! check_spends {
1185         ($tx: expr, $($spends_txn: expr),*) => {
1186                 {
1187                         $(
1188                         for outp in $spends_txn.output.iter() {
1189                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1190                         }
1191                         )*
1192                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1193                                 $(
1194                                         if out_point.txid == $spends_txn.txid() {
1195                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1196                                         }
1197                                 )*
1198                                 None
1199                         };
1200                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1201                 }
1202         }
1203 }
1204
1205 macro_rules! get_closing_signed_broadcast {
1206         ($node: expr, $dest_pubkey: expr) => {
1207                 {
1208                         let events = $node.get_and_clear_pending_msg_events();
1209                         assert!(events.len() == 1 || events.len() == 2);
1210                         (match events[events.len() - 1] {
1211                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1212                                         assert_eq!(msg.contents.flags & 2, 2);
1213                                         msg.clone()
1214                                 },
1215                                 _ => panic!("Unexpected event"),
1216                         }, if events.len() == 2 {
1217                                 match events[0] {
1218                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1219                                                 assert_eq!(*node_id, $dest_pubkey);
1220                                                 Some(msg.clone())
1221                                         },
1222                                         _ => panic!("Unexpected event"),
1223                                 }
1224                         } else { None })
1225                 }
1226         }
1227 }
1228
1229 #[cfg(test)]
1230 macro_rules! check_warn_msg {
1231         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1232                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1233                 assert_eq!(msg_events.len(), 1);
1234                 match msg_events[0] {
1235                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1236                                 assert_eq!(node_id, $recipient_node_id);
1237                                 assert_eq!(msg.channel_id, $chan_id);
1238                                 msg.data.clone()
1239                         },
1240                         _ => panic!("Unexpected event"),
1241                 }
1242         }}
1243 }
1244
1245 /// Check that a channel's closing channel update has been broadcasted, and optionally
1246 /// check whether an error message event has occurred.
1247 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1248         let msg_events = node.node.get_and_clear_pending_msg_events();
1249         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1250         msg_events.into_iter().filter_map(|msg_event| {
1251                 match msg_event {
1252                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1253                                 assert_eq!(msg.contents.flags & 2, 2);
1254                                 None
1255                         },
1256                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1257                                 assert!(with_error_msg);
1258                                 // TODO: Check node_id
1259                                 Some(msg.clone())
1260                         },
1261                         _ => panic!("Unexpected event"),
1262                 }
1263         }).collect()
1264 }
1265
1266 /// Check that a channel's closing channel update has been broadcasted, and optionally
1267 /// check whether an error message event has occurred.
1268 ///
1269 /// Don't use this, use the identically-named function instead.
1270 #[macro_export]
1271 macro_rules! check_closed_broadcast {
1272         ($node: expr, $with_error_msg: expr) => {
1273                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1274         }
1275 }
1276
1277 /// Check that a channel's closing channel events has been issued
1278 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1279         let events = node.node.get_and_clear_pending_events();
1280         assert_eq!(events.len(), events_count, "{:?}", events);
1281         let mut issues_discard_funding = false;
1282         for event in events {
1283                 match event {
1284                         Event::ChannelClosed { ref reason, .. } => {
1285                                 assert_eq!(*reason, expected_reason);
1286                         },
1287                         Event::DiscardFunding { .. } => {
1288                                 issues_discard_funding = true;
1289                         }
1290                         _ => panic!("Unexpected event"),
1291                 }
1292         }
1293         assert_eq!(is_check_discard_funding, issues_discard_funding);
1294 }
1295
1296 /// Check that a channel's closing channel events has been issued
1297 ///
1298 /// Don't use this, use the identically-named function instead.
1299 #[macro_export]
1300 macro_rules! check_closed_event {
1301         ($node: expr, $events: expr, $reason: expr) => {
1302                 check_closed_event!($node, $events, $reason, false);
1303         };
1304         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1305                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1306         }
1307 }
1308
1309 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) {
1310         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) };
1311         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) };
1312         let (tx_a, tx_b);
1313
1314         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1315         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1316
1317         let events_1 = node_b.get_and_clear_pending_msg_events();
1318         assert!(events_1.len() >= 1);
1319         let shutdown_b = match events_1[0] {
1320                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1321                         assert_eq!(node_id, &node_a.get_our_node_id());
1322                         msg.clone()
1323                 },
1324                 _ => panic!("Unexpected event"),
1325         };
1326
1327         let closing_signed_b = if !close_inbound_first {
1328                 assert_eq!(events_1.len(), 1);
1329                 None
1330         } else {
1331                 Some(match events_1[1] {
1332                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1333                                 assert_eq!(node_id, &node_a.get_our_node_id());
1334                                 msg.clone()
1335                         },
1336                         _ => panic!("Unexpected event"),
1337                 })
1338         };
1339
1340         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1341         let (as_update, bs_update) = if close_inbound_first {
1342                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1343                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1344
1345                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1346                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1347                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1348                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1349
1350                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1351                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1352                 assert!(none_a.is_none());
1353                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1354                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1355                 (as_update, bs_update)
1356         } else {
1357                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1358
1359                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1360                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1361
1362                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1363                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1364                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1365
1366                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1367                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1368                 assert!(none_b.is_none());
1369                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1370                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1371                 (as_update, bs_update)
1372         };
1373         assert_eq!(tx_a, tx_b);
1374         check_spends!(tx_a, funding_tx);
1375
1376         (as_update, bs_update, tx_a)
1377 }
1378
1379 pub struct SendEvent {
1380         pub node_id: PublicKey,
1381         pub msgs: Vec<msgs::UpdateAddHTLC>,
1382         pub commitment_msg: msgs::CommitmentSigned,
1383 }
1384 impl SendEvent {
1385         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1386                 assert!(updates.update_fulfill_htlcs.is_empty());
1387                 assert!(updates.update_fail_htlcs.is_empty());
1388                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1389                 assert!(updates.update_fee.is_none());
1390                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1391         }
1392
1393         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1394                 match event {
1395                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1396                         _ => panic!("Unexpected event type!"),
1397                 }
1398         }
1399
1400         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1401                 let mut events = node.node.get_and_clear_pending_msg_events();
1402                 assert_eq!(events.len(), 1);
1403                 SendEvent::from_event(events.pop().unwrap())
1404         }
1405 }
1406
1407 #[macro_export]
1408 /// Don't use this, use the identically-named function instead.
1409 macro_rules! expect_pending_htlcs_forwardable_conditions {
1410         ($node: expr, $expected_failures: expr) => {
1411                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1412         }
1413 }
1414
1415 #[macro_export]
1416 macro_rules! expect_htlc_handling_failed_destinations {
1417         ($events: expr, $expected_failures: expr) => {{
1418                 for event in $events {
1419                         match event {
1420                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1421                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1422                                         assert!($expected_failures.contains(&failed_next_destination))
1423                                 },
1424                                 _ => panic!("Unexpected destination"),
1425                         }
1426                 }
1427         }}
1428 }
1429
1430 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1431 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1432 /// `expected_failures` set.
1433 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1434         match events[0] {
1435                 Event::PendingHTLCsForwardable { .. } => { },
1436                 _ => panic!("Unexpected event {:?}", events),
1437         };
1438
1439         let count = expected_failures.len() + 1;
1440         assert_eq!(events.len(), count);
1441
1442         if expected_failures.len() > 0 {
1443                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1444         }
1445 }
1446
1447 #[macro_export]
1448 /// Clears (and ignores) a PendingHTLCsForwardable event
1449 ///
1450 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1451 /// set instead.
1452 macro_rules! expect_pending_htlcs_forwardable_ignore {
1453         ($node: expr) => {
1454                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1455         }
1456 }
1457
1458 #[macro_export]
1459 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1460 ///
1461 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1462 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1463         ($node: expr, $expected_failures: expr) => {
1464                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1465         }
1466 }
1467
1468 #[macro_export]
1469 /// Handles a PendingHTLCsForwardable event
1470 macro_rules! expect_pending_htlcs_forwardable {
1471         ($node: expr) => {{
1472                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1473                 $node.node.process_pending_htlc_forwards();
1474
1475                 // Ensure process_pending_htlc_forwards is idempotent.
1476                 $node.node.process_pending_htlc_forwards();
1477         }};
1478 }
1479
1480 #[macro_export]
1481 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1482 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1483         ($node: expr, $expected_failures: expr) => {{
1484                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1485                 $node.node.process_pending_htlc_forwards();
1486
1487                 // Ensure process_pending_htlc_forwards is idempotent.
1488                 $node.node.process_pending_htlc_forwards();
1489         }}
1490 }
1491
1492 #[cfg(test)]
1493 macro_rules! expect_pending_htlcs_forwardable_from_events {
1494         ($node: expr, $events: expr, $ignore: expr) => {{
1495                 assert_eq!($events.len(), 1);
1496                 match $events[0] {
1497                         Event::PendingHTLCsForwardable { .. } => { },
1498                         _ => panic!("Unexpected event"),
1499                 };
1500                 if $ignore {
1501                         $node.node.process_pending_htlc_forwards();
1502
1503                         // Ensure process_pending_htlc_forwards is idempotent.
1504                         $node.node.process_pending_htlc_forwards();
1505                 }
1506         }}
1507 }
1508
1509 #[macro_export]
1510 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1511 /// commitment update.
1512 macro_rules! commitment_signed_dance {
1513         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1514                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1515         };
1516         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1517                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1518         };
1519         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1520                 {
1521                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1522                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1523                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1524                         check_added_monitors(&$node_a, 1);
1525                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1526                         assert!(extra_msg_option.is_none());
1527                         bs_revoke_and_ack
1528                 }
1529         };
1530         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1531                 {
1532                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1533                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1534                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 1);
1535                         extra_msg_option
1536                 }
1537         };
1538         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1539                 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1540         };
1541         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1542                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1543         }
1544 }
1545
1546
1547 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1548         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1549         check_added_monitors!(node_b, 0);
1550         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1551         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1552         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1553         check_added_monitors!(node_b, 1);
1554         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1555         let (bs_revoke_and_ack, extra_msg_option) = {
1556                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1557                 assert!(events.len() <= 2);
1558                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1559                 (match node_a_event {
1560                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1561                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1562                                 (*msg).clone()
1563                         },
1564                         _ => panic!("Unexpected event"),
1565                 }, events.get(0).map(|e| e.clone()))
1566         };
1567         check_added_monitors!(node_b, 1);
1568         if fail_backwards {
1569                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1570                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1571         }
1572         (extra_msg_option, bs_revoke_and_ack)
1573 }
1574
1575 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1576         check_added_monitors!(node_a, 0);
1577         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1578         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1579         check_added_monitors!(node_a, 1);
1580
1581         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1582
1583         if skip_last_step { return; }
1584
1585         if fail_backwards {
1586                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1587                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1588                 check_added_monitors!(node_a, 1);
1589
1590                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1591                 let mut number_of_msg_events = 0;
1592                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1593                         let peer_state = peer_state_mutex.lock().unwrap();
1594                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1595                         number_of_msg_events += cp_pending_msg_events.len();
1596                         if cp_pending_msg_events.len() == 1 {
1597                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1598                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1599                                 } else { panic!("Unexpected event"); }
1600                         }
1601                 }
1602                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1603                 assert_eq!(number_of_msg_events, 1);
1604         } else {
1605                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1606         }
1607 }
1608
1609 /// Get a payment preimage and hash.
1610 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1611         let mut payment_count = recipient.network_payment_count.borrow_mut();
1612         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1613         *payment_count += 1;
1614         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1615         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1616         (payment_preimage, payment_hash, payment_secret)
1617 }
1618
1619 /// Get a payment preimage and hash.
1620 ///
1621 /// Don't use this, use the identically-named function instead.
1622 #[macro_export]
1623 macro_rules! get_payment_preimage_hash {
1624         ($dest_node: expr) => {
1625                 get_payment_preimage_hash!($dest_node, None)
1626         };
1627         ($dest_node: expr, $min_value_msat: expr) => {
1628                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1629         };
1630         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1631                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1632         };
1633 }
1634
1635 /// Gets a route from the given sender to the node described in `payment_params`.
1636 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64, final_cltv_expiry_delta: u32) -> Result<Route, msgs::LightningError> {
1637         let scorer = TestScorer::new();
1638         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1639         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1640         router::get_route(
1641                 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1642                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1643                 recv_value, final_cltv_expiry_delta, send_node.logger, &scorer, &random_seed_bytes
1644         )
1645 }
1646
1647 /// Gets a route from the given sender to the node described in `payment_params`.
1648 ///
1649 /// Don't use this, use the identically-named function instead.
1650 #[macro_export]
1651 macro_rules! get_route {
1652         ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {
1653                 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv)
1654         }
1655 }
1656
1657 #[cfg(test)]
1658 #[macro_export]
1659 macro_rules! get_route_and_payment_hash {
1660         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1661                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1662                         .with_features($recv_node.node.invoice_features());
1663                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1664         }};
1665         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1666                 let (payment_preimage, payment_hash, payment_secret) =
1667                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1668                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv);
1669                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1670         }}
1671 }
1672
1673 #[macro_export]
1674 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1675 macro_rules! expect_payment_claimable {
1676         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1677                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1678         };
1679         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1680                 let events = $node.node.get_and_clear_pending_events();
1681                 assert_eq!(events.len(), 1);
1682                 match events[0] {
1683                         $crate::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1684                                 assert_eq!($expected_payment_hash, *payment_hash);
1685                                 assert_eq!($expected_recv_value, amount_msat);
1686                                 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1687                                 match purpose {
1688                                         $crate::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1689                                                 assert_eq!(&$expected_payment_preimage, payment_preimage);
1690                                                 assert_eq!($expected_payment_secret, *payment_secret);
1691                                         },
1692                                         _ => {},
1693                                 }
1694                         },
1695                         _ => panic!("Unexpected event"),
1696                 }
1697         }
1698 }
1699
1700 #[macro_export]
1701 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1702 macro_rules! expect_payment_claimed {
1703         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1704                 let events = $node.node.get_and_clear_pending_events();
1705                 assert_eq!(events.len(), 1);
1706                 match events[0] {
1707                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1708                                 assert_eq!($expected_payment_hash, *payment_hash);
1709                                 assert_eq!($expected_recv_value, amount_msat);
1710                         },
1711                         _ => panic!("Unexpected event"),
1712                 }
1713         }
1714 }
1715
1716 #[cfg(test)]
1717 #[macro_export]
1718 macro_rules! expect_payment_sent_without_paths {
1719         ($node: expr, $expected_payment_preimage: expr) => {
1720                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1721         };
1722         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1723                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1724         }
1725 }
1726
1727 #[macro_export]
1728 macro_rules! expect_payment_sent {
1729         ($node: expr, $expected_payment_preimage: expr) => {
1730                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1731         };
1732         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1733                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1734         };
1735         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1736                 use bitcoin::hashes::Hash as _;
1737                 let events = $node.node.get_and_clear_pending_events();
1738                 let expected_payment_hash = $crate::ln::PaymentHash(
1739                         bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1740                 if $expect_paths {
1741                         assert!(events.len() > 1);
1742                 } else {
1743                         assert_eq!(events.len(), 1);
1744                 }
1745                 let expected_payment_id = match events[0] {
1746                         $crate::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1747                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1748                                 assert_eq!(expected_payment_hash, *payment_hash);
1749                                 assert!(fee_paid_msat.is_some());
1750                                 if $expected_fee_msat_opt.is_some() {
1751                                         assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1752                                 }
1753                                 payment_id.unwrap()
1754                         },
1755                         _ => panic!("Unexpected event"),
1756                 };
1757                 if $expect_paths {
1758                         for i in 1..events.len() {
1759                                 match events[i] {
1760                                         $crate::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1761                                                 assert_eq!(payment_id, expected_payment_id);
1762                                                 assert_eq!(payment_hash, Some(expected_payment_hash));
1763                                         },
1764                                         _ => panic!("Unexpected event"),
1765                                 }
1766                         }
1767                 }
1768         } }
1769 }
1770
1771 #[cfg(test)]
1772 #[macro_export]
1773 macro_rules! expect_payment_path_successful {
1774         ($node: expr) => {
1775                 let events = $node.node.get_and_clear_pending_events();
1776                 assert_eq!(events.len(), 1);
1777                 match events[0] {
1778                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
1779                         _ => panic!("Unexpected event"),
1780                 }
1781         }
1782 }
1783
1784 macro_rules! expect_payment_forwarded {
1785         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1786                 let events = $node.node.get_and_clear_pending_events();
1787                 assert_eq!(events.len(), 1);
1788                 match events[0] {
1789                         Event::PaymentForwarded {
1790                                 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1791                                 outbound_amount_forwarded_msat: _
1792                         } => {
1793                                 assert_eq!(fee_earned_msat, $expected_fee);
1794                                 if fee_earned_msat.is_some() {
1795                                         // Is the event prev_channel_id in one of the channels between the two nodes?
1796                                         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()));
1797                                 }
1798                                 // We check for force closures since a force closed channel is removed from the
1799                                 // node's channel list
1800                                 if !$downstream_force_closed {
1801                                         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()));
1802                                 }
1803                                 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1804                         },
1805                         _ => panic!("Unexpected event"),
1806                 }
1807         }
1808 }
1809
1810 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1811 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1812         let events = node.node.get_and_clear_pending_events();
1813         assert_eq!(events.len(), 1);
1814         match events[0] {
1815                 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1816                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1817                 },
1818                 _ => panic!("Unexpected event"),
1819         }
1820 }
1821
1822 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1823 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1824         let events = node.node.get_and_clear_pending_events();
1825         assert_eq!(events.len(), 1);
1826         match events[0] {
1827                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1828                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1829                 },
1830                 _ => panic!("Unexpected event"),
1831         }
1832 }
1833
1834 pub struct PaymentFailedConditions<'a> {
1835         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1836         pub(crate) expected_blamed_scid: Option<u64>,
1837         pub(crate) expected_blamed_chan_closed: Option<bool>,
1838         pub(crate) expected_mpp_parts_remain: bool,
1839 }
1840
1841 impl<'a> PaymentFailedConditions<'a> {
1842         pub fn new() -> Self {
1843                 Self {
1844                         expected_htlc_error_data: None,
1845                         expected_blamed_scid: None,
1846                         expected_blamed_chan_closed: None,
1847                         expected_mpp_parts_remain: false,
1848                 }
1849         }
1850         pub fn mpp_parts_remain(mut self) -> Self {
1851                 self.expected_mpp_parts_remain = true;
1852                 self
1853         }
1854         pub fn blamed_scid(mut self, scid: u64) -> Self {
1855                 self.expected_blamed_scid = Some(scid);
1856                 self
1857         }
1858         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1859                 self.expected_blamed_chan_closed = Some(closed);
1860                 self
1861         }
1862         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1863                 self.expected_htlc_error_data = Some((code, data));
1864                 self
1865         }
1866 }
1867
1868 #[cfg(test)]
1869 macro_rules! expect_payment_failed_with_update {
1870         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1871                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1872                         &$node, $expected_payment_hash, $payment_failed_permanently,
1873                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1874                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1875         }
1876 }
1877
1878 #[cfg(test)]
1879 macro_rules! expect_payment_failed {
1880         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1881                 #[allow(unused_mut)]
1882                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1883                 $(
1884                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1885                 )*
1886                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1887         };
1888 }
1889
1890 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1891         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1892         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1893 ) {
1894         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
1895         let expected_payment_id = match &payment_failed_events[0] {
1896                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
1897                         #[cfg(test)]
1898                         error_code,
1899                         #[cfg(test)]
1900                         error_data, .. } => {
1901                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
1902                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1903                         #[cfg(test)]
1904                         {
1905                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1906                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1907                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
1908                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
1909                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1910                                 }
1911                         }
1912
1913                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1914                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
1915                                         match upd {
1916                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
1917                                                         if let Some(scid) = conditions.expected_blamed_scid {
1918                                                                 assert_eq!(msg.contents.short_channel_id, scid);
1919                                                         }
1920                                                         const CHAN_DISABLED_FLAG: u8 = 2;
1921                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1922                                                 },
1923                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
1924                                                         if let Some(scid) = conditions.expected_blamed_scid {
1925                                                                 assert_eq!(*short_channel_id, scid);
1926                                                         }
1927                                                         assert!(is_permanent);
1928                                                 },
1929                                                 _ => panic!("Unexpected update type"),
1930                                         }
1931                                 } else { panic!("Expected network update"); }
1932                         }
1933
1934                         payment_id.unwrap()
1935                 },
1936                 _ => panic!("Unexpected event"),
1937         };
1938         if !conditions.expected_mpp_parts_remain {
1939                 match &payment_failed_events[1] {
1940                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1941                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1942                                 assert_eq!(*payment_id, expected_payment_id);
1943                         }
1944                         _ => panic!("Unexpected second event"),
1945                 }
1946         }
1947 }
1948
1949 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1950         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1951         conditions: PaymentFailedConditions<'e>
1952 ) {
1953         let events = node.node.get_and_clear_pending_events();
1954         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
1955 }
1956
1957 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 {
1958         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1959         origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1960         check_added_monitors!(origin_node, expected_paths.len());
1961         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1962         payment_id
1963 }
1964
1965 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>) -> Option<Event> {
1966         let mut payment_event = SendEvent::from_event(ev);
1967         let mut prev_node = origin_node;
1968         let mut event = None;
1969
1970         for (idx, &node) in expected_path.iter().enumerate() {
1971                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1972
1973                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1974                 check_added_monitors!(node, 0);
1975                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1976
1977                 expect_pending_htlcs_forwardable!(node);
1978
1979                 if idx == expected_path.len() - 1 && clear_recipient_events {
1980                         let events_2 = node.node.get_and_clear_pending_events();
1981                         if payment_claimable_expected {
1982                                 assert_eq!(events_2.len(), 1);
1983                                 match events_2[0] {
1984                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id, claim_deadline } => {
1985                                                 assert_eq!(our_payment_hash, *payment_hash);
1986                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1987                                                 match &purpose {
1988                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1989                                                                 assert_eq!(expected_preimage, *payment_preimage);
1990                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1991                                                         },
1992                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1993                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1994                                                                 assert!(our_payment_secret.is_none());
1995                                                         },
1996                                                 }
1997                                                 assert_eq!(amount_msat, recv_value);
1998                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1999                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2000                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2001                                         },
2002                                         _ => panic!("Unexpected event"),
2003                                 }
2004                                 event = Some(events_2[0].clone());
2005                         } else {
2006                                 assert!(events_2.is_empty());
2007                         }
2008                 } else if idx != expected_path.len() - 1 {
2009                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2010                         assert_eq!(events_2.len(), 1);
2011                         check_added_monitors!(node, 1);
2012                         payment_event = SendEvent::from_event(events_2.remove(0));
2013                         assert_eq!(payment_event.msgs.len(), 1);
2014                 }
2015
2016                 prev_node = node;
2017         }
2018         event
2019 }
2020
2021 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>) -> Option<Event> {
2022         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2023 }
2024
2025 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) {
2026         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2027         assert_eq!(events.len(), expected_route.len());
2028         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2029                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2030                 // Once we've gotten through all the HTLCs, the last one should result in a
2031                 // PaymentClaimable (but each previous one should not!), .
2032                 let expect_payment = path_idx == expected_route.len() - 1;
2033                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2034         }
2035 }
2036
2037 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) {
2038         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2039         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2040         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2041 }
2042
2043 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 {
2044         for path in expected_paths.iter() {
2045                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2046         }
2047         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2048
2049         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2050         assert_eq!(claim_event.len(), 1);
2051         match claim_event[0] {
2052                 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2053                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2054                         assert_eq!(preimage, our_payment_preimage),
2055                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2056                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2057                 _ => panic!(),
2058         }
2059
2060         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2061
2062         let mut expected_total_fee_msat = 0;
2063
2064         macro_rules! msgs_from_ev {
2065                 ($ev: expr) => {
2066                         match $ev {
2067                                 &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 } } => {
2068                                         assert!(update_add_htlcs.is_empty());
2069                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2070                                         assert!(update_fail_htlcs.is_empty());
2071                                         assert!(update_fail_malformed_htlcs.is_empty());
2072                                         assert!(update_fee.is_none());
2073                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2074                                 },
2075                                 _ => panic!("Unexpected event"),
2076                         }
2077                 }
2078         }
2079         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2080         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2081         assert_eq!(events.len(), expected_paths.len());
2082
2083         if events.len() == 1 {
2084                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2085         } else {
2086                 for expected_path in expected_paths.iter() {
2087                         // For MPP payments, we always want the message to the first node in the path.
2088                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2089                         per_path_msgs.push(msgs_from_ev!(&ev));
2090                 }
2091         }
2092
2093         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2094                 let mut next_msgs = Some(path_msgs);
2095                 let mut expected_next_node = next_hop;
2096
2097                 macro_rules! last_update_fulfill_dance {
2098                         ($node: expr, $prev_node: expr) => {
2099                                 {
2100                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2101                                         check_added_monitors!($node, 0);
2102                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2103                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2104                                 }
2105                         }
2106                 }
2107                 macro_rules! mid_update_fulfill_dance {
2108                         ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2109                                 {
2110                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2111                                         let fee = {
2112                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2113                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2114                                                         .unwrap().lock().unwrap();
2115                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2116                                                 if let Some(prev_config) = channel.prev_config() {
2117                                                         prev_config.forwarding_fee_base_msat
2118                                                 } else {
2119                                                         channel.config().forwarding_fee_base_msat
2120                                                 }
2121                                         };
2122                                         expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2123                                         expected_total_fee_msat += fee as u64;
2124                                         check_added_monitors!($node, 1);
2125                                         let new_next_msgs = if $new_msgs {
2126                                                 let events = $node.node.get_and_clear_pending_msg_events();
2127                                                 assert_eq!(events.len(), 1);
2128                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2129                                                 expected_next_node = nexthop;
2130                                                 Some(res)
2131                                         } else {
2132                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2133                                                 None
2134                                         };
2135                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2136                                         next_msgs = new_next_msgs;
2137                                 }
2138                         }
2139                 }
2140
2141                 let mut prev_node = expected_route.last().unwrap();
2142                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2143                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2144                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2145                         if next_msgs.is_some() {
2146                                 // Since we are traversing in reverse, next_node is actually the previous node
2147                                 let next_node: &Node;
2148                                 if idx == expected_route.len() - 1 {
2149                                         next_node = origin_node;
2150                                 } else {
2151                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2152                                 }
2153                                 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2154                         } else {
2155                                 assert!(!update_next_msgs);
2156                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2157                         }
2158                         if !skip_last && idx == expected_route.len() - 1 {
2159                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2160                         }
2161
2162                         prev_node = node;
2163                 }
2164
2165                 if !skip_last {
2166                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2167                 }
2168         }
2169
2170         // Ensure that claim_funds is idempotent.
2171         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2172         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2173         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2174
2175         expected_total_fee_msat
2176 }
2177 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) {
2178         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2179         if !skip_last {
2180                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2181         }
2182 }
2183
2184 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2185         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2186 }
2187
2188 pub const TEST_FINAL_CLTV: u32 = 70;
2189
2190 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) {
2191         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2192                 .with_features(expected_route.last().unwrap().node.invoice_features());
2193         let route = get_route(origin_node, &payment_params, recv_value, TEST_FINAL_CLTV).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 res = send_along_route(origin_node, route, expected_route, recv_value);
2201         (res.0, res.1, res.2)
2202 }
2203
2204 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2205         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2206                 .with_features(expected_route.last().unwrap().node.invoice_features());
2207         let network_graph = origin_node.network_graph.read_only();
2208         let scorer = test_utils::TestScorer::new();
2209         let seed = [0u8; 32];
2210         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2211         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2212         let route = router::get_route(
2213                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2214                 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2215         assert_eq!(route.paths.len(), 1);
2216         assert_eq!(route.paths[0].len(), expected_route.len());
2217         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2218                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2219         }
2220
2221         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2222         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 },
2223                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2224 }
2225
2226 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2227         let res = route_payment(&origin, expected_route, recv_value);
2228         claim_payment(&origin, expected_route, res.0);
2229         res
2230 }
2231
2232 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) {
2233         for path in expected_paths.iter() {
2234                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2235         }
2236         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2237         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2238         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2239
2240         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2241 }
2242
2243 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) {
2244         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2245         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2246
2247         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2248         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2249         assert_eq!(events.len(), expected_paths.len());
2250         for ev in events.iter() {
2251                 let (update_fail, commitment_signed, node_id) = match ev {
2252                         &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 } } => {
2253                                 assert!(update_add_htlcs.is_empty());
2254                                 assert!(update_fulfill_htlcs.is_empty());
2255                                 assert_eq!(update_fail_htlcs.len(), 1);
2256                                 assert!(update_fail_malformed_htlcs.is_empty());
2257                                 assert!(update_fee.is_none());
2258                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2259                         },
2260                         _ => panic!("Unexpected event"),
2261                 };
2262                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2263         }
2264         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2265         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()));
2266
2267         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2268                 let mut next_msgs = Some(path_msgs);
2269                 let mut expected_next_node = next_hop;
2270                 let mut prev_node = expected_route.last().unwrap();
2271
2272                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2273                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2274                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2275                         if next_msgs.is_some() {
2276                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2277                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2278                                 if !update_next_node {
2279                                         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 }]);
2280                                 }
2281                         }
2282                         let events = node.node.get_and_clear_pending_msg_events();
2283                         if update_next_node {
2284                                 assert_eq!(events.len(), 1);
2285                                 match events[0] {
2286                                         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 } } => {
2287                                                 assert!(update_add_htlcs.is_empty());
2288                                                 assert!(update_fulfill_htlcs.is_empty());
2289                                                 assert_eq!(update_fail_htlcs.len(), 1);
2290                                                 assert!(update_fail_malformed_htlcs.is_empty());
2291                                                 assert!(update_fee.is_none());
2292                                                 expected_next_node = node_id.clone();
2293                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2294                                         },
2295                                         _ => panic!("Unexpected event"),
2296                                 }
2297                         } else {
2298                                 assert!(events.is_empty());
2299                         }
2300                         if !skip_last && idx == expected_route.len() - 1 {
2301                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2302                         }
2303
2304                         prev_node = node;
2305                 }
2306
2307                 if !skip_last {
2308                         let prev_node = expected_route.first().unwrap();
2309                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2310                         check_added_monitors!(origin_node, 0);
2311                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2312                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2313                         let events = origin_node.node.get_and_clear_pending_events();
2314                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2315
2316                         let expected_payment_id = match events[0] {
2317                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2318                                         assert_eq!(payment_hash, our_payment_hash);
2319                                         assert!(payment_failed_permanently);
2320                                         for (idx, hop) in expected_route.iter().enumerate() {
2321                                                 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2322                                         }
2323                                         payment_id.unwrap()
2324                                 },
2325                                 _ => panic!("Unexpected event"),
2326                         };
2327                         if i == expected_paths.len() - 1 {
2328                                 match events[1] {
2329                                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2330                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2331                                                 assert_eq!(*payment_id, expected_payment_id);
2332                                         }
2333                                         _ => panic!("Unexpected second event"),
2334                                 }
2335                         }
2336                 }
2337         }
2338
2339         // Ensure that fail_htlc_backwards is idempotent.
2340         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2341         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2342         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2343         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2344 }
2345
2346 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2347         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2348 }
2349
2350 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2351         let mut chan_mon_cfgs = Vec::new();
2352         for i in 0..node_count {
2353                 let tx_broadcaster = test_utils::TestBroadcaster {
2354                         txn_broadcasted: Mutex::new(Vec::new()),
2355                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2356                 };
2357                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2358                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2359                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2360                 let persister = test_utils::TestPersister::new();
2361                 let seed = [i as u8; 32];
2362                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2363                 let scorer = Mutex::new(test_utils::TestScorer::new());
2364
2365                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2366         }
2367
2368         chan_mon_cfgs
2369 }
2370
2371 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2372         let mut nodes = Vec::new();
2373
2374         for i in 0..node_count {
2375                 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);
2376                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2377                 let seed = [i as u8; 32];
2378                 nodes.push(NodeCfg {
2379                         chain_source: &chanmon_cfgs[i].chain_source,
2380                         logger: &chanmon_cfgs[i].logger,
2381                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2382                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2383                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2384                         chain_monitor,
2385                         keys_manager: &chanmon_cfgs[i].keys_manager,
2386                         node_seed: seed,
2387                         network_graph,
2388                         override_init_features: Rc::new(RefCell::new(None)),
2389                 });
2390         }
2391
2392         nodes
2393 }
2394
2395 pub fn test_default_channel_config() -> UserConfig {
2396         let mut default_config = UserConfig::default();
2397         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2398         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2399         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2400         default_config.channel_handshake_config.announced_channel = true;
2401         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2402         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2403         // It now defaults to 1, so we simply set it to the expected value here.
2404         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2405         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2406         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2407         default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2408         default_config
2409 }
2410
2411 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>> {
2412         let mut chanmgrs = Vec::new();
2413         for i in 0..node_count {
2414                 let network = Network::Testnet;
2415                 let params = ChainParameters {
2416                         network,
2417                         best_block: BestBlock::from_network(network),
2418                 };
2419                 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,
2420                         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);
2421                 chanmgrs.push(node);
2422         }
2423
2424         chanmgrs
2425 }
2426
2427 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>> {
2428         let mut nodes = Vec::new();
2429         let chan_count = Rc::new(RefCell::new(0));
2430         let payment_count = Rc::new(RefCell::new(0));
2431         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2432
2433         for i in 0..node_count {
2434                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2435                 nodes.push(Node{
2436                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2437                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2438                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2439                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2440                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2441                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2442                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2443                         connect_style: Rc::clone(&connect_style),
2444                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2445                 })
2446         }
2447
2448         for i in 0..node_count {
2449                 for j in (i+1)..node_count {
2450                         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();
2451                         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();
2452                 }
2453         }
2454
2455         nodes
2456 }
2457
2458 // Note that the following only works for CLTV values up to 128
2459 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2460
2461 #[derive(PartialEq)]
2462 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2463 /// Tests that the given node has broadcast transactions for the given Channel
2464 ///
2465 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2466 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2467 /// broadcast and the revoked outputs were claimed.
2468 ///
2469 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2470 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2471 ///
2472 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2473 /// also fail.
2474 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>  {
2475         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2476         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2477
2478         let mut res = Vec::with_capacity(2);
2479         node_txn.retain(|tx| {
2480                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2481                         check_spends!(tx, chan.3);
2482                         if commitment_tx.is_none() {
2483                                 res.push(tx.clone());
2484                         }
2485                         false
2486                 } else { true }
2487         });
2488         if let Some(explicit_tx) = commitment_tx {
2489                 res.push(explicit_tx.clone());
2490         }
2491
2492         assert_eq!(res.len(), 1);
2493
2494         if has_htlc_tx != HTLCType::NONE {
2495                 node_txn.retain(|tx| {
2496                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2497                                 check_spends!(tx, res[0]);
2498                                 if has_htlc_tx == HTLCType::TIMEOUT {
2499                                         assert!(tx.lock_time.0 != 0);
2500                                 } else {
2501                                         assert!(tx.lock_time.0 == 0);
2502                                 }
2503                                 res.push(tx.clone());
2504                                 false
2505                         } else { true }
2506                 });
2507                 assert!(res.len() == 2 || res.len() == 3);
2508                 if res.len() == 3 {
2509                         assert_eq!(res[1], res[2]);
2510                 }
2511         }
2512
2513         assert!(node_txn.is_empty());
2514         res
2515 }
2516
2517 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2518 /// HTLC transaction.
2519 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2520         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2521         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2522         // for revoked htlc outputs
2523         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2524         node_txn.retain(|tx| {
2525                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2526                         check_spends!(tx, revoked_tx);
2527                         false
2528                 } else { true }
2529         });
2530         node_txn.retain(|tx| {
2531                 check_spends!(tx, commitment_revoked_tx);
2532                 false
2533         });
2534         assert!(node_txn.is_empty());
2535 }
2536
2537 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2538         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2539
2540         assert!(node_txn.len() >= 1);
2541         assert_eq!(node_txn[0].input.len(), 1);
2542         let mut found_prev = false;
2543
2544         for tx in prev_txn {
2545                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2546                         check_spends!(node_txn[0], tx);
2547                         let mut iter = node_txn[0].input[0].witness.iter();
2548                         iter.next().expect("expected 3 witness items");
2549                         iter.next().expect("expected 3 witness items");
2550                         assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2551                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2552
2553                         found_prev = true;
2554                         break;
2555                 }
2556         }
2557         assert!(found_prev);
2558
2559         let mut res = Vec::new();
2560         mem::swap(&mut *node_txn, &mut res);
2561         res
2562 }
2563
2564 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)  {
2565         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2566         assert_eq!(events_1.len(), 2);
2567         let as_update = match events_1[0] {
2568                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2569                         msg.clone()
2570                 },
2571                 _ => panic!("Unexpected event"),
2572         };
2573         match events_1[1] {
2574                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2575                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2576                         assert_eq!(msg.data, expected_error);
2577                         if needs_err_handle {
2578                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2579                         }
2580                 },
2581                 _ => panic!("Unexpected event"),
2582         }
2583
2584         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2585         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2586         let bs_update = match events_2[0] {
2587                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2588                         msg.clone()
2589                 },
2590                 _ => panic!("Unexpected event"),
2591         };
2592         if !needs_err_handle {
2593                 match events_2[1] {
2594                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2595                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2596                                 assert_eq!(msg.data, expected_error);
2597                         },
2598                         _ => panic!("Unexpected event"),
2599                 }
2600         }
2601
2602         for node in nodes {
2603                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2604                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2605         }
2606 }
2607
2608 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2609         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2610 }
2611
2612 #[cfg(test)]
2613 macro_rules! get_channel_value_stat {
2614         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2615                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2616                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2617                 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2618                 chan.get_value_stat()
2619         }}
2620 }
2621
2622 macro_rules! get_chan_reestablish_msgs {
2623         ($src_node: expr, $dst_node: expr) => {
2624                 {
2625                         let mut announcements = $crate::prelude::HashSet::new();
2626                         let mut res = Vec::with_capacity(1);
2627                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2628                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2629                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2630                                         res.push(msg.clone());
2631                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2632                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2633                                         announcements.insert(msg.contents.short_channel_id);
2634                                 } else {
2635                                         panic!("Unexpected event")
2636                                 }
2637                         }
2638                         for chan in $src_node.node.list_channels() {
2639                                 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2640                                         if let Some(scid) = chan.short_channel_id {
2641                                                 assert!(announcements.remove(&scid));
2642                                         }
2643                                 }
2644                         }
2645                         assert!(announcements.is_empty());
2646                         res
2647                 }
2648         }
2649 }
2650
2651 macro_rules! handle_chan_reestablish_msgs {
2652         ($src_node: expr, $dst_node: expr) => {
2653                 {
2654                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2655                         let mut idx = 0;
2656                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2657                                 idx += 1;
2658                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2659                                 Some(msg.clone())
2660                         } else {
2661                                 None
2662                         };
2663
2664                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2665                                 idx += 1;
2666                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2667                         }
2668
2669                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2670                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2671                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2672                                 idx += 1;
2673                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2674                                 had_channel_update = true;
2675                         }
2676
2677                         let mut revoke_and_ack = None;
2678                         let mut commitment_update = None;
2679                         let order = if let Some(ev) = msg_events.get(idx) {
2680                                 match ev {
2681                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2682                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2683                                                 revoke_and_ack = Some(msg.clone());
2684                                                 idx += 1;
2685                                                 RAACommitmentOrder::RevokeAndACKFirst
2686                                         },
2687                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2688                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2689                                                 commitment_update = Some(updates.clone());
2690                                                 idx += 1;
2691                                                 RAACommitmentOrder::CommitmentFirst
2692                                         },
2693                                         _ => RAACommitmentOrder::CommitmentFirst,
2694                                 }
2695                         } else {
2696                                 RAACommitmentOrder::CommitmentFirst
2697                         };
2698
2699                         if let Some(ev) = msg_events.get(idx) {
2700                                 match ev {
2701                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2702                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2703                                                 assert!(revoke_and_ack.is_none());
2704                                                 revoke_and_ack = Some(msg.clone());
2705                                                 idx += 1;
2706                                         },
2707                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2708                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2709                                                 assert!(commitment_update.is_none());
2710                                                 commitment_update = Some(updates.clone());
2711                                                 idx += 1;
2712                                         },
2713                                         _ => {},
2714                                 }
2715                         }
2716
2717                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2718                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2719                                 idx += 1;
2720                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2721                                 assert!(!had_channel_update);
2722                         }
2723
2724                         assert_eq!(msg_events.len(), idx);
2725
2726                         (channel_ready, revoke_and_ack, commitment_update, order)
2727                 }
2728         }
2729 }
2730
2731 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2732 /// for claims/fails they are separated out.
2733 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))  {
2734         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();
2735         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2736         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();
2737         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2738
2739         if send_channel_ready.0 {
2740                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2741                 // from b
2742                 for reestablish in reestablish_1.iter() {
2743                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2744                 }
2745         }
2746         if send_channel_ready.1 {
2747                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2748                 // from a
2749                 for reestablish in reestablish_2.iter() {
2750                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2751                 }
2752         }
2753         if send_channel_ready.0 || send_channel_ready.1 {
2754                 // If we expect any channel_ready's, both sides better have set
2755                 // next_holder_commitment_number to 1
2756                 for reestablish in reestablish_1.iter() {
2757                         assert_eq!(reestablish.next_local_commitment_number, 1);
2758                 }
2759                 for reestablish in reestablish_2.iter() {
2760                         assert_eq!(reestablish.next_local_commitment_number, 1);
2761                 }
2762         }
2763
2764         let mut resp_1 = Vec::new();
2765         for msg in reestablish_1 {
2766                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2767                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2768         }
2769         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2770                 check_added_monitors!(node_b, 1);
2771         } else {
2772                 check_added_monitors!(node_b, 0);
2773         }
2774
2775         let mut resp_2 = Vec::new();
2776         for msg in reestablish_2 {
2777                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2778                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2779         }
2780         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2781                 check_added_monitors!(node_a, 1);
2782         } else {
2783                 check_added_monitors!(node_a, 0);
2784         }
2785
2786         // We don't yet support both needing updates, as that would require a different commitment dance:
2787         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2788                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2789                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2790                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2791
2792         for chan_msgs in resp_1.drain(..) {
2793                 if send_channel_ready.0 {
2794                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2795                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2796                         if !announcement_event.is_empty() {
2797                                 assert_eq!(announcement_event.len(), 1);
2798                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2799                                         //TODO: Test announcement_sigs re-sending
2800                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2801                         }
2802                 } else {
2803                         assert!(chan_msgs.0.is_none());
2804                 }
2805                 if pending_raa.0 {
2806                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2807                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2808                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2809                         check_added_monitors!(node_a, 1);
2810                 } else {
2811                         assert!(chan_msgs.1.is_none());
2812                 }
2813                 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 {
2814                         let commitment_update = chan_msgs.2.unwrap();
2815                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2816                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2817                         } else {
2818                                 assert!(commitment_update.update_add_htlcs.is_empty());
2819                         }
2820                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2821                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2822                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2823                         for update_add in commitment_update.update_add_htlcs {
2824                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2825                         }
2826                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2827                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2828                         }
2829                         for update_fail in commitment_update.update_fail_htlcs {
2830                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2831                         }
2832
2833                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2834                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2835                         } else {
2836                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2837                                 check_added_monitors!(node_a, 1);
2838                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2839                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2840                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2841                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2842                                 check_added_monitors!(node_b, 1);
2843                         }
2844                 } else {
2845                         assert!(chan_msgs.2.is_none());
2846                 }
2847         }
2848
2849         for chan_msgs in resp_2.drain(..) {
2850                 if send_channel_ready.1 {
2851                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2852                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2853                         if !announcement_event.is_empty() {
2854                                 assert_eq!(announcement_event.len(), 1);
2855                                 match announcement_event[0] {
2856                                         MessageSendEvent::SendChannelUpdate { .. } => {},
2857                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2858                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2859                                 }
2860                         }
2861                 } else {
2862                         assert!(chan_msgs.0.is_none());
2863                 }
2864                 if pending_raa.1 {
2865                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2866                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2867                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2868                         check_added_monitors!(node_b, 1);
2869                 } else {
2870                         assert!(chan_msgs.1.is_none());
2871                 }
2872                 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 {
2873                         let commitment_update = chan_msgs.2.unwrap();
2874                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2875                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2876                         }
2877                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2878                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2879                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2880                         for update_add in commitment_update.update_add_htlcs {
2881                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2882                         }
2883                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2884                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2885                         }
2886                         for update_fail in commitment_update.update_fail_htlcs {
2887                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2888                         }
2889
2890                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2891                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2892                         } else {
2893                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2894                                 check_added_monitors!(node_b, 1);
2895                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2896                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2897                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2898                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2899                                 check_added_monitors!(node_a, 1);
2900                         }
2901                 } else {
2902                         assert!(chan_msgs.2.is_none());
2903                 }
2904         }
2905 }