git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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