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

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