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

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