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