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

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