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