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

   1 // This file is Copyright its original authors, visible in version control
   2 // history.
   3 //
   4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
   5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
   7 // You may not use this file except in accordance with one or both of these
   8 // licenses.
   9
  10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
  11 //! nodes for functional tests.
  12
  13 use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
  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_feerate {
 788         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
 789                 {
 790                         let mut per_peer_state_lock;
 791                         let mut peer_state_lock;
 792                         let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
 793                         chan.get_feerate_sat_per_1000_weight()
 794                 }
 795         }
 796 }
 797
 798 #[cfg(test)]
 799 macro_rules! get_opt_anchors {
 800         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
 801                 {
 802                         let mut per_peer_state_lock;
 803                         let mut peer_state_lock;
 804                         let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
 805                         chan.opt_anchors()
 806                 }
 807         }
 808 }
 809
 810 /// Returns a channel monitor given a channel id, making some naive assumptions
 811 #[macro_export]
 812 macro_rules! get_monitor {
 813         ($node: expr, $channel_id: expr) => {
 814                 {
 815                         use bitcoin::hashes::Hash;
 816                         let mut monitor = None;
 817                         // Assume funding vout is either 0 or 1 blindly
 818                         for index in 0..2 {
 819                                 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
 820                                         $crate::chain::transaction::OutPoint {
 821                                                 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
 822                                         })
 823                                 {
 824                                         monitor = Some(mon);
 825                                         break;
 826                                 }
 827                         }
 828                         monitor.unwrap()
 829                 }
 830         }
 831 }
 832
 833 /// Returns any local commitment transactions for the channel.
 834 #[macro_export]
 835 macro_rules! get_local_commitment_txn {
 836         ($node: expr, $channel_id: expr) => {
 837                 {
 838                         $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
 839                 }
 840         }
 841 }
 842
 843 /// Check the error from attempting a payment.
 844 #[macro_export]
 845 macro_rules! unwrap_send_err {
 846         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
 847                 match &$res {
 848                         &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
 849                                 assert_eq!(fails.len(), 1);
 850                                 match fails[0] {
 851                                         $type => { $check },
 852                                         _ => panic!(),
 853                                 }
 854                         },
 855                         &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
 856                                 assert_eq!(results.len(), 1);
 857                                 match results[0] {
 858                                         Err($type) => { $check },
 859                                         _ => panic!(),
 860                                 }
 861                         },
 862                         _ => panic!(),
 863                 }
 864         }
 865 }
 866
 867 /// Check whether N channel monitor(s) have been added.
 868 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
 869         if let Some(chain_monitor) = node.chain_monitor() {
 870                 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
 871                 assert_eq!(added_monitors.len(), count);
 872                 added_monitors.clear();
 873         }
 874 }
 875
 876 /// Check whether N channel monitor(s) have been added.
 877 ///
 878 /// Don't use this, use the identically-named function instead.
 879 #[macro_export]
 880 macro_rules! check_added_monitors {
 881         ($node: expr, $count: expr) => {
 882                 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
 883         }
 884 }
 885
 886 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> {
 887         let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
 888         for encoded in monitors_encoded {
 889                 let mut monitor_read = &encoded[..];
 890                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
 891                         ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
 892                 assert!(monitor_read.is_empty());
 893                 monitors_read.push(monitor);
 894         }
 895
 896         let mut node_read = &chanman_encoded[..];
 897         let (_, node_deserialized) = {
 898                 let mut channel_monitors = HashMap::new();
 899                 for monitor in monitors_read.iter_mut() {
 900                         assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
 901                 }
 902                 <(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 {
 903                         default_config,
 904                         entropy_source: node.keys_manager,
 905                         node_signer: node.keys_manager,
 906                         signer_provider: node.keys_manager,
 907                         fee_estimator: node.fee_estimator,
 908                         router: node.router,
 909                         chain_monitor: node.chain_monitor,
 910                         tx_broadcaster: node.tx_broadcaster,
 911                         logger: node.logger,
 912                         channel_monitors,
 913                 }).unwrap()
 914         };
 915         assert!(node_read.is_empty());
 916
 917         for monitor in monitors_read.drain(..) {
 918                 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
 919                         ChannelMonitorUpdateStatus::Completed);
 920                 check_added_monitors!(node, 1);
 921         }
 922
 923         node_deserialized
 924 }
 925
 926 #[cfg(test)]
 927 macro_rules! reload_node {
 928         ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
 929                 let chanman_encoded = $chanman_encoded;
 930
 931                 $persister = test_utils::TestPersister::new();
 932                 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
 933                 $node.chain_monitor = &$new_chain_monitor;
 934
 935                 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
 936                 $node.node = &$new_channelmanager;
 937         };
 938         ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
 939                 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
 940         };
 941 }
 942
 943 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) {
 944         let chan_id = *node.network_chan_count.borrow();
 945
 946         let events = node.node.get_and_clear_pending_events();
 947         assert_eq!(events.len(), 1);
 948         match events[0] {
 949                 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 950                         assert_eq!(counterparty_node_id, expected_counterparty_node_id);
 951                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 952                         assert_eq!(user_channel_id, expected_user_chan_id);
 953
 954                         let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
 955                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 956                         }]};
 957                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
 958                         (*temporary_channel_id, tx, funding_outpoint)
 959                 },
 960                 _ => panic!("Unexpected event"),
 961         }
 962 }
 963 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 {
 964         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
 965         assert_eq!(temporary_channel_id, expected_temporary_channel_id);
 966
 967         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
 968         check_added_monitors!(node_a, 0);
 969
 970         let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
 971         assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
 972         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
 973         {
 974                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
 975                 assert_eq!(added_monitors.len(), 1);
 976                 assert_eq!(added_monitors[0].0, funding_output);
 977                 added_monitors.clear();
 978         }
 979         expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
 980
 981         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()));
 982         {
 983                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
 984                 assert_eq!(added_monitors.len(), 1);
 985                 assert_eq!(added_monitors[0].0, funding_output);
 986                 added_monitors.clear();
 987         }
 988         expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
 989
 990         let events_4 = node_a.node.get_and_clear_pending_events();
 991         assert_eq!(events_4.len(), 0);
 992
 993         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 994         assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
 995         node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 996
 997         // Ensure that funding_transaction_generated is idempotent.
 998         assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
 999         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1000         check_added_monitors!(node_a, 0);
