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

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