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