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