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