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