_ 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, keysinterface::KeysInterface};
  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 }
 753
 754 #[macro_export]
 755 macro_rules! check_spends {
 756         ($tx: expr, $($spends_txn: expr),*) => {
 757                 {
 758                         $(
 759                         for outp in $spends_txn.output.iter() {
 760                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Input tx output didn't meet dust limit");
 761                         }
 762                         )*
 763                         for outp in $tx.output.iter() {
 764                                 assert!(outp.value >= outp.script_pubkey.dust_value().as_sat(), "Spending tx output didn't meet dust limit");
 765                         }
 766                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 767                                 $(
 768                                         if out_point.txid == $spends_txn.txid() {
 769                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 770                                         }
 771                                 )*
 772                                 None
 773                         };
 774                         let mut total_value_in = 0;
 775                         for input in $tx.input.iter() {
 776                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 777                         }
 778                         let mut total_value_out = 0;
 779                         for output in $tx.output.iter() {
 780                                 total_value_out += output.value;
 781                         }
 782                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 783                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 784                         assert!(total_value_out + min_fee <= total_value_in);
 785                         $tx.verify(get_output).unwrap();
 786                 }
 787         }
 788 }
 789
 790 macro_rules! get_closing_signed_broadcast {
 791         ($node: expr, $dest_pubkey: expr) => {
 792                 {
 793                         let events = $node.get_and_clear_pending_msg_events();
 794                         assert!(events.len() == 1 || events.len() == 2);
 795                         (match events[events.len() - 1] {
 796                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 797                                         assert_eq!(msg.contents.flags & 2, 2);
 798                                         msg.clone()
 799                                 },
 800                                 _ => panic!("Unexpected event"),
 801                         }, if events.len() == 2 {
 802                                 match events[0] {
 803                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 804                                                 assert_eq!(*node_id, $dest_pubkey);
 805                                                 Some(msg.clone())
 806                                         },
 807                                         _ => panic!("Unexpected event"),
 808                                 }
 809                         } else { None })
 810                 }
 811         }
 812 }
 813
 814 #[cfg(test)]
 815 macro_rules! check_warn_msg {
 816         ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
 817                 let msg_events = $node.node.get_and_clear_pending_msg_events();
 818                 assert_eq!(msg_events.len(), 1);
 819                 match msg_events[0] {
 820                         MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
 821                                 assert_eq!(node_id, $recipient_node_id);
 822                                 assert_eq!(msg.channel_id, $chan_id);
 823                                 msg.data.clone()
 824                         },
 825                         _ => panic!("Unexpected event"),
 826                 }
 827         }}
 828 }
 829
 830 /// Check that a channel's closing channel update has been broadcasted, and optionally
 831 /// check whether an error message event has occurred.
 832 #[macro_export]
 833 macro_rules! check_closed_broadcast {
 834         ($node: expr, $with_error_msg: expr) => {{
 835                 use $crate::util::events::MessageSendEvent;
 836                 use $crate::ln::msgs::ErrorAction;
 837
 838                 let msg_events = $node.node.get_and_clear_pending_msg_events();
 839                 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
 840                 match msg_events[0] {
 841                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 842                                 assert_eq!(msg.contents.flags & 2, 2);
 843                         },
 844                         _ => panic!("Unexpected event"),
 845                 }
 846                 if $with_error_msg {
 847                         match msg_events[1] {
 848                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 849                                         // TODO: Check node_id
 850                                         Some(msg.clone())
 851                                 },
 852                                 _ => panic!("Unexpected event"),
 853                         }
 854                 } else { None }
 855         }}
 856 }
 857
 858 /// Check that a channel's closing channel events has been issued
 859 #[macro_export]
 860 macro_rules! check_closed_event {
 861         ($node: expr, $events: expr, $reason: expr) => {
 862                 check_closed_event!($node, $events, $reason, false);
 863         };
 864         ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
 865                 use $crate::util::events::Event;
 866
 867                 let events = $node.node.get_and_clear_pending_events();
 868                 assert_eq!(events.len(), $events);
 869                 let expected_reason = $reason;
 870                 let mut issues_discard_funding = false;
 871                 for event in events {
 872                         match event {
 873                                 Event::ChannelClosed { ref reason, .. } => {
 874                                         assert_eq!(*reason, expected_reason);
 875                                 },
 876                                 Event::DiscardFunding { .. } => {
 877                                         issues_discard_funding = true;
 878                                 }
 879                                 _ => panic!("Unexpected event"),
 880                         }
 881                 }
 882                 assert_eq!($is_check_discard_funding, issues_discard_funding);
 883         }}
 884 }
 885
 886 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) {
 887         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) };
 888         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) };
 889         let (tx_a, tx_b);
 890
 891         node_a.close_channel(channel_id).unwrap();
 892         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()));
 893
 894         let events_1 = node_b.get_and_clear_pending_msg_events();
 895         assert!(events_1.len() >= 1);
 896         let shutdown_b = match events_1[0] {
 897                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 898                         assert_eq!(node_id, &node_a.get_our_node_id());
 899                         msg.clone()
 900                 },
 901                 _ => panic!("Unexpected event"),
 902         };
 903
 904         let closing_signed_b = if !close_inbound_first {
 905                 assert_eq!(events_1.len(), 1);
 906                 None
 907         } else {
 908                 Some(match events_1[1] {
 909                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 910                                 assert_eq!(node_id, &node_a.get_our_node_id());
 911                                 msg.clone()
 912                         },
 913                         _ => panic!("Unexpected event"),
 914                 })
 915         };
 916
 917         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 918         let (as_update, bs_update) = if close_inbound_first {
 919                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 920                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 921
 922                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
 923                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 924                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 925                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 926
 927                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 928                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 929                 assert!(none_a.is_none());
 930                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 931                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 932                 (as_update, bs_update)
 933         } else {
 934                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 935
 936                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 937                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
 938
 939                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 940                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 941                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 942
 943                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 944                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 945                 assert!(none_b.is_none());
 946                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 947                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 948                 (as_update, bs_update)
 949         };
 950         assert_eq!(tx_a, tx_b);
 951         check_spends!(tx_a, funding_tx);
 952
 953         (as_update, bs_update, tx_a)
 954 }
 955
 956 pub struct SendEvent {
 957         pub node_id: PublicKey,
 958         pub msgs: Vec<msgs::UpdateAddHTLC>,
 959         pub commitment_msg: msgs::CommitmentSigned,
 960 }
 961 impl SendEvent {
 962         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 963                 assert!(updates.update_fulfill_htlcs.is_empty());
 964                 assert!(updates.update_fail_htlcs.is_empty());
 965                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 966                 assert!(updates.update_fee.is_none());
 967                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 968         }
 969
 970         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 971                 match event {
 972                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 973                         _ => panic!("Unexpected event type!"),
 974                 }
 975         }
 976
 977         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 978                 let mut events = node.node.get_and_clear_pending_msg_events();
 979                 assert_eq!(events.len(), 1);
 980                 SendEvent::from_event(events.pop().unwrap())
 981         }
 982 }
 983
 984 #[macro_export]
 985 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
 986 /// commitment update.
 987 macro_rules! commitment_signed_dance {
 988         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 989                 {
 990                         check_added_monitors!($node_a, 0);
 991                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 992                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 993                         check_added_monitors!($node_a, 1);
 994                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 995                 }
 996         };
 997         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 998                 {
 999                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1000                         check_added_monitors!($node_b, 0);
1001                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1002                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1003                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1004                         check_added_monitors!($node_b, 1);
1005                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1006                         let (bs_revoke_and_ack, extra_msg_option) = {
1007                                 let events = $node_b.node.get_and_clear_pending_msg_events();
1008                                 assert!(events.len() <= 2);
1009                                 (match events[0] {
1010                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1011                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1012                                                 (*msg).clone()
1013                                         },
1014                                         _ => panic!("Unexpected event"),
1015                                 }, events.get(1).map(|e| e.clone()))
1016                         };
1017                         check_added_monitors!($node_b, 1);
1018                         if $fail_backwards {
1019                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1020                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1021                         }
1022                         (extra_msg_option, bs_revoke_and_ack)
1023                 }
1024         };
1025         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1026                 {
1027                         check_added_monitors!($node_a, 0);
1028                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1029                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1030                         check_added_monitors!($node_a, 1);
1031                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1032                         assert!(extra_msg_option.is_none());
1033                         bs_revoke_and_ack
1034                 }
1035         };
1036         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1037                 {
1038                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1039                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1040                         check_added_monitors!($node_a, 1);
1041                         extra_msg_option
1042                 }
1043         };
1044         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1045                 {
1046                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1047                 }
1048         };
1049         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1050                 {
1051                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1052                         if $fail_backwards {
1053                                 $crate::expect_pending_htlcs_forwardable!($node_a);
1054                                 check_added_monitors!($node_a, 1);
1055
1056                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
1057                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
1058                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1059                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
1060                                 } else { panic!("Unexpected event"); }
1061                         } else {
1062                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1063                         }
1064                 }
1065         }
1066 }
1067
1068 /// Get a payment preimage and hash.
1069 #[macro_export]
1070 macro_rules! get_payment_preimage_hash {
1071         ($dest_node: expr) => {
1072                 {
1073                         get_payment_preimage_hash!($dest_node, None)
1074                 }
1075         };
1076         ($dest_node: expr, $min_value_msat: expr) => {
1077                 {
1078                         use bitcoin::hashes::Hash as _;
1079                         let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1080                         let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1081                         *payment_count += 1;
1082                         let payment_hash = $crate::ln::PaymentHash(
1083                                 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1084                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1085                         (payment_preimage, payment_hash, payment_secret)
1086                 }
1087         }
1088 }
1089
1090 #[cfg(test)]
1091 #[macro_export]
1092 macro_rules! get_route_and_payment_hash {
1093         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1094                 $crate::get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1095         }};
1096         ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1097                 use $crate::chain::keysinterface::KeysInterface;
1098                 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1099                 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1100                         .with_features($crate::ln::features::InvoiceFeatures::known())
1101                         .with_route_hints($last_hops);
1102                 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1103                 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1104                 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1105                 let route = $crate::routing::router::get_route(
1106                         &$send_node.node.get_our_node_id(), &payment_params, &$send_node.network_graph.read_only(),
1107                         Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1108                         $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1109                 ).unwrap();
1110                 (route, payment_hash, payment_preimage, payment_secret)
1111         }}
1112 }
1113
1114 #[macro_export]
1115 /// Clears (and ignores) a PendingHTLCsForwardable event
1116 macro_rules! expect_pending_htlcs_forwardable_ignore {
1117         ($node: expr) => {{
1118                 let events = $node.node.get_and_clear_pending_events();
1119                 assert_eq!(events.len(), 1);
1120                 match events[0] {
1121                         $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1122                         _ => panic!("Unexpected event"),
1123                 };
1124         }}
1125 }
1126
1127 #[macro_export]
1128 /// Handles a PendingHTLCsForwardable event
1129 macro_rules! expect_pending_htlcs_forwardable {
1130         ($node: expr) => {{
1131                 $crate::expect_pending_htlcs_forwardable_ignore!($node);
1132                 $node.node.process_pending_htlc_forwards();
1133
1134                 // Ensure process_pending_htlc_forwards is idempotent.
1135                 $node.node.process_pending_htlc_forwards();
1136         }}
1137 }
1138
1139 #[cfg(test)]
1140 macro_rules! expect_pending_htlcs_forwardable_from_events {
1141         ($node: expr, $events: expr, $ignore: expr) => {{
1142                 assert_eq!($events.len(), 1);
1143                 match $events[0] {
1144                         Event::PendingHTLCsForwardable { .. } => { },
1145                         _ => panic!("Unexpected event"),
1146                 };
1147                 if $ignore {
1148                         $node.node.process_pending_htlc_forwards();
1149
1150                         // Ensure process_pending_htlc_forwards is idempotent.
1151                         $node.node.process_pending_htlc_forwards();
1152                 }
1153         }}
1154 }
1155
1156 #[macro_export]
1157 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1158 macro_rules! expect_payment_received {
1159         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1160                 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1161         };
1162         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1163                 let events = $node.node.get_and_clear_pending_events();
1164                 assert_eq!(events.len(), 1);
1165                 match events[0] {
1166                         $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1167                                 assert_eq!($expected_payment_hash, *payment_hash);
1168                                 assert_eq!($expected_recv_value, amt);
1169                                 match purpose {
1170                                         $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1171                                                 assert_eq!(&$expected_payment_preimage, payment_preimage);
1172                                                 assert_eq!($expected_payment_secret, *payment_secret);
1173                                         },
1174                                         _ => {},
1175                                 }
1176                         },
1177                         _ => panic!("Unexpected event"),
1178                 }
1179         }
1180 }
1181
1182 #[cfg(test)]
1183 #[macro_export]
1184 macro_rules! expect_payment_sent_without_paths {
1185         ($node: expr, $expected_payment_preimage: expr) => {
1186                 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1187         };
1188         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1189                 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1190         }
1191 }
1192
1193 #[macro_export]
1194 macro_rules! expect_payment_sent {
1195         ($node: expr, $expected_payment_preimage: expr) => {
1196                 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1197         };
1198         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1199                 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1200         };
1201         ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1202                 use bitcoin::hashes::Hash as _;
1203                 let events = $node.node.get_and_clear_pending_events();
1204                 let expected_payment_hash = $crate::ln::PaymentHash(
1205                         bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1206                 if $expect_paths {
1207                         assert!(events.len() > 1);
1208                 } else {
1209                         assert_eq!(events.len(), 1);
1210                 }
1211                 let expected_payment_id = match events[0] {
1212                         $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1213                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1214                                 assert_eq!(expected_payment_hash, *payment_hash);
1215                                 assert!(fee_paid_msat.is_some());
1216                                 if $expected_fee_msat_opt.is_some() {
1217                                         assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1218                                 }
1219                                 payment_id.unwrap()
1220                         },
1221                         _ => panic!("Unexpected event"),
1222                 };
1223                 if $expect_paths {
1224                         for i in 1..events.len() {
1225                                 match events[i] {
1226                                         $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1227                                                 assert_eq!(payment_id, expected_payment_id);
1228                                                 assert_eq!(payment_hash, Some(expected_payment_hash));
1229                                         },
1230                                         _ => panic!("Unexpected event"),
1231                                 }
1232                         }
1233                 }
1234         } }
1235 }
1236
1237 #[cfg(test)]
1238 #[macro_export]
1239 macro_rules! expect_payment_path_successful {
1240         ($node: expr) => {
1241                 let events = $node.node.get_and_clear_pending_events();
1242                 assert_eq!(events.len(), 1);
1243                 match events[0] {
1244                         $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1245                         _ => panic!("Unexpected event"),
1246                 }
1247         }
1248 }
1249
1250 macro_rules! expect_payment_forwarded {
1251         ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1252                 let events = $node.node.get_and_clear_pending_events();
1253                 assert_eq!(events.len(), 1);
1254                 match events[0] {
1255                         Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1256                                 assert_eq!(fee_earned_msat, $expected_fee);
1257                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1258                         },
1259                         _ => panic!("Unexpected event"),
1260                 }
1261         }
1262 }
1263
1264 pub struct PaymentFailedConditions<'a> {
1265         pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1266         pub(crate) expected_blamed_scid: Option<u64>,
1267         pub(crate) expected_blamed_chan_closed: Option<bool>,
1268         pub(crate) expected_mpp_parts_remain: bool,
1269 }
1270
1271 impl<'a> PaymentFailedConditions<'a> {
1272         pub fn new() -> Self {
1273                 Self {
1274                         expected_htlc_error_data: None,
1275                         expected_blamed_scid: None,
1276                         expected_blamed_chan_closed: None,
1277                         expected_mpp_parts_remain: false,
1278                 }
1279         }
1280         pub fn mpp_parts_remain(mut self) -> Self {
1281                 self.expected_mpp_parts_remain = true;
1282                 self
1283         }
1284         pub fn blamed_scid(mut self, scid: u64) -> Self {
1285                 self.expected_blamed_scid = Some(scid);
1286                 self
1287         }
1288         pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1289                 self.expected_blamed_chan_closed = Some(closed);
1290                 self
1291         }
1292         pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1293                 self.expected_htlc_error_data = Some((code, data));
1294                 self
1295         }
1296 }
1297
1298 #[cfg(test)]
1299 macro_rules! expect_payment_failed_with_update {
1300         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1301                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest,
1302                         $crate::ln::functional_test_utils::PaymentFailedConditions::new().blamed_scid($scid).blamed_chan_closed($chan_closed));
1303         }
1304 }
1305
1306 #[cfg(test)]
1307 macro_rules! expect_payment_failed {
1308         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1309                 #[allow(unused_mut)]
1310                 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1311                 $(
1312                         conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1313                 )*
1314                 expect_payment_failed_conditions!($node, $expected_payment_hash, $rejected_by_dest, conditions);
1315         };
1316 }
1317
1318 #[cfg(test)]
1319 macro_rules! expect_payment_failed_conditions {
1320         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $conditions: expr) => {
1321                 let events = $node.node.get_and_clear_pending_events();
1322                 assert_eq!(events.len(), 1);
1323                 let expected_payment_id = match events[0] {
1324                         Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data, ref path, ref retry, ref payment_id, ref network_update, .. } => {
1325                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1326                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1327                                 assert!(retry.is_some(), "expected retry.is_some()");
1328                                 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1329                                 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1330
1331                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1332                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1333                                 if let Some((code, data)) = $conditions.expected_htlc_error_data {
1334                                         assert_eq!(error_code.unwrap(), code, "unexpected error code");
1335                                         assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1336                                 }
1337
1338                                 if let Some(chan_closed) = $conditions.expected_blamed_chan_closed {
1339                                         match network_update {
1340                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1341                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1342                                                                 assert_eq!(msg.contents.short_channel_id, scid);
1343                                                         }
1344                                                         assert_eq!(msg.contents.flags & 2, 0);
1345                                                 },
1346                                                 &Some($crate::routing::network_graph::NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if chan_closed => {
1347                                                         if let Some(scid) = $conditions.expected_blamed_scid {
1348                                                                 assert_eq!(short_channel_id, scid);
1349                                                         }
1350                                                         assert!(is_permanent);
1351                                                 },
1352                                                 Some(_) => panic!("Unexpected update type"),
1353                                                 None => panic!("Expected update"),
1354                                         }
1355                                 }
1356
1357                                 payment_id.unwrap()
1358                         },
1359                         _ => panic!("Unexpected event"),
1360                 };
1361                 if !$conditions.expected_mpp_parts_remain {
1362                         $node.node.abandon_payment(expected_payment_id);
1363                         let events = $node.node.get_and_clear_pending_events();
1364                         assert_eq!(events.len(), 1);
1365                         match events[0] {
1366                                 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1367                                         assert_eq!(*payment_hash, $expected_payment_hash, "unexpected second payment_hash");
1368                                         assert_eq!(*payment_id, expected_payment_id);
1369                                 }
1370                                 _ => panic!("Unexpected second event"),
1371                         }
1372                 }
1373         }
1374 }
1375
1376 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 {
1377         let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1378         check_added_monitors!(origin_node, expected_paths.len());
1379         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1380         payment_id
1381 }
1382
1383 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>) {
1384         let mut payment_event = SendEvent::from_event(ev);
1385         let mut prev_node = origin_node;
1386
1387         for (idx, &node) in expected_path.iter().enumerate() {
1388                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1389
1390                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1391                 check_added_monitors!(node, 0);
1392                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1393
1394                 expect_pending_htlcs_forwardable!(node);
1395
1396                 if idx == expected_path.len() - 1 {
1397                         let events_2 = node.node.get_and_clear_pending_events();
1398                         if payment_received_expected {
1399                                 assert_eq!(events_2.len(), 1);
1400                                 match events_2[0] {
1401                                         Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1402                                                 assert_eq!(our_payment_hash, *payment_hash);
1403                                                 match &purpose {
1404                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1405                                                                 assert_eq!(expected_preimage, *payment_preimage);
1406                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1407                                                         },
1408                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1409                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1410                                                                 assert!(our_payment_secret.is_none());
1411                                                         },
1412                                                 }
1413                                                 assert_eq!(amt, recv_value);
1414                                         },
1415                                         _ => panic!("Unexpected event"),
1416                                 }
1417                         } else {
1418                                 assert!(events_2.is_empty());
1419                         }
1420                 } else {
1421                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1422                         assert_eq!(events_2.len(), 1);
1423                         check_added_monitors!(node, 1);
1424                         payment_event = SendEvent::from_event(events_2.remove(0));
1425                         assert_eq!(payment_event.msgs.len(), 1);
1426                 }
1427
1428                 prev_node = node;
1429         }
1430 }
1431
1432 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) {
1433         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1434         assert_eq!(events.len(), expected_route.len());
1435         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1436                 // Once we've gotten through all the HTLCs, the last one should result in a
1437                 // PaymentReceived (but each previous one should not!), .
1438                 let expect_payment = path_idx == expected_route.len() - 1;
1439                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1440         }
1441 }
1442
1443 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) {
1444         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1445         let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1446         (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1447 }
1448
1449 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 {
1450         for path in expected_paths.iter() {
1451                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1452         }
1453         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1454         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1455
1456         let mut expected_total_fee_msat = 0;
1457
1458         macro_rules! msgs_from_ev {
1459                 ($ev: expr) => {
1460                         match $ev {
1461                                 &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 } } => {
1462                                         assert!(update_add_htlcs.is_empty());
1463                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1464                                         assert!(update_fail_htlcs.is_empty());
1465                                         assert!(update_fail_malformed_htlcs.is_empty());
1466                                         assert!(update_fee.is_none());
1467                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1468                                 },
1469                                 _ => panic!("Unexpected event"),
1470                         }
1471                 }
1472         }
1473         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1474         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1475         assert_eq!(events.len(), expected_paths.len());
1476         for ev in events.iter() {
1477                 per_path_msgs.push(msgs_from_ev!(ev));
1478         }
1479
1480         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1481                 let mut next_msgs = Some(path_msgs);
1482                 let mut expected_next_node = next_hop;
1483
1484                 macro_rules! last_update_fulfill_dance {
1485                         ($node: expr, $prev_node: expr) => {
1486                                 {
1487                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1488                                         check_added_monitors!($node, 0);
1489                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1490                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1491                                 }
1492                         }
1493                 }
1494                 macro_rules! mid_update_fulfill_dance {
1495                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1496                                 {
1497                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1498                                         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;
1499                                         expect_payment_forwarded!($node, Some(fee as u64), false);
1500                                         expected_total_fee_msat += fee as u64;
1501                                         check_added_monitors!($node, 1);
1502                                         let new_next_msgs = if $new_msgs {
1503                                                 let events = $node.node.get_and_clear_pending_msg_events();
1504                                                 assert_eq!(events.len(), 1);
1505                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1506                                                 expected_next_node = nexthop;
1507                                                 Some(res)
1508                                         } else {
1509                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1510                                                 None
1511                                         };
1512                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1513                                         next_msgs = new_next_msgs;
1514                                 }
1515                         }
1516                 }
1517
1518                 let mut prev_node = expected_route.last().unwrap();
1519                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1520                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1521                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1522                         if next_msgs.is_some() {
1523                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1524                         } else {
1525                                 assert!(!update_next_msgs);
1526                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1527                         }
1528                         if !skip_last && idx == expected_route.len() - 1 {
1529                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1530                         }
1531
1532                         prev_node = node;
1533                 }
1534
1535                 if !skip_last {
1536                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1537                 }
1538         }
1539
1540         // Ensure that claim_funds is idempotent.
1541         assert!(!expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1542         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1543         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1544
1545         expected_total_fee_msat
1546 }
1547 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) {
1548         let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1549         if !skip_last {
1550                 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1551         }
1552 }
1553
1554 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1555         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1556 }
1557
1558 pub const TEST_FINAL_CLTV: u32 = 70;
1559
1560 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) {
1561         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1562                 .with_features(InvoiceFeatures::known());
1563         let network_graph = origin_node.network_graph.read_only();
1564         let scorer = test_utils::TestScorer::with_penalty(0);
1565         let seed = [0u8; 32];
1566         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1567         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1568         let route = get_route(
1569                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1570                 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1571                 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1572         assert_eq!(route.paths.len(), 1);
1573         assert_eq!(route.paths[0].len(), expected_route.len());
1574         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1575                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1576         }
1577
1578         let res = send_along_route(origin_node, route, expected_route, recv_value);
1579         (res.0, res.1, res.2)
1580 }
1581
1582 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1583         let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1584                 .with_features(InvoiceFeatures::known());
1585         let network_graph = origin_node.network_graph.read_only();
1586         let scorer = test_utils::TestScorer::with_penalty(0);
1587         let seed = [0u8; 32];
1588         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1589         let random_seed_bytes = keys_manager.get_secure_random_bytes();
1590         let route = get_route(
1591                 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1592                 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1593         assert_eq!(route.paths.len(), 1);
1594         assert_eq!(route.paths[0].len(), expected_route.len());
1595         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1596                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1597         }
1598
1599         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1600         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1601                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1602 }
1603
1604 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1605         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1606         claim_payment(&origin, expected_route, our_payment_preimage);
1607 }
1608
1609 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)  {
1610         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1611         for path in expected_paths.iter() {
1612                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1613         }
1614         assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1615         expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1616         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1617
1618         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1619         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1620         assert_eq!(events.len(), expected_paths.len());
1621         for ev in events.iter() {
1622                 let (update_fail, commitment_signed, node_id) = match ev {
1623                         &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 } } => {
1624                                 assert!(update_add_htlcs.is_empty());
1625                                 assert!(update_fulfill_htlcs.is_empty());
1626                                 assert_eq!(update_fail_htlcs.len(), 1);
1627                                 assert!(update_fail_malformed_htlcs.is_empty());
1628                                 assert!(update_fee.is_none());
1629                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1630                         },
1631                         _ => panic!("Unexpected event"),
1632                 };
1633                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1634         }
1635         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1636         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()));
1637
1638         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1639                 let mut next_msgs = Some(path_msgs);
1640                 let mut expected_next_node = next_hop;
1641                 let mut prev_node = expected_route.last().unwrap();
1642
1643                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1644                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1645                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
1646                         if next_msgs.is_some() {
1647                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1648                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1649                                 if !update_next_node {
1650                                         expect_pending_htlcs_forwardable!(node);
1651                                 }
1652                         }
1653                         let events = node.node.get_and_clear_pending_msg_events();
1654                         if update_next_node {
1655                                 assert_eq!(events.len(), 1);
1656                                 match events[0] {
1657                                         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 } } => {
1658                                                 assert!(update_add_htlcs.is_empty());
1659                                                 assert!(update_fulfill_htlcs.is_empty());
1660                                                 assert_eq!(update_fail_htlcs.len(), 1);
1661                                                 assert!(update_fail_malformed_htlcs.is_empty());
1662                                                 assert!(update_fee.is_none());
1663                                                 expected_next_node = node_id.clone();
1664                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1665                                         },
1666                                         _ => panic!("Unexpected event"),
1667                                 }
1668                         } else {
1669                                 assert!(events.is_empty());
1670                         }
1671                         if !skip_last && idx == expected_route.len() - 1 {
1672                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1673                         }
1674
1675                         prev_node = node;
1676                 }
1677
1678                 if !skip_last {
1679                         let prev_node = expected_route.first().unwrap();
1680                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1681                         check_added_monitors!(origin_node, 0);
1682                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1683                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1684                         let events = origin_node.node.get_and_clear_pending_events();
1685                         assert_eq!(events.len(), 1);
1686                         let expected_payment_id = match events[0] {
1687                                 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1688                                         assert_eq!(payment_hash, our_payment_hash);
1689                                         assert!(rejected_by_dest);
1690                                         assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1691                                         for (idx, hop) in expected_route.iter().enumerate() {
1692                                                 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1693                                         }
1694                                         payment_id.unwrap()
1695                                 },
1696                                 _ => panic!("Unexpected event"),
1697                         };
1698                         if i == expected_paths.len() - 1 {
1699                                 origin_node.node.abandon_payment(expected_payment_id);
1700                                 let events = origin_node.node.get_and_clear_pending_events();
1701                                 assert_eq!(events.len(), 1);
1702                                 match events[0] {
1703                                         Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1704                                                 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1705                                                 assert_eq!(*payment_id, expected_payment_id);
1706                                         }
1707                                         _ => panic!("Unexpected second event"),
1708                                 }
1709                         }
1710                 }
1711         }
1712
1713         // Ensure that fail_htlc_backwards is idempotent.
1714         assert!(!expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1715         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1716         assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1717         check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1718 }
1719
1720 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1721         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1722 }
1723
1724 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1725         let mut chan_mon_cfgs = Vec::new();
1726         for i in 0..node_count {
1727                 let tx_broadcaster = test_utils::TestBroadcaster {
1728                         txn_broadcasted: Mutex::new(Vec::new()),
1729                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1730                 };
1731                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1732                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1733                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1734                 let persister = test_utils::TestPersister::new();
1735                 let seed = [i as u8; 32];
1736                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1737                 let network_graph = NetworkGraph::new(chain_source.genesis_hash);
1738
1739                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, network_graph });
1740         }
1741
1742         chan_mon_cfgs
1743 }
1744
1745 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1746         let mut nodes = Vec::new();
1747
1748         for i in 0..node_count {
1749                 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);
1750                 let seed = [i as u8; 32];
1751                 nodes.push(NodeCfg {
1752                         chain_source: &chanmon_cfgs[i].chain_source,
1753                         logger: &chanmon_cfgs[i].logger,
1754                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1755                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
1756                         chain_monitor,
1757                         keys_manager: &chanmon_cfgs[i].keys_manager,
1758                         node_seed: seed,
1759                         features: InitFeatures::known(),
1760                         network_graph: &chanmon_cfgs[i].network_graph,
1761                 });
1762         }
1763
1764         nodes
1765 }
1766
1767 pub fn test_default_channel_config() -> UserConfig {
1768         let mut default_config = UserConfig::default();
1769         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1770         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1771         default_config.channel_options.cltv_expiry_delta = 6*6;
1772         default_config.channel_options.announced_channel = true;
1773         default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1774         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1775         // It now defaults to 1, so we simply set it to the expected value here.
1776         default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1777         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1778         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1779         default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1780         default_config
1781 }
1782
1783 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>> {
1784         let mut chanmgrs = Vec::new();
1785         for i in 0..node_count {
1786                 let network = Network::Testnet;
1787                 let params = ChainParameters {
1788                         network,
1789                         best_block: BestBlock::from_genesis(network),
1790                 };
1791                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1792                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1793                 chanmgrs.push(node);
1794         }
1795
1796         chanmgrs
1797 }
1798
1799 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>> {
1800         let mut nodes = Vec::new();
1801         let chan_count = Rc::new(RefCell::new(0));
1802         let payment_count = Rc::new(RefCell::new(0));
1803         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1804
1805         for i in 0..node_count {
1806                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].network_graph, None, cfgs[i].logger);
1807                 nodes.push(Node{
1808                         chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
1809                         chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
1810                         node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, net_graph_msg_handler,
1811                         node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1812                         network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1813                         blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1814                         connect_style: Rc::clone(&connect_style),
1815                 })
1816         }
1817
1818         for i in 0..node_count {
1819                 for j in (i+1)..node_count {
1820                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1821                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1822                 }
1823         }
1824
1825         nodes
1826 }
1827
1828 // Note that the following only works for CLTV values up to 128
1829 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1830 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1831
1832 #[derive(PartialEq)]
1833 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1834 /// Tests that the given node has broadcast transactions for the given Channel
1835 ///
1836 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1837 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1838 /// broadcast and the revoked outputs were claimed.
1839 ///
1840 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1841 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1842 ///
1843 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1844 /// also fail.
1845 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>  {
1846         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1847         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1848
1849         let mut res = Vec::with_capacity(2);
1850         node_txn.retain(|tx| {
1851                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1852                         check_spends!(tx, chan.3);
1853                         if commitment_tx.is_none() {
1854                                 res.push(tx.clone());
1855                         }
1856                         false
1857                 } else { true }
1858         });
1859         if let Some(explicit_tx) = commitment_tx {
1860                 res.push(explicit_tx.clone());
1861         }
1862
1863         assert_eq!(res.len(), 1);
1864
1865         if has_htlc_tx != HTLCType::NONE {
1866                 node_txn.retain(|tx| {
1867                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1868                                 check_spends!(tx, res[0]);
1869                                 if has_htlc_tx == HTLCType::TIMEOUT {
1870                                         assert!(tx.lock_time != 0);
1871                                 } else {
1872                                         assert!(tx.lock_time == 0);
1873                                 }
1874                                 res.push(tx.clone());
1875                                 false
1876                         } else { true }
1877                 });
1878                 assert!(res.len() == 2 || res.len() == 3);
1879                 if res.len() == 3 {
1880                         assert_eq!(res[1], res[2]);
1881                 }
1882         }
1883
1884         assert!(node_txn.is_empty());
1885         res
1886 }
1887
1888 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1889 /// HTLC transaction.
1890 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1891         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1892         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1893         // for revoked htlc outputs
1894         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1895         node_txn.retain(|tx| {
1896                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1897                         check_spends!(tx, revoked_tx);
1898                         false
1899                 } else { true }
1900         });
1901         node_txn.retain(|tx| {
1902                 check_spends!(tx, commitment_revoked_tx);
1903                 false
1904         });
1905         assert!(node_txn.is_empty());
1906 }
1907
1908 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1909         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1910
1911         assert!(node_txn.len() >= 1);
1912         assert_eq!(node_txn[0].input.len(), 1);
1913         let mut found_prev = false;
1914
1915         for tx in prev_txn {
1916                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1917                         check_spends!(node_txn[0], tx);
1918                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1919                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1920
1921                         found_prev = true;
1922                         break;
1923                 }
1924         }
1925         assert!(found_prev);
1926
1927         let mut res = Vec::new();
1928         mem::swap(&mut *node_txn, &mut res);
1929         res
1930 }
1931
1932 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)  {
1933         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1934         assert_eq!(events_1.len(), 2);
1935         let as_update = match events_1[0] {
1936                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1937                         msg.clone()
1938                 },
1939                 _ => panic!("Unexpected event"),
1940         };
1941         match events_1[1] {
1942                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1943                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
1944                         assert_eq!(msg.data, expected_error);
1945                         if needs_err_handle {
1946                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1947                         }
1948                 },
1949                 _ => panic!("Unexpected event"),
1950         }
1951
1952         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1953         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1954         let bs_update = match events_2[0] {
1955                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1956                         msg.clone()
1957                 },
1958                 _ => panic!("Unexpected event"),
1959         };
1960         if !needs_err_handle {
1961                 match events_2[1] {
1962                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1963                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1964                                 assert_eq!(msg.data, expected_error);
1965                         },
1966                         _ => panic!("Unexpected event"),
1967                 }
1968         }
1969
1970         for node in nodes {
1971                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1972                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1973         }
1974 }
1975
1976 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1977         handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
1978 }
1979
1980 #[cfg(test)]
1981 macro_rules! get_channel_value_stat {
1982         ($node: expr, $channel_id: expr) => {{
1983                 let chan_lock = $node.node.channel_state.lock().unwrap();
1984                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1985                 chan.get_value_stat()
1986         }}
1987 }
1988
1989 macro_rules! get_chan_reestablish_msgs {
1990         ($src_node: expr, $dst_node: expr) => {
1991                 {
1992                         let mut res = Vec::with_capacity(1);
1993                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1994                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1995                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1996                                         res.push(msg.clone());
1997                                 } else {
1998                                         panic!("Unexpected event")
1999                                 }
2000                         }
2001                         res
2002                 }
2003         }
2004 }
2005
2006 macro_rules! handle_chan_reestablish_msgs {
2007         ($src_node: expr, $dst_node: expr) => {
2008                 {
2009                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2010                         let mut idx = 0;
2011                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
2012                                 idx += 1;
2013                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2014                                 Some(msg.clone())
2015                         } else {
2016                                 None
2017                         };
2018
2019                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2020                                 idx += 1;
2021                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2022                         }
2023
2024                         let mut revoke_and_ack = None;
2025                         let mut commitment_update = None;
2026                         let order = if let Some(ev) = msg_events.get(idx) {
2027                                 match ev {
2028                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2029                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2030                                                 revoke_and_ack = Some(msg.clone());
2031                                                 idx += 1;
2032                                                 RAACommitmentOrder::RevokeAndACKFirst
2033                                         },
2034                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2035                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2036                                                 commitment_update = Some(updates.clone());
2037                                                 idx += 1;
2038                                                 RAACommitmentOrder::CommitmentFirst
2039                                         },
2040                                         _ => RAACommitmentOrder::CommitmentFirst,
2041                                 }
2042                         } else {
2043                                 RAACommitmentOrder::CommitmentFirst
2044                         };
2045
2046                         if let Some(ev) = msg_events.get(idx) {
2047                                 match ev {
2048                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2049                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2050                                                 assert!(revoke_and_ack.is_none());
2051                                                 revoke_and_ack = Some(msg.clone());
2052                                                 idx += 1;
2053                                         },
2054                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2055                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2056                                                 assert!(commitment_update.is_none());
2057                                                 commitment_update = Some(updates.clone());
2058                                                 idx += 1;
2059                                         },
2060                                         _ => {},
2061                                 }
2062                         }
2063
2064                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2065                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2066                                 idx += 1;
2067                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2068                         }
2069
2070                         assert_eq!(msg_events.len(), idx);
2071
2072                         (funding_locked, revoke_and_ack, commitment_update, order)
2073                 }
2074         }
2075 }
2076
2077 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2078 /// for claims/fails they are separated out.
2079 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))  {
2080         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2081         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2082         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
2083         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2084
2085         if send_funding_locked.0 {
2086                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
2087                 // from b
2088                 for reestablish in reestablish_1.iter() {
2089                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2090                 }
2091         }
2092         if send_funding_locked.1 {
2093                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
2094                 // from a
2095                 for reestablish in reestablish_2.iter() {
2096                         assert_eq!(reestablish.next_remote_commitment_number, 0);
2097                 }
2098         }
2099         if send_funding_locked.0 || send_funding_locked.1 {
2100                 // If we expect any funding_locked's, both sides better have set
2101                 // next_holder_commitment_number to 1
2102                 for reestablish in reestablish_1.iter() {
2103                         assert_eq!(reestablish.next_local_commitment_number, 1);
2104                 }
2105                 for reestablish in reestablish_2.iter() {
2106                         assert_eq!(reestablish.next_local_commitment_number, 1);
2107                 }
2108         }
2109
2110         let mut resp_1 = Vec::new();
2111         for msg in reestablish_1 {
2112                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2113                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2114         }
2115         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2116                 check_added_monitors!(node_b, 1);
2117         } else {
2118                 check_added_monitors!(node_b, 0);
2119         }
2120
2121         let mut resp_2 = Vec::new();
2122         for msg in reestablish_2 {
2123                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2124                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2125         }
2126         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2127                 check_added_monitors!(node_a, 1);
2128         } else {
2129                 check_added_monitors!(node_a, 0);
2130         }
2131
2132         // We don't yet support both needing updates, as that would require a different commitment dance:
2133         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2134                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2135                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2136                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2137
2138         for chan_msgs in resp_1.drain(..) {
2139                 if send_funding_locked.0 {
2140                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2141                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2142                         if !announcement_event.is_empty() {
2143                                 assert_eq!(announcement_event.len(), 1);
2144                                 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2145                                         //TODO: Test announcement_sigs re-sending
2146                                 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2147                         }
2148                 } else {
2149                         assert!(chan_msgs.0.is_none());
2150                 }
2151                 if pending_raa.0 {
2152                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2153                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2154                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2155                         check_added_monitors!(node_a, 1);
2156                 } else {
2157                         assert!(chan_msgs.1.is_none());
2158                 }
2159                 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 {
2160                         let commitment_update = chan_msgs.2.unwrap();
2161                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2162                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2163                         } else {
2164                                 assert!(commitment_update.update_add_htlcs.is_empty());
2165                         }
2166                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2167                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2168                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2169                         for update_add in commitment_update.update_add_htlcs {
2170                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2171                         }
2172                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2173                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2174                         }
2175                         for update_fail in commitment_update.update_fail_htlcs {
2176                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2177                         }
2178
2179                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2180                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2181                         } else {
2182                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2183                                 check_added_monitors!(node_a, 1);
2184                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2185                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2186                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2187                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2188                                 check_added_monitors!(node_b, 1);
2189                         }
2190                 } else {
2191                         assert!(chan_msgs.2.is_none());
2192                 }
2193         }
2194
2195         for chan_msgs in resp_2.drain(..) {
2196                 if send_funding_locked.1 {
2197                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2198                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2199                         if !announcement_event.is_empty() {
2200                                 assert_eq!(announcement_event.len(), 1);
2201                                 match announcement_event[0] {
2202                                         MessageSendEvent::SendChannelUpdate { .. } => {},
2203                                         MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2204                                         _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2205                                 }
2206                         }
2207                 } else {
2208                         assert!(chan_msgs.0.is_none());
2209                 }
2210                 if pending_raa.1 {
2211                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2212                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2213                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2214                         check_added_monitors!(node_b, 1);
2215                 } else {
2216                         assert!(chan_msgs.1.is_none());
2217                 }
2218                 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 {
2219                         let commitment_update = chan_msgs.2.unwrap();
2220                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2221                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2222                         }
2223                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2224                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2225                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2226                         for update_add in commitment_update.update_add_htlcs {
2227                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2228                         }
2229                         for update_fulfill in commitment_update.update_fulfill_htlcs {
2230                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2231                         }
2232                         for update_fail in commitment_update.update_fail_htlcs {
2233                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2234                         }
2235
2236                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2237                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2238                         } else {
2239                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2240                                 check_added_monitors!(node_b, 1);
2241                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2242                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
2243                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2244                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2245                                 check_added_monitors!(node_a, 1);
2246                         }
2247                 } else {
2248                         assert!(chan_msgs.2.is_none());
2249                 }
2250         }
2251 }