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