1001
1002         tx
1003 }
1004
1005 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1006 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]) {
1007         let initiator_channels = initiator.node.list_usable_channels().len();
1008         let receiver_channels = receiver.node.list_usable_channels().len();
1009
1010         initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1011         let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1012
1013         receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1014         let events = receiver.node.get_and_clear_pending_events();
1015         assert_eq!(events.len(), 1);
1016         match events[0] {
1017                 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1018                         receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1019                 },
1020                 _ => panic!("Unexpected event"),
1021         };
1022
1023         let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1024         assert_eq!(accept_channel.minimum_depth, 0);
1025         initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1026
1027         let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1028         initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1029         let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1030
1031         receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1032         check_added_monitors!(receiver, 1);
1033         let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1034         assert_eq!(bs_signed_locked.len(), 2);
1035         let as_channel_ready;
1036         match &bs_signed_locked[0] {
1037                 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1038                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1039                         initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1040                         expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1041                         expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1042                         check_added_monitors!(initiator, 1);
1043
1044                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1045                         assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1046
1047                         as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1048                 }
1049                 _ => panic!("Unexpected event"),
1050         }
1051         match &bs_signed_locked[1] {
1052                 MessageSendEvent::SendChannelReady { node_id, msg } => {
1053                         assert_eq!(*node_id, initiator.node.get_our_node_id());
1054                         initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1055                         expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1056                 }
1057                 _ => panic!("Unexpected event"),
1058         }
1059
1060         receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1061         expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1062
1063         let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1064         let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1065
1066         initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1067         receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1068
1069         assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1070         assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1071
1072         (tx, as_channel_ready.channel_id)
1073 }
1074
1075 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 {
1076         let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1077         let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1078         assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1079         assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1080         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1081         let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1082         assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1083         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1084         assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1085
1086         sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1087 }
1088
1089 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) {
1090         confirm_transaction_at(node_conf, tx, conf_height);
1091         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1092         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()));
1093 }
1094
1095 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]) {
1096         let channel_id;
1097         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1098         assert_eq!(events_6.len(), 3);
1099         let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1100                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1101                 2
1102         } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1103                 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1104                 1
1105         } else { panic!("Unexpected event: {:?}", events_6[1]); };
1106         ((match events_6[0] {
1107                 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1108                         channel_id = msg.channel_id.clone();
1109                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1110                         msg.clone()
1111                 },
1112                 _ => panic!("Unexpected event"),
1113         }, match events_6[announcement_sigs_idx] {
1114                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1115                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
1116                         msg.clone()
1117                 },
1118                 _ => panic!("Unexpected event"),
1119         }), channel_id)
1120 }
1121
1122 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]) {
1123         let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1124         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1125         confirm_transaction_at(node_a, tx, conf_height);
1126         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1127         expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1128         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1129 }
1130
1131 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) {
1132         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1133         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1134         (msgs, chan_id, tx)
1135 }
1136
1137 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) {
1138         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1139         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1140         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1141
1142         let events_7 = node_b.node.get_and_clear_pending_msg_events();
1143         assert_eq!(events_7.len(), 1);
1144         let (announcement, bs_update) = match events_7[0] {
1145                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1146                         (msg, update_msg.clone().unwrap())
1147                 },
1148                 _ => panic!("Unexpected event"),
1149         };
1150
1151         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1152         let events_8 = node_a.node.get_and_clear_pending_msg_events();
1153         assert_eq!(events_8.len(), 1);
1154         let as_update = match events_8[0] {
1155                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1156                         assert!(*announcement == *msg);
1157                         let update_msg = update_msg.clone().unwrap();
1158                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1159                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1160                         update_msg
1161                 },
1162                 _ => panic!("Unexpected event"),
1163         };
1164
1165         *node_a.network_chan_count.borrow_mut() += 1;
1166
1167         expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1168         ((*announcement).clone(), as_update, bs_update)
1169 }
1170
1171 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) {
1172         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1173 }
1174
1175 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) {
1176         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1177         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1178         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1179 }
1180
1181 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) {
1182         let mut no_announce_cfg = test_default_channel_config();
1183         no_announce_cfg.channel_handshake_config.announced_channel = false;
1184         nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1185         let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1186         nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1187         let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1188         nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1189
1190         let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1191         nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1192         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()));
1193         check_added_monitors!(nodes[b], 1);
1194
1195         let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1196         expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1197
1198         nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1199         expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1200         check_added_monitors!(nodes[a], 1);
1201
1202         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1203         assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1204         nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1205
1206         let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1207         confirm_transaction_at(&nodes[a], &tx, conf_height);
1208         connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1209         confirm_transaction_at(&nodes[b], &tx, conf_height);
1210         connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1211         let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1212         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()));
1213         expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1214         let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1215         nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1216         expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1217         let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1218
1219         nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1220         nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1221
1222         let mut found_a = false;
1223         for chan in nodes[a].node.list_usable_channels() {
1224                 if chan.channel_id == as_channel_ready.channel_id {
1225                         assert!(!found_a);
1226                         found_a = true;
1227                         assert!(!chan.is_public);
1228                 }
1229         }
1230         assert!(found_a);
1231
1232         let mut found_b = false;
1233         for chan in nodes[b].node.list_usable_channels() {
1234                 if chan.channel_id == as_channel_ready.channel_id {
1235                         assert!(!found_b);
1236                         found_b = true;
1237                         assert!(!chan.is_public);
1238                 }
1239         }
1240         assert!(found_b);
1241
1242         (as_channel_ready, tx)
1243 }
1244
1245 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) {
1246         for node in nodes {
1247                 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1248                 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1249                 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1250
1251                 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1252                 // forwarding info for local channels even if its not accepted in the network graph.
1253                 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1254                 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1255         }
1256 }
1257
1258 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1259         for outp in tx.output.iter() {
1260                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1261         }
1262         let mut total_value_in = 0;
1263         for input in tx.input.iter() {
1264                 total_value_in += get_output(&input.previous_output).unwrap().value;
1265         }
1266         let mut total_value_out = 0;
1267         for output in tx.output.iter() {
1268                 total_value_out += output.value;
1269         }
1270         let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1271         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1272         assert!(total_value_out + min_fee <= total_value_in);
1273         tx.verify(get_output).unwrap();
1274 }
1275
1276 #[macro_export]
1277 macro_rules! check_spends {
1278         ($tx: expr, $($spends_txn: expr),*) => {
1279                 {
1280                         $(
1281                         for outp in $spends_txn.output.iter() {
1282                                 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1283                         }
1284                         )*
1285                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1286                                 $(
1287                                         if out_point.txid == $spends_txn.txid() {
1288                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
1289                                         }
1290                                 )*
1291                                 None
1292                         };
1293                         $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1294                 }
1295         }
1296 }
1297
1298 macro_rules! get_closing_signed_broadcast {
1299         ($node: expr, $dest_pubkey: expr) => {
1300                 {
1301                         let events = $node.get_and_clear_pending_msg_events();
1302                         assert!(events.len() == 1 || events.len() == 2);
1303                         (match events[events.len() - 1] {
1304                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1305                                         assert_eq!(msg.contents.flags & 2, 2);
1306                                         msg.clone()
1307                                 },
1308                                 _ => panic!("Unexpected event"),
1309                         }, if events.len() == 2 {
1310                                 match events[0] {
1311                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1312                                                 assert_eq!(*node_id, $dest_pubkey);
1313                                                 Some(msg.clone())
1314                                         },
1315                                         _ => panic!("Unexpected event"),
1316                                 }
1317                         } else { None })
1318                 }
1319         }
1320 }
1321
1322 #[cfg(test)]
1323 macro_rules! check_warn_msg {
1324         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1325                 let msg_events = $node.node.get_and_clear_pending_msg_events();
1326                 assert_eq!(msg_events.len(), 1);
1327                 match msg_events[0] {
1328                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1329                                 assert_eq!(node_id, $recipient_node_id);
1330                                 assert_eq!(msg.channel_id, $chan_id);
1331                                 msg.data.clone()
1332                         },
1333                         _ => panic!("Unexpected event"),
1334                 }
1335         }}
1336 }
1337
1338 /// Check that a channel's closing channel update has been broadcasted, and optionally
1339 /// check whether an error message event has occurred.
1340 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1341         let msg_events = node.node.get_and_clear_pending_msg_events();
1342         assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1343         msg_events.into_iter().filter_map(|msg_event| {
1344                 match msg_event {
1345                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1346                                 assert_eq!(msg.contents.flags & 2, 2);
1347                                 None
1348                         },
1349                         MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1350                                 assert!(with_error_msg);
1351                                 // TODO: Check node_id
1352                                 Some(msg.clone())
1353                         },
1354                         _ => panic!("Unexpected event"),
1355                 }
1356         }).collect()
1357 }
1358
1359 /// Check that a channel's closing channel update has been broadcasted, and optionally
1360 /// check whether an error message event has occurred.
1361 ///
1362 /// Don't use this, use the identically-named function instead.
1363 #[macro_export]
1364 macro_rules! check_closed_broadcast {
1365         ($node: expr, $with_error_msg: expr) => {
1366                 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1367         }
1368 }
1369
1370 /// Check that a channel's closing channel events has been issued
1371 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1372         let events = node.node.get_and_clear_pending_events();
1373         assert_eq!(events.len(), events_count, "{:?}", events);
1374         let mut issues_discard_funding = false;
1375         for event in events {
1376                 match event {
1377                         Event::ChannelClosed { ref reason, .. } => {
1378                                 assert_eq!(*reason, expected_reason);
1379                         },
1380                         Event::DiscardFunding { .. } => {
1381                                 issues_discard_funding = true;
1382                         }
1383                         _ => panic!("Unexpected event"),
1384                 }
1385         }
1386         assert_eq!(is_check_discard_funding, issues_discard_funding);
1387 }
1388
1389 /// Check that a channel's closing channel events has been issued
1390 ///
1391 /// Don't use this, use the identically-named function instead.
1392 #[macro_export]
1393 macro_rules! check_closed_event {
1394         ($node: expr, $events: expr, $reason: expr) => {
1395                 check_closed_event!($node, $events, $reason, false);
1396         };
1397         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1398                 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1399         }
1400 }
1401
1402 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) {
1403         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) };
1404         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) };
1405         let (tx_a, tx_b);
1406
1407         node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1408         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1409
1410         let events_1 = node_b.get_and_clear_pending_msg_events();
1411         assert!(events_1.len() >= 1);
1412         let shutdown_b = match events_1[0] {
1413                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1414                         assert_eq!(node_id, &node_a.get_our_node_id());
1415                         msg.clone()
1416                 },
1417                 _ => panic!("Unexpected event"),
1418         };
1419
1420         let closing_signed_b = if !close_inbound_first {
1421                 assert_eq!(events_1.len(), 1);
1422                 None
1423         } else {
1424                 Some(match events_1[1] {
1425                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1426                                 assert_eq!(node_id, &node_a.get_our_node_id());
1427                                 msg.clone()
1428                         },
1429                         _ => panic!("Unexpected event"),
1430                 })
1431         };
1432
1433         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1434         let (as_update, bs_update) = if close_inbound_first {
1435                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1436                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1437
1438                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1439                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1440                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1441                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1442
1443                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1444                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1445                 assert!(none_a.is_none());
1446                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1447                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1448                 (as_update, bs_update)
1449         } else {
1450                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1451
1452                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1453                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1454
1455                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1456                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1457                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1458
1459                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1460                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1461                 assert!(none_b.is_none());
1462                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1463                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1464                 (as_update, bs_update)
1465         };
1466         assert_eq!(tx_a, tx_b);
1467         check_spends!(tx_a, funding_tx);
1468
1469         (as_update, bs_update, tx_a)
1470 }
1471
1472 pub struct SendEvent {
1473         pub node_id: PublicKey,
1474         pub msgs: Vec<msgs::UpdateAddHTLC>,
1475         pub commitment_msg: msgs::CommitmentSigned,
1476 }
1477 impl SendEvent {
1478         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1479                 assert!(updates.update_fulfill_htlcs.is_empty());
1480                 assert!(updates.update_fail_htlcs.is_empty());
1481                 assert!(updates.update_fail_malformed_htlcs.is_empty());
1482                 assert!(updates.update_fee.is_none());
1483                 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1484         }
1485
1486         pub fn from_event(event: MessageSendEvent) -> SendEvent {
1487                 match event {
1488                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1489                         _ => panic!("Unexpected event type!"),
1490                 }
1491         }
1492
1493         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1494                 let mut events = node.node.get_and_clear_pending_msg_events();
1495                 assert_eq!(events.len(), 1);
1496                 SendEvent::from_event(events.pop().unwrap())
1497         }
1498 }
1499
1500 #[macro_export]
1501 /// Don't use this, use the identically-named function instead.
1502 macro_rules! expect_pending_htlcs_forwardable_conditions {
1503         ($node: expr, $expected_failures: expr) => {
1504                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1505         }
1506 }
1507
1508 #[macro_export]
1509 macro_rules! expect_htlc_handling_failed_destinations {
1510         ($events: expr, $expected_failures: expr) => {{
1511                 for event in $events {
1512                         match event {
1513                                 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1514                                 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1515                                         assert!($expected_failures.contains(&failed_next_destination))
1516                                 },
1517                                 _ => panic!("Unexpected destination"),
1518                         }
1519                 }
1520         }}
1521 }
1522
1523 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1524 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1525 /// `expected_failures` set.
1526 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1527         match events[0] {
1528                 Event::PendingHTLCsForwardable { .. } => { },
1529                 _ => panic!("Unexpected event {:?}", events),
1530         };
1531
1532         let count = expected_failures.len() + 1;
1533         assert_eq!(events.len(), count);
1534
1535         if expected_failures.len() > 0 {
1536                 expect_htlc_handling_failed_destinations!(events, expected_failures)
1537         }
1538 }
1539
1540 #[macro_export]
1541 /// Clears (and ignores) a PendingHTLCsForwardable event
1542 ///
1543 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1544 /// set instead.
1545 macro_rules! expect_pending_htlcs_forwardable_ignore {
1546         ($node: expr) => {
1547                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1548         }
1549 }
1550
1551 #[macro_export]
1552 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1553 ///
1554 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1555 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1556         ($node: expr, $expected_failures: expr) => {
1557                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1558         }
1559 }
1560
1561 #[macro_export]
1562 /// Handles a PendingHTLCsForwardable event
1563 macro_rules! expect_pending_htlcs_forwardable {
1564         ($node: expr) => {{
1565                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1566                 $node.node.process_pending_htlc_forwards();
1567
1568                 // Ensure process_pending_htlc_forwards is idempotent.
1569                 $node.node.process_pending_htlc_forwards();
1570         }};
1571 }
1572
1573 #[macro_export]
1574 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1575 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1576         ($node: expr, $expected_failures: expr) => {{
1577                 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1578                 $node.node.process_pending_htlc_forwards();
1579
1580                 // Ensure process_pending_htlc_forwards is idempotent.
1581                 $node.node.process_pending_htlc_forwards();
1582         }}
1583 }
1584
1585 #[cfg(test)]
1586 macro_rules! expect_pending_htlcs_forwardable_from_events {
1587         ($node: expr, $events: expr, $ignore: expr) => {{
1588                 assert_eq!($events.len(), 1);
1589                 match $events[0] {
1590                         Event::PendingHTLCsForwardable { .. } => { },
1591                         _ => panic!("Unexpected event"),
1592                 };
1593                 if $ignore {
1594                         $node.node.process_pending_htlc_forwards();
1595
1596                         // Ensure process_pending_htlc_forwards is idempotent.
1597                         $node.node.process_pending_htlc_forwards();
1598                 }
1599         }}
1600 }
1601
1602 #[macro_export]
1603 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1604 /// commitment update.
1605 macro_rules! commitment_signed_dance {
1606         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1607                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1608         };
1609         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1610                 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1611         };
1612         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1613                 {
1614                         $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1615                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1616                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1617                         check_added_monitors(&$node_a, 1);
1618                         let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1619                         assert!(extra_msg_option.is_none());
1620                         bs_revoke_and_ack
1621                 }
1622         };
1623         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1624                 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1625         };
1626         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1627                 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1628         }
1629 }
1630
1631 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1632 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1633 /// `revoke_and_ack` response to it.
1634 ///
1635 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1636 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1637         let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1638         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1639         check_added_monitors(node_a, 1);
1640         extra_msg_option
1641 }
1642
1643 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1644 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1645 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1646 /// have included.
1647 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1648         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1649         check_added_monitors!(node_b, 0);
1650         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1651         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1652         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1653         check_added_monitors!(node_b, 1);
1654         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1655         let (bs_revoke_and_ack, extra_msg_option) = {
1656                 let mut events = node_b.node.get_and_clear_pending_msg_events();
1657                 assert!(events.len() <= 2);
1658                 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1659                 (match node_a_event {
1660                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1661                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
1662                                 (*msg).clone()
1663                         },
1664                         _ => panic!("Unexpected event"),
1665                 }, events.get(0).map(|e| e.clone()))
1666         };
1667         check_added_monitors!(node_b, 1);
1668         if fail_backwards {
1669                 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1670                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1671         }
1672         (extra_msg_option, bs_revoke_and_ack)
1673 }
1674
1675 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1676 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1677 ///
1678 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1679 /// on failure or that no new messages are left over on success.
1680 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1681         check_added_monitors!(node_a, 0);
1682         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1683         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1684         check_added_monitors!(node_a, 1);
1685
1686         commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1687
1688         if skip_last_step { return; }
1689
1690         if fail_backwards {
1691                 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1692                         vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1693                 check_added_monitors!(node_a, 1);
1694
1695                 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1696                 let mut number_of_msg_events = 0;
1697                 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1698                         let peer_state = peer_state_mutex.lock().unwrap();
1699                         let cp_pending_msg_events = &peer_state.pending_msg_events;
1700                         number_of_msg_events += cp_pending_msg_events.len();
1701                         if cp_pending_msg_events.len() == 1 {
1702                                 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1703                                         assert_ne!(*cp_id, node_b.node.get_our_node_id());
1704                                 } else { panic!("Unexpected event"); }
1705                         }
1706                 }
1707                 // Expecting the failure backwards event to the previous hop (not `node_b`)
1708                 assert_eq!(number_of_msg_events, 1);
1709         } else {
1710                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1711         }
1712 }
1713
1714 /// Get a payment preimage and hash.
1715 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1716         let mut payment_count = recipient.network_payment_count.borrow_mut();
1717         let payment_preimage = PaymentPreimage([*payment_count; 32]);
1718         *payment_count += 1;
1719         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1720         let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1721         (payment_preimage, payment_hash, payment_secret)
1722 }
1723
1724 /// Get a payment preimage and hash.
1725 ///
1726 /// Don't use this, use the identically-named function instead.
1727 #[macro_export]
1728 macro_rules! get_payment_preimage_hash {
1729         ($dest_node: expr) => {
1730                 get_payment_preimage_hash!($dest_node, None)
1731         };
1732         ($dest_node: expr, $min_value_msat: expr) => {
1733                 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1734         };
1735         ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1736                 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1737         };
1738 }
1739
1740 /// Gets a route from the given sender to the node described in `payment_params`.
1741 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1742         let scorer = TestScorer::new();
1743         let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1744         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1745         router::get_route(
1746                 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1747                 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1748                 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1749         )
1750 }
1751
1752 /// Gets a route from the given sender to the node described in `payment_params`.
1753 ///
1754 /// Don't use this, use the identically-named function instead.
1755 #[macro_export]
1756 macro_rules! get_route {
1757         ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1758                 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1759         }
1760 }
1761
1762 #[cfg(test)]
1763 #[macro_export]
1764 macro_rules! get_route_and_payment_hash {
1765         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1766                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1767                         .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1768                 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1769         }};
1770         ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1771                 let (payment_preimage, payment_hash, payment_secret) =
1772                         $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1773                 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1774                 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1775         }}
1776 }
1777
1778 #[macro_export]
1779 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1780 macro_rules! expect_payment_claimable {
1781         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1782                 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1783         };
1784         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1785                 let events = $node.node.get_and_clear_pending_events();
1786                 assert_eq!(events.len(), 1);
1787                 match events[0] {
1788                         $crate::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1789                                 assert_eq!($expected_payment_hash, *payment_hash);
1790                                 assert_eq!($expected_recv_value, amount_msat);
1791                                 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1792                                 match purpose {
1793                                         $crate::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1794                                                 assert_eq!(&$expected_payment_preimage, payment_preimage);
1795                                                 assert_eq!($expected_payment_secret, *payment_secret);
1796                                         },
1797                                         _ => {},
1798                                 }
1799                         },
1800                         _ => panic!("Unexpected event"),
1801                 }
1802         }
1803 }
1804
1805 #[macro_export]
1806 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1807 macro_rules! expect_payment_claimed {
1808         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1809                 let events = $node.node.get_and_clear_pending_events();
1810                 assert_eq!(events.len(), 1);
1811                 match events[0] {
1812                         $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1813                                 assert_eq!($expected_payment_hash, *payment_hash);
1814                                 assert_eq!($expected_recv_value, amount_msat);
1815                         },
1816                         _ => panic!("Unexpected event"),
1817                 }
1818         }
1819 }
1820
1821 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1822         expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1823         expect_per_path_claims: bool,
1824 ) {
1825         let events = node.node().get_and_clear_pending_events();
1826         let expected_payment_hash = PaymentHash(
1827                 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1828         if expect_per_path_claims {
1829                 assert!(events.len() > 1);
1830         } else {
1831                 assert_eq!(events.len(), 1);
1832         }
1833         let expected_payment_id = match events[0] {
1834                 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1835                         assert_eq!(expected_payment_preimage, *payment_preimage);
1836                         assert_eq!(expected_payment_hash, *payment_hash);
1837                         if let Some(expected_fee_msat) = expected_fee_msat_opt {
1838                                 assert_eq!(*fee_paid_msat, expected_fee_msat);
1839                         } else {
1840                                 assert!(fee_paid_msat.is_some());
1841                         }
1842                         payment_id.unwrap()
1843                 },
1844                 _ => panic!("Unexpected event"),
1845         };
1846         if expect_per_path_claims {
1847                 for i in 1..events.len() {
1848                         match events[i] {
1849                                 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1850                                         assert_eq!(payment_id, expected_payment_id);
1851                                         assert_eq!(payment_hash, Some(expected_payment_hash));
1852                                 },
1853                                 _ => panic!("Unexpected event"),
1854                         }
1855                 }
1856         }
1857 }
1858
1859 #[cfg(test)]
1860 #[macro_export]
1861 macro_rules! expect_payment_sent_without_paths {
1862         ($node: expr, $expected_payment_preimage: expr) => {
1863                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1864         };
1865         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1866                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1867         }
1868 }
1869
1870 #[macro_export]
1871 macro_rules! expect_payment_sent {
1872         ($node: expr, $expected_payment_preimage: expr) => {
1873                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1874         };
1875         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1876                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1877         };
1878         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1879                 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1880                         $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1881         }
1882 }
1883
1884 #[cfg(test)]
1885 #[macro_export]
1886 macro_rules! expect_payment_path_successful {
1887         ($node: expr) => {
1888                 let events = $node.node.get_and_clear_pending_events();
1889                 assert_eq!(events.len(), 1);
1890                 match events[0] {
1891                         $crate::events::Event::PaymentPathSuccessful { .. } => {},
1892                         _ => panic!("Unexpected event"),
1893                 }
1894         }
1895 }
1896
1897 macro_rules! expect_payment_forwarded {
1898         ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1899                 let events = $node.node.get_and_clear_pending_events();
1900                 assert_eq!(events.len(), 1);
1901                 match events[0] {
1902                         Event::PaymentForwarded {
1903                                 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1904                                 outbound_amount_forwarded_msat: _
1905                         } => {
1906                                 assert_eq!(fee_earned_msat, $expected_fee);
1907                                 if fee_earned_msat.is_some() {
1908                                         // Is the event prev_channel_id in one of the channels between the two nodes?
1909                                         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()));
1910                                 }
1911                                 // We check for force closures since a force closed channel is removed from the
1912                                 // node's channel list
1913                                 if !$downstream_force_closed {
1914                                         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()));
1915                                 }
1916                                 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1917                         },
1918                         _ => panic!("Unexpected event"),
1919                 }
1920         }
1921 }
1922
1923 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1924 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1925         let events = node.node.get_and_clear_pending_events();
1926         assert_eq!(events.len(), 1);
1927         match events[0] {
1928                 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1929                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1930                 },
1931                 _ => panic!("Unexpected event"),
1932         }
1933 }
1934
1935 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1936 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1937         let events = node.node.get_and_clear_pending_events();
1938         assert_eq!(events.len(), 1);
1939         match events[0] {
1940                 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1941                         assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1942                 },
1943                 _ => panic!("Unexpected event"),
1944         }
1945 }
1946
1947 pub struct PaymentFailedConditions<'a> {
1948         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1949         pub(crate) expected_blamed_scid: Option<u64>,
1950         pub(crate) expected_blamed_chan_closed: Option<bool>,
1951         pub(crate) expected_mpp_parts_remain: bool,
1952 }
1953
1954 impl<'a> PaymentFailedConditions<'a> {
1955         pub fn new() -> Self {
1956                 Self {
1957                         expected_htlc_error_data: None,
1958                         expected_blamed_scid: None,
1959                         expected_blamed_chan_closed: None,
1960                         expected_mpp_parts_remain: false,
1961                 }
1962         }
1963         pub fn mpp_parts_remain(mut self) -> Self {
1964                 self.expected_mpp_parts_remain = true;
1965                 self
1966         }
1967         pub fn blamed_scid(mut self, scid: u64) -> Self {
1968                 self.expected_blamed_scid = Some(scid);
1969                 self
1970         }
1971         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1972                 self.expected_blamed_chan_closed = Some(closed);
1973                 self
1974         }
1975         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1976                 self.expected_htlc_error_data = Some((code, data));
1977                 self
1978         }
1979 }
1980
1981 #[cfg(test)]
1982 macro_rules! expect_payment_failed_with_update {
1983         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1984                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1985                         &$node, $expected_payment_hash, $payment_failed_permanently,
1986                         $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1987                                 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1988         }
1989 }
1990
1991 #[cfg(test)]
1992 macro_rules! expect_payment_failed {
1993         ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1994                 #[allow(unused_mut)]
1995                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1996                 $(
1997                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1998                 )*
1999                 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2000         };
2001 }
2002
2003 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2004         payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2005         expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2006 ) {
2007         if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2008         let expected_payment_id = match &payment_failed_events[0] {
2009                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2010                         #[cfg(test)]
2011                         error_code,
2012                         #[cfg(test)]
2013                         error_data, .. } => {
2014                         assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2015                         assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2016                         #[cfg(test)]
2017                         {
2018                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2019                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2020                                 if let Some((code, data)) = conditions.expected_htlc_error_data {
2021                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
2022                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2023                                 }
2024                         }
2025
2026                         if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2027                                 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2028                                         match upd {
2029                                                 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2030                                                         if let Some(scid) = conditions.expected_blamed_scid {
2031                                                                 assert_eq!(msg.contents.short_channel_id, scid);
2032                                                         }
2033                                                         const CHAN_DISABLED_FLAG: u8 = 2;
2034                                                         assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2035                                                 },
2036                                                 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2037                                                         if let Some(scid) = conditions.expected_blamed_scid {
2038                                                                 assert_eq!(*short_channel_id, scid);
2039                                                         }
2040                                                         assert!(is_permanent);
2041                                                 },
2042                                                 _ => panic!("Unexpected update type"),
2043                                         }
2044                                 } else { panic!("Expected network update"); }
2045                         }
2046
2047                         payment_id.unwrap()
2048                 },
2049                 _ => panic!("Unexpected event"),
2050         };
2051         if !conditions.expected_mpp_parts_remain {
2052                 match &payment_failed_events[1] {
2053                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2054                                 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2055                                 assert_eq!(*payment_id, expected_payment_id);
2056                                 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2057                                         PaymentFailureReason::RecipientRejected
2058                                 } else {
2059                                         PaymentFailureReason::RetriesExhausted
2060                                 });
2061                         }
2062                         _ => panic!("Unexpected second event"),
2063                 }
2064         }
2065 }
2066
2067 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2068         node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2069         conditions: PaymentFailedConditions<'e>
2070 ) {
2071         let events = node.node.get_and_clear_pending_events();
2072         expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2073 }
2074
2075 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 {
2076         let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2077         origin_node.node.send_payment_with_route(&route, our_payment_hash,
2078                 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2079         check_added_monitors!(origin_node, expected_paths.len());
2080         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2081         payment_id
2082 }
2083
2084 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> {
2085         let mut payment_event = SendEvent::from_event(ev);
2086         let mut prev_node = origin_node;
2087         let mut event = None;
2088
2089         for (idx, &node) in expected_path.iter().enumerate() {
2090                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2091
2092                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2093                 check_added_monitors!(node, 0);
2094                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2095
2096                 expect_pending_htlcs_forwardable!(node);
2097
2098                 if idx == expected_path.len() - 1 && clear_recipient_events {
2099                         let events_2 = node.node.get_and_clear_pending_events();
2100                         if payment_claimable_expected {
2101                                 assert_eq!(events_2.len(), 1);
2102                                 match &events_2[0] {
2103                                         Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2104                                                 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2105                                                 claim_deadline, onion_fields,
2106                                         } => {
2107                                                 assert_eq!(our_payment_hash, *payment_hash);
2108                                                 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2109                                                 assert!(onion_fields.is_some());
2110                                                 match &purpose {
2111                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2112                                                                 assert_eq!(expected_preimage, *payment_preimage);
2113                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2114                                                                 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2115                                                         },
2116                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2117                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2118                                                                 assert!(our_payment_secret.is_none());
2119                                                         },
2120                                                 }
2121                                                 assert_eq!(*amount_msat, recv_value);
2122                                                 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2123                                                 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2124                                                 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2125                                         },
2126                                         _ => panic!("Unexpected event"),
2127                                 }
2128                                 event = Some(events_2[0].clone());
2129                         } else {
2130                                 assert!(events_2.is_empty());
2131                         }
2132                 } else if idx != expected_path.len() - 1 {
2133                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
2134                         assert_eq!(events_2.len(), 1);
2135                         check_added_monitors!(node, 1);
2136                         payment_event = SendEvent::from_event(events_2.remove(0));
2137                         assert_eq!(payment_event.msgs.len(), 1);
2138                 }
2139
2140                 prev_node = node;
2141         }
2142         event
2143 }
2144
2145 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> {
2146         do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2147 }
2148
2149 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) {
2150         let mut events = origin_node.node.get_and_clear_pending_msg_events();
2151         assert_eq!(events.len(), expected_route.len());
2152         for (path_idx, expected_path) in expected_route.iter().enumerate() {
2153                 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2154                 // Once we've gotten through all the HTLCs, the last one should result in a
2155                 // PaymentClaimable (but each previous one should not!), .
2156                 let expect_payment = path_idx == expected_route.len() - 1;
2157                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2158         }
2159 }
2160
2161 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) {
2162         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2163         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2164         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2165 }
2166
2167 pub fn do_claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) -> u64 {
2168         for path in expected_paths.iter() {
2169                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2170         }
2171         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2172
2173         let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2174         assert_eq!(claim_event.len(), 1);
2175         match claim_event[0] {
2176                 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2177                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2178                         assert_eq!(preimage, our_payment_preimage),
2179                 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2180                         assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2181                 _ => panic!(),
2182         }
2183
2184         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2185
2186         let mut expected_total_fee_msat = 0;
2187
2188         macro_rules! msgs_from_ev {
2189                 ($ev: expr) => {
2190                         match $ev {
2191                                 &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 } } => {
2192                                         assert!(update_add_htlcs.is_empty());
2193                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2194                                         assert!(update_fail_htlcs.is_empty());
2195                                         assert!(update_fail_malformed_htlcs.is_empty());
2196                                         assert!(update_fee.is_none());
2197                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2198                                 },
2199                                 _ => panic!("Unexpected event"),
2200                         }
2201                 }
2202         }
2203         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2204         let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2205         assert_eq!(events.len(), expected_paths.len());
2206
2207         if events.len() == 1 {
2208                 per_path_msgs.push(msgs_from_ev!(&events[0]));
2209         } else {
2210                 for expected_path in expected_paths.iter() {
2211                         // For MPP payments, we always want the message to the first node in the path.
2212                         let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2213                         per_path_msgs.push(msgs_from_ev!(&ev));
2214                 }
2215         }
2216
2217         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2218                 let mut next_msgs = Some(path_msgs);
2219                 let mut expected_next_node = next_hop;
2220
2221                 macro_rules! last_update_fulfill_dance {
2222                         ($node: expr, $prev_node: expr) => {
2223                                 {
2224                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2225                                         check_added_monitors!($node, 0);
2226                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2227                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2228                                 }
2229                         }
2230                 }
2231                 macro_rules! mid_update_fulfill_dance {
2232                         ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2233                                 {
2234                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2235                                         let fee = {
2236                                                 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2237                                                 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2238                                                         .unwrap().lock().unwrap();
2239                                                 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2240                                                 if let Some(prev_config) = channel.prev_config() {
2241                                                         prev_config.forwarding_fee_base_msat
2242                                                 } else {
2243                                                         channel.config().forwarding_fee_base_msat
2244                                                 }
2245                                         };
2246                                         expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2247                                         expected_total_fee_msat += fee as u64;
2248                                         check_added_monitors!($node, 1);
2249                                         let new_next_msgs = if $new_msgs {
2250                                                 let events = $node.node.get_and_clear_pending_msg_events();
2251                                                 assert_eq!(events.len(), 1);
2252                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
2253                                                 expected_next_node = nexthop;
2254                                                 Some(res)
2255                                         } else {
2256                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2257                                                 None
2258                                         };
2259                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2260                                         next_msgs = new_next_msgs;
2261                                 }
2262                         }
2263                 }
2264
2265                 let mut prev_node = expected_route.last().unwrap();
2266                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2267                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2268                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2269                         if next_msgs.is_some() {
2270                                 // Since we are traversing in reverse, next_node is actually the previous node
2271                                 let next_node: &Node;
2272                                 if idx == expected_route.len() - 1 {
2273                                         next_node = origin_node;
2274                                 } else {
2275                                         next_node = expected_route[expected_route.len() - 1 - idx - 1];
2276                                 }
2277                                 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2278                         } else {
2279                                 assert!(!update_next_msgs);
2280                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2281                         }
2282                         if !skip_last && idx == expected_route.len() - 1 {
2283                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2284                         }
2285
2286                         prev_node = node;
2287                 }
2288
2289                 if !skip_last {
2290                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2291                 }
2292         }
2293
2294         // Ensure that claim_funds is idempotent.
2295         expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2296         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2297         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2298
2299         expected_total_fee_msat
2300 }
2301 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) {
2302         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2303         if !skip_last {
2304                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2305         }
2306 }
2307
2308 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2309         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2310 }
2311
2312 pub const TEST_FINAL_CLTV: u32 = 70;
2313
2314 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) {
2315         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2316                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2317         let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2318         assert_eq!(route.paths.len(), 1);
2319         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2320         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2321                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2322         }
2323
2324         let res = send_along_route(origin_node, route, expected_route, recv_value);
2325         (res.0, res.1, res.2)
2326 }
2327
2328 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
2329         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2330                 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2331         let network_graph = origin_node.network_graph.read_only();
2332         let scorer = test_utils::TestScorer::new();
2333         let seed = [0u8; 32];
2334         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2335         let random_seed_bytes = keys_manager.get_secure_random_bytes();
2336         let route = router::get_route(
2337                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2338                 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2339         assert_eq!(route.paths.len(), 1);
2340         assert_eq!(route.paths[0].hops.len(), expected_route.len());
2341         for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2342                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2343         }
2344
2345         let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2346         unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2347                         RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2348                 true, APIError::ChannelUnavailable { ref err },
2349                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2350 }
2351
2352 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2353         let res = route_payment(&origin, expected_route, recv_value);
2354         claim_payment(&origin, expected_route, res.0);
2355         res
2356 }
2357
2358 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) {
2359         for path in expected_paths.iter() {
2360                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2361         }
2362         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2363         let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2364         expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2365
2366         pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2367 }
2368
2369 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) {
2370         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2371         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2372
2373         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2374         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2375         assert_eq!(events.len(), expected_paths.len());
2376         for ev in events.iter() {
2377                 let (update_fail, commitment_signed, node_id) = match ev {
2378                         &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 } } => {
2379                                 assert!(update_add_htlcs.is_empty());
2380                                 assert!(update_fulfill_htlcs.is_empty());
2381                                 assert_eq!(update_fail_htlcs.len(), 1);
2382                                 assert!(update_fail_malformed_htlcs.is_empty());
2383                                 assert!(update_fee.is_none());
2384                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2385                         },
2386                         _ => panic!("Unexpected event"),
2387                 };
2388                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2389         }
2390         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2391         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()));
2392
2393         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2394                 let mut next_msgs = Some(path_msgs);
2395                 let mut expected_next_node = next_hop;
2396                 let mut prev_node = expected_route.last().unwrap();
2397
2398                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2399                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2400                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
2401                         if next_msgs.is_some() {
2402                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2403                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2404                                 if !update_next_node {
2405                                         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 }]);
2406                                 }
2407                         }
2408                         let events = node.node.get_and_clear_pending_msg_events();
2409                         if update_next_node {
2410                                 assert_eq!(events.len(), 1);
2411                                 match events[0] {
2412                                         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 } } => {
2413                                                 assert!(update_add_htlcs.is_empty());
2414                                                 assert!(update_fulfill_htlcs.is_empty());
2415                                                 assert_eq!(update_fail_htlcs.len(), 1);
2416                                                 assert!(update_fail_malformed_htlcs.is_empty());
2417                                                 assert!(update_fee.is_none());
2418                                                 expected_next_node = node_id.clone();
2419                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2420                                         },
2421                                         _ => panic!("Unexpected event"),
2422                                 }
2423                         } else {
2424                                 assert!(events.is_empty());
2425                         }
2426                         if !skip_last && idx == expected_route.len() - 1 {
2427                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2428                         }
2429
2430                         prev_node = node;
2431                 }
2432
2433                 if !skip_last {
2434                         let prev_node = expected_route.first().unwrap();
2435                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2436                         check_added_monitors!(origin_node, 0);
2437                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2438                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2439                         let events = origin_node.node.get_and_clear_pending_events();
2440                         if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2441
2442                         let expected_payment_id = match events[0] {
2443                                 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2444                                         assert_eq!(payment_hash, our_payment_hash);
2445                                         assert!(payment_failed_permanently);
2446                                         for (idx, hop) in expected_route.iter().enumerate() {
2447                                                 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2448                                         }
2449                                         payment_id.unwrap()
2450                                 },
2451                                 _ => panic!("Unexpected event"),
2452                         };
2453                         if i == expected_paths.len() - 1 {
2454                                 match events[1] {
2455                                         Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2456                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2457                                                 assert_eq!(*payment_id, expected_payment_id);
2458                                                 assert_eq!(reason.unwrap(), expected_fail_reason);
2459                                         }
2460                                         _ => panic!("Unexpected second event"),
2461                                 }
2462                         }
2463                 }
2464         }
2465
2466         // Ensure that fail_htlc_backwards is idempotent.
2467         expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2468         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2469         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2470         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2471 }
2472
2473 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
2474         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2475 }
2476
2477 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2478         let mut chan_mon_cfgs = Vec::new();
2479         for i in 0..node_count {
2480                 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2481                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2482                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2483                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2484                 let persister = test_utils::TestPersister::new();
2485                 let seed = [i as u8; 32];
2486                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2487                 let scorer = Mutex::new(test_utils::TestScorer::new());
2488
2489                 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2490         }
2491
2492         chan_mon_cfgs
2493 }
2494
2495 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2496         let mut nodes = Vec::new();
2497
2498         for i in 0..node_count {
2499                 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);
2500                 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2501                 let seed = [i as u8; 32];
2502                 nodes.push(NodeCfg {
2503                         chain_source: &chanmon_cfgs[i].chain_source,
2504                         logger: &chanmon_cfgs[i].logger,
2505                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2506                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
2507                         router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2508                         chain_monitor,
2509                         keys_manager: &chanmon_cfgs[i].keys_manager,
2510                         node_seed: seed,
2511                         network_graph,
2512                         override_init_features: Rc::new(RefCell::new(None)),
2513                 });
2514         }
2515
2516         nodes
2517 }
2518
2519 pub fn test_default_channel_config() -> UserConfig {
2520         let mut default_config = UserConfig::default();
2521         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2522         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2523         default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2524         default_config.channel_handshake_config.announced_channel = true;
2525         default_config.channel_handshake_limits.force_announced_channel_preference = false;
2526         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2527         // It now defaults to 1, so we simply set it to the expected value here.
2528         default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2529         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2530         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2531         default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2532         default_config
2533 }
2534
2535 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>> {
2536         let mut chanmgrs = Vec::new();
2537         for i in 0..node_count {
2538                 let network = Network::Testnet;
2539                 let params = ChainParameters {
2540                         network,
2541                         best_block: BestBlock::from_network(network),
2542                 };
2543                 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,
2544                         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);
2545                 chanmgrs.push(node);
2546         }
2547
2548         chanmgrs
2549 }
2550
2551 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>> {
2552         let mut nodes = Vec::new();
2553         let chan_count = Rc::new(RefCell::new(0));
2554         let payment_count = Rc::new(RefCell::new(0));
2555         let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2556
2557         for i in 0..node_count {
2558                 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2559                 nodes.push(Node{
2560                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2561                         fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2562                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2563                         node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2564                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2565                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2566                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2567                         connect_style: Rc::clone(&connect_style),
2568                         override_init_features: Rc::clone(&cfgs[i].override_init_features),
2569                 })
2570         }
2571
2572         for i in 0..node_count {
2573                 for j in (i+1)..node_count {
2574                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()), remote_network_address: None }, true).unwrap();
2575                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()), remote_network_address: None }, false).unwrap();
2576                 }
2577         }
2578
2579         nodes
2580 }
2581
2582 // Note that the following only works for CLTV values up to 128
2583 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2584
2585 #[derive(PartialEq)]
2586 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2587 /// Tests that the given node has broadcast transactions for the given Channel
2588 ///
2589 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2590 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2591 /// broadcast and the revoked outputs were claimed.
2592 ///
2593 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2594 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2595 ///
2596 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2597 /// also fail.
2598 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>  {
2599         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2600         let mut txn_seen = HashSet::new();
2601         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2602         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2603
2604         let mut res = Vec::with_capacity(2);
2605         node_txn.retain(|tx| {
2606                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2607                         check_spends!(tx, chan.3);
2608                         if commitment_tx.is_none() {
2609                                 res.push(tx.clone());
2610                         }
2611                         false
2612                 } else { true }
2613         });
2614         if let Some(explicit_tx) = commitment_tx {
2615                 res.push(explicit_tx.clone());
2616         }
2617
2618         assert_eq!(res.len(), 1);
2619
2620         if has_htlc_tx != HTLCType::NONE {
2621                 node_txn.retain(|tx| {
2622                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2623                                 check_spends!(tx, res[0]);
2624                                 if has_htlc_tx == HTLCType::TIMEOUT {
2625                                         assert!(tx.lock_time.0 != 0);
2626                                 } else {
2627                                         assert!(tx.lock_time.0 == 0);
2628                                 }
2629                                 res.push(tx.clone());
2630                                 false
2631                         } else { true }
2632                 });
2633                 assert!(res.len() == 2 || res.len() == 3);
2634                 if res.len() == 3 {
2635                         assert_eq!(res[1], res[2]);
2636                 }
2637         }
2638
2639         assert!(node_txn.is_empty());
2640         res
2641 }
2642
2643 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2644 /// HTLC transaction.
2645 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
2646         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2647         // We may issue multiple claiming transaction on revoked outputs due to block rescan
2648         // for revoked htlc outputs
2649         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2650         node_txn.retain(|tx| {
2651                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2652                         check_spends!(tx, revoked_tx);
2653                         false
2654                 } else { true }
2655         });
2656         node_txn.retain(|tx| {
2657                 check_spends!(tx, commitment_revoked_tx);
2658                 false
2659         });
2660         assert!(node_txn.is_empty());
2661 }
2662
2663 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
2664         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2665         let mut txn_seen = HashSet::new();
2666         node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2667
2668         let mut found_prev = false;
2669         for prev_tx in prev_txn {
2670                 for tx in &*node_txn {
2671                         if tx.input[0].previous_output.txid == prev_tx.txid() {
2672                                 check_spends!(tx, prev_tx);
2673                                 let mut iter = tx.input[0].witness.iter();
2674                                 iter.next().expect("expected 3 witness items");
2675                                 iter.next().expect("expected 3 witness items");
2676                                 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2677                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2678
2679                                 found_prev = true;
2680                                 break;
2681                         }
2682                 }
2683         }
2684         assert!(found_prev);
2685
2686         let mut res = Vec::new();
2687         mem::swap(&mut *node_txn, &mut res);
2688         res
2689 }
2690
2691 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)  {
2692         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2693         assert_eq!(events_1.len(), 2);
2694         let as_update = match events_1[0] {
2695                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2696                         msg.clone()
2697                 },
2698                 _ => panic!("Unexpected event"),
2699         };
2700         match events_1[1] {
2701                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2702                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
2703                         assert_eq!(msg.data, expected_error);
2704                         if needs_err_handle {
2705                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2706                         }
2707                 },
2708                 _ => panic!("Unexpected event"),
2709         }
2710
2711         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2712         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2713         let bs_update = match events_2[0] {
2714                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2715                         msg.clone()
2716                 },
2717                 _ => panic!("Unexpected event"),
2718         };
2719         if !needs_err_handle {
2720                 match events_2[1] {
2721                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2722                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2723                                 assert_eq!(msg.data, expected_error);
2724                         },
2725                         _ => panic!("Unexpected event"),
2726                 }
2727         }
2728
2729         for node in nodes {
2730                 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2731                 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2732         }
2733 }
2734
2735 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
2736         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2737 }
2738
2739 #[cfg(test)]
2740 macro_rules! get_channel_value_stat {
2741         ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2742                 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2743                 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2744                 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2745                 chan.get_value_stat()
2746         }}
2747 }
2748
2749 macro_rules! get_chan_reestablish_msgs {
2750         ($src_node: expr, $dst_node: expr) => {
2751                 {
2752                         let mut announcements = $crate::prelude::HashSet::new();
2753                         let mut res = Vec::with_capacity(1);
2754                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
2755                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2756                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2757                                         res.push(msg.clone());
2758                                 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2759                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2760                                         announcements.insert(msg.contents.short_channel_id);
2761                                 } else {
2762                                         panic!("Unexpected event")
2763                                 }
2764                         }
2765                         for chan in $src_node.node.list_channels() {
2766                                 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2767                                         if let Some(scid) = chan.short_channel_id {
2768                                                 assert!(announcements.remove(&scid));
2769                                         }
2770                                 }
2771                         }
2772                         assert!(announcements.is_empty());
2773                         res
2774                 }
2775         }
2776 }
2777
2778 macro_rules! handle_chan_reestablish_msgs {
2779         ($src_node: expr, $dst_node: expr) => {
2780                 {
2781                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2782                         let mut idx = 0;
2783                         let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2784                                 idx += 1;
2785                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2786                                 Some(msg.clone())
2787                         } else {
2788                                 None
2789                         };
2790
2791                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2792                                 idx += 1;
2793                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2794                         }
2795
2796                         let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2797                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2798                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2799                                 idx += 1;
2800                                 had_channel_update = true;
2801                         }
2802
2803                         let mut revoke_and_ack = None;
2804                         let mut commitment_update = None;
2805                         let order = if let Some(ev) = msg_events.get(idx) {
2806                                 match ev {
2807                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2808                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2809                                                 revoke_and_ack = Some(msg.clone());
2810                                                 idx += 1;
2811                                                 RAACommitmentOrder::RevokeAndACKFirst
2812                                         },
2813                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2814                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2815                                                 commitment_update = Some(updates.clone());
2816                                                 idx += 1;
2817                                                 RAACommitmentOrder::CommitmentFirst
2818                                         },
2819                                         _ => RAACommitmentOrder::CommitmentFirst,
2820                                 }
2821                         } else {
2822                                 RAACommitmentOrder::CommitmentFirst
2823                         };
2824
2825                         if let Some(ev) = msg_events.get(idx) {
2826                                 match ev {
2827                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2828                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2829                                                 assert!(revoke_and_ack.is_none());
2830                                                 revoke_and_ack = Some(msg.clone());
2831                                                 idx += 1;
2832                                         },
2833                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2834                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2835                                                 assert!(commitment_update.is_none());
2836                                                 commitment_update = Some(updates.clone());
2837                                                 idx += 1;
2838                                         },
2839                                         _ => {},
2840                                 }
2841                         }
2842
2843                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2844                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2845                                 idx += 1;
2846                                 assert!(!had_channel_update);
2847                         }
2848
2849                         assert_eq!(msg_events.len(), idx);
2850
2851                         (channel_ready, revoke_and_ack, commitment_update, order)
2852                 }
2853         }
2854 }
2855
2856 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2857 /// for claims/fails they are separated out.
2858 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))  {
2859         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: node_b.node.init_features(), remote_network_address: None }, true).unwrap();
2860         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2861         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: node_a.node.init_features(), remote_network_address: None }, false).unwrap();
2862         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2863
2864         if send_channel_ready.0 {
2865                 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2866                 // from b
2867                 for reestablish in reestablish_1.iter() {
2868                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2869                 }
2870         }
2871         if send_channel_ready.1 {
2872                 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2873                 // from a
2874                 for reestablish in reestablish_2.iter() {
2875                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2876                 }
2877         }
2878         if send_channel_ready.0 || send_channel_ready.1 {
2879                 // If we expect any channel_ready's, both sides better have set
2880                 // next_holder_commitment_number to 1
2881                 for reestablish in reestablish_1.iter() {
2882                         assert_eq!(reestablish.next_local_commitment_number, 1);
2883                 }
2884                 for reestablish in reestablish_2.iter() {
2885                         assert_eq!(reestablish.next_local_commitment_number, 1);
2886                 }
2887         }
2888
2889         let mut resp_1 = Vec::new();
2890         for msg in reestablish_1 {
2891                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2892                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2893         }
2894         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2895                 check_added_monitors!(node_b, 1);
2896         } else {
2897                 check_added_monitors!(node_b, 0);
2898         }
2899
2900         let mut resp_2 = Vec::new();
2901         for msg in reestablish_2 {
2902                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2903                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2904         }
2905         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2906                 check_added_monitors!(node_a, 1);
2907         } else {
2908                 check_added_monitors!(node_a, 0);
2909         }
2910
2911         // We don't yet support both needing updates, as that would require a different commitment dance:
2912         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2913                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2914                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2915                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2916
2917         for chan_msgs in resp_1.drain(..) {
2918                 if send_channel_ready.0 {
2919                         node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2920                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2921                         if !announcement_event.is_empty() {
2922                                 assert_eq!(announcement_event.len(), 1);
2923                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2924                                         //TODO: Test announcement_sigs re-sending
2925                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2926                         }
2927                 } else {
2928                         assert!(chan_msgs.0.is_none());
2929                 }
2930                 if pending_raa.0 {
2931                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2932                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2933                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2934                         check_added_monitors!(node_a, 1);
2935                 } else {
2936                         assert!(chan_msgs.1.is_none());
2937                 }
2938                 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 {
2939                         let commitment_update = chan_msgs.2.unwrap();
2940                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2941                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2942                         } else {
2943                                 assert!(commitment_update.update_add_htlcs.is_empty());
2944                         }
2945                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2946                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2947                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2948                         for update_add in commitment_update.update_add_htlcs {
2949                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2950                         }
2951                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2952                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2953                         }
2954                         for update_fail in commitment_update.update_fail_htlcs {
2955                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2956                         }
2957
2958                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2959                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2960                         } else {
2961                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2962                                 check_added_monitors!(node_a, 1);
2963                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2964                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2965                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2966                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2967                                 check_added_monitors!(node_b, 1);
2968                         }
2969                 } else {
2970                         assert!(chan_msgs.2.is_none());
2971                 }
2972         }
2973
2974         for chan_msgs in resp_2.drain(..) {
2975                 if send_channel_ready.1 {
2976                         node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2977                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2978                         if !announcement_event.is_empty() {
2979                                 assert_eq!(announcement_event.len(), 1);
2980                                 match announcement_event[0] {
2981                                         MessageSendEvent::SendChannelUpdate { .. } => {},
2982                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2983                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2984                                 }
2985                         }
2986                 } else {
2987                         assert!(chan_msgs.0.is_none());
2988                 }
2989                 if pending_raa.1 {
2990                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2991                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2992                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2993                         check_added_monitors!(node_b, 1);
2994                 } else {
2995                         assert!(chan_msgs.1.is_none());
2996                 }
2997                 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 {
2998                         let commitment_update = chan_msgs.2.unwrap();
2999                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3000                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3001                         }
3002                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3003                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3004                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3005                         for update_add in commitment_update.update_add_htlcs {
3006                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3007                         }
3008                         for update_fulfill in commitment_update.update_fulfill_htlcs {
3009                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3010                         }
3011                         for update_fail in commitment_update.update_fail_htlcs {
3012                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3013                         }
3014
3015                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3016                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3017                         } else {
3018                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3019                                 check_added_monitors!(node_b, 1);
3020                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3021                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3022                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3023                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3024                                 check_added_monitors!(node_a, 1);
3025                         }
3026                 } else {
3027                         assert!(chan_msgs.2.is_none());
3028                 }
3029         }
3030 }