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

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