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

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