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