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