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