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