_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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