_ 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 event has been issued
 767 #[macro_export]
 768 macro_rules! check_closed_event {
 769         ($node: expr, $events: expr, $reason: expr) => {{
 770                 let events = $node.node.get_and_clear_pending_events();
 771                 assert_eq!(events.len(), $events);
 772                 match events[0] {
 773                         Event::ChannelClosed { ref reason, .. } => {
 774                                 assert_eq!(*reason, $reason);
 775                         },
 776                         _ => panic!("Unexpected event"),
 777                 }
 778         }}
 779 }
 780
 781 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) {
 782         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) };
 783         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) };
 784         let (tx_a, tx_b);
 785
 786         node_a.close_channel(channel_id).unwrap();
 787         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()));
 788
 789         let events_1 = node_b.get_and_clear_pending_msg_events();
 790         assert!(events_1.len() >= 1);
 791         let shutdown_b = match events_1[0] {
 792                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 793                         assert_eq!(node_id, &node_a.get_our_node_id());
 794                         msg.clone()
 795                 },
 796                 _ => panic!("Unexpected event"),
 797         };
 798
 799         let closing_signed_b = if !close_inbound_first {
 800                 assert_eq!(events_1.len(), 1);
 801                 None
 802         } else {
 803                 Some(match events_1[1] {
 804                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 805                                 assert_eq!(node_id, &node_a.get_our_node_id());
 806                                 msg.clone()
 807                         },
 808                         _ => panic!("Unexpected event"),
 809                 })
 810         };
 811
 812         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 813         let (as_update, bs_update) = if close_inbound_first {
 814                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 815                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 816
 817                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
 818                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 819                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 820                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 821
 822                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 823                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 824                 assert!(none_a.is_none());
 825                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 826                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 827                 (as_update, bs_update)
 828         } else {
 829                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 830
 831                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 832                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
 833
 834                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 835                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 836                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 837
 838                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 839                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 840                 assert!(none_b.is_none());
 841                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 842                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 843                 (as_update, bs_update)
 844         };
 845         assert_eq!(tx_a, tx_b);
 846         check_spends!(tx_a, funding_tx);
 847
 848         (as_update, bs_update, tx_a)
 849 }
 850
 851 pub struct SendEvent {
 852         pub node_id: PublicKey,
 853         pub msgs: Vec<msgs::UpdateAddHTLC>,
 854         pub commitment_msg: msgs::CommitmentSigned,
 855 }
 856 impl SendEvent {
 857         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 858                 assert!(updates.update_fulfill_htlcs.is_empty());
 859                 assert!(updates.update_fail_htlcs.is_empty());
 860                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 861                 assert!(updates.update_fee.is_none());
 862                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 863         }
 864
 865         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 866                 match event {
 867                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 868                         _ => panic!("Unexpected event type!"),
 869                 }
 870         }
 871
 872         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 873                 let mut events = node.node.get_and_clear_pending_msg_events();
 874                 assert_eq!(events.len(), 1);
 875                 SendEvent::from_event(events.pop().unwrap())
 876         }
 877 }
 878
 879 macro_rules! commitment_signed_dance {
 880         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 881                 {
 882                         check_added_monitors!($node_a, 0);
 883                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 884                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 885                         check_added_monitors!($node_a, 1);
 886                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 887                 }
 888         };
 889         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 890                 {
 891                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 892                         check_added_monitors!($node_b, 0);
 893                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 894                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 895                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 896                         check_added_monitors!($node_b, 1);
 897                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 898                         let (bs_revoke_and_ack, extra_msg_option) = {
 899                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 900                                 assert!(events.len() <= 2);
 901                                 (match events[0] {
 902                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 903                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 904                                                 (*msg).clone()
 905                                         },
 906                                         _ => panic!("Unexpected event"),
 907                                 }, events.get(1).map(|e| e.clone()))
 908                         };
 909                         check_added_monitors!($node_b, 1);
 910                         if $fail_backwards {
 911                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 912                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 913                         }
 914                         (extra_msg_option, bs_revoke_and_ack)
 915                 }
 916         };
 917         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 918                 {
 919                         check_added_monitors!($node_a, 0);
 920                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 921                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 922                         check_added_monitors!($node_a, 1);
 923                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 924                         assert!(extra_msg_option.is_none());
 925                         bs_revoke_and_ack
 926                 }
 927         };
 928         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 929                 {
 930                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 931                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 932                         check_added_monitors!($node_a, 1);
 933                         extra_msg_option
 934                 }
 935         };
 936         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 937                 {
 938                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 939                 }
 940         };
 941         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 942                 {
 943                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 944                         if $fail_backwards {
 945                                 expect_pending_htlcs_forwardable!($node_a);
 946                                 check_added_monitors!($node_a, 1);
 947
 948                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 949                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 950                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 951                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 952                                 } else { panic!("Unexpected event"); }
 953                         } else {
 954                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 955                         }
 956                 }
 957         }
 958 }
 959
 960 /// Get a payment preimage and hash.
 961 #[macro_export]
 962 macro_rules! get_payment_preimage_hash {
 963         ($dest_node: expr) => {
 964                 {
 965                         let payment_preimage = PaymentPreimage([*$dest_node.network_payment_count.borrow(); 32]);
 966                         *$dest_node.network_payment_count.borrow_mut() += 1;
 967                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 968                         let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
 969                         (payment_preimage, payment_hash, payment_secret)
 970                 }
 971         }
 972 }
 973
 974 #[cfg(test)]
 975 macro_rules! get_route_and_payment_hash {
 976         ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
 977                 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node);
 978                 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
 979                 let route = get_route(&$send_node.node.get_our_node_id(),
 980                         &net_graph_msg_handler.network_graph,
 981                         &$recv_node.node.get_our_node_id(), None, None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, $send_node.logger).unwrap();
 982                 (route, payment_hash, payment_preimage, payment_secret)
 983         }}
 984 }
 985
 986 macro_rules! expect_pending_htlcs_forwardable_ignore {
 987         ($node: expr) => {{
 988                 let events = $node.node.get_and_clear_pending_events();
 989                 assert_eq!(events.len(), 1);
 990                 match events[0] {
 991                         Event::PendingHTLCsForwardable { .. } => { },
 992                         _ => panic!("Unexpected event"),
 993                 };
 994         }}
 995 }
 996
 997 macro_rules! expect_pending_htlcs_forwardable {
 998         ($node: expr) => {{
 999                 expect_pending_htlcs_forwardable_ignore!($node);
1000                 $node.node.process_pending_htlc_forwards();
1001         }}
1002 }
1003
1004 #[cfg(test)]
1005 macro_rules! expect_pending_htlcs_forwardable_from_events {
1006         ($node: expr, $events: expr, $ignore: expr) => {{
1007                 assert_eq!($events.len(), 1);
1008                 match $events[0] {
1009                         Event::PendingHTLCsForwardable { .. } => { },
1010                         _ => panic!("Unexpected event"),
1011                 };
1012                 if $ignore {
1013                         $node.node.process_pending_htlc_forwards();
1014                 }
1015         }}
1016 }
1017
1018 #[cfg(any(test, feature = "unstable"))]
1019 macro_rules! expect_payment_received {
1020         ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1021                 let events = $node.node.get_and_clear_pending_events();
1022                 assert_eq!(events.len(), 1);
1023                 match events[0] {
1024                         Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1025                                 assert_eq!($expected_payment_hash, *payment_hash);
1026                                 assert_eq!($expected_recv_value, amt);
1027                                 match purpose {
1028                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1029                                                 assert!(payment_preimage.is_none());
1030                                                 assert_eq!($expected_payment_secret, *payment_secret);
1031                                         },
1032                                         _ => {},
1033                                 }
1034                         },
1035                         _ => panic!("Unexpected event"),
1036                 }
1037         }
1038 }
1039
1040 macro_rules! expect_payment_sent {
1041         ($node: expr, $expected_payment_preimage: expr) => {
1042                 let events = $node.node.get_and_clear_pending_events();
1043                 assert_eq!(events.len(), 1);
1044                 match events[0] {
1045                         Event::PaymentSent { ref payment_preimage } => {
1046                                 assert_eq!($expected_payment_preimage, *payment_preimage);
1047                         },
1048                         _ => panic!("Unexpected event"),
1049                 }
1050         }
1051 }
1052
1053 macro_rules! expect_payment_forwarded {
1054         ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1055                 let events = $node.node.get_and_clear_pending_events();
1056                 assert_eq!(events.len(), 1);
1057                 match events[0] {
1058                         Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1059                                 assert_eq!(fee_earned_msat, $expected_fee);
1060                                 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1061                         },
1062                         _ => panic!("Unexpected event"),
1063                 }
1064         }
1065 }
1066
1067 #[cfg(test)]
1068 macro_rules! expect_payment_failed_with_update {
1069         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1070                 let events = $node.node.get_and_clear_pending_events();
1071                 assert_eq!(events.len(), 1);
1072                 match events[0] {
1073                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, .. } => {
1074                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1075                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1076                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1077                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1078                                 match network_update {
1079                                         &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1080                                                 assert_eq!(msg.contents.short_channel_id, $scid);
1081                                                 assert_eq!(msg.contents.flags & 2, 0);
1082                                         },
1083                                         &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1084                                                 assert_eq!(short_channel_id, $scid);
1085                                                 assert!(is_permanent);
1086                                         },
1087                                         Some(_) => panic!("Unexpected update type"),
1088                                         None => panic!("Expected update"),
1089                                 }
1090                         },
1091                         _ => panic!("Unexpected event"),
1092                 }
1093         }
1094 }
1095
1096 #[cfg(test)]
1097 macro_rules! expect_payment_failed {
1098         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1099                 let events = $node.node.get_and_clear_pending_events();
1100                 assert_eq!(events.len(), 1);
1101                 match events[0] {
1102                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, .. } => {
1103                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1104                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1105                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1106                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1107                                 $(
1108                                         assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1109                                         assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1110                                 )*
1111                         },
1112                         _ => panic!("Unexpected event"),
1113                 }
1114         }
1115 }
1116
1117 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) {
1118         origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1119         check_added_monitors!(origin_node, expected_paths.len());
1120         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1121 }
1122
1123 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>) {
1124         let mut payment_event = SendEvent::from_event(ev);
1125         let mut prev_node = origin_node;
1126
1127         for (idx, &node) in expected_path.iter().enumerate() {
1128                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1129
1130                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1131                 check_added_monitors!(node, 0);
1132                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1133
1134                 expect_pending_htlcs_forwardable!(node);
1135
1136                 if idx == expected_path.len() - 1 {
1137                         let events_2 = node.node.get_and_clear_pending_events();
1138                         if payment_received_expected {
1139                                 assert_eq!(events_2.len(), 1);
1140                                 match events_2[0] {
1141                                         Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1142                                                 assert_eq!(our_payment_hash, *payment_hash);
1143                                                 match &purpose {
1144                                                         PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1145                                                                 assert_eq!(expected_preimage, *payment_preimage);
1146                                                                 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1147                                                         },
1148                                                         PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1149                                                                 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1150                                                                 assert!(our_payment_secret.is_none());
1151                                                         },
1152                                                 }
1153                                                 assert_eq!(amt, recv_value);
1154                                         },
1155                                         _ => panic!("Unexpected event"),
1156                                 }
1157                         } else {
1158                                 assert!(events_2.is_empty());
1159                         }
1160                 } else {
1161                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
1162                         assert_eq!(events_2.len(), 1);
1163                         check_added_monitors!(node, 1);
1164                         payment_event = SendEvent::from_event(events_2.remove(0));
1165                         assert_eq!(payment_event.msgs.len(), 1);
1166                 }
1167
1168                 prev_node = node;
1169         }
1170 }
1171
1172 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) {
1173         let mut events = origin_node.node.get_and_clear_pending_msg_events();
1174         assert_eq!(events.len(), expected_route.len());
1175         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1176                 // Once we've gotten through all the HTLCs, the last one should result in a
1177                 // PaymentReceived (but each previous one should not!), .
1178                 let expect_payment = path_idx == expected_route.len() - 1;
1179                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1180         }
1181 }
1182
1183 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) {
1184         let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1185         send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1186         (our_payment_preimage, our_payment_hash, our_payment_secret)
1187 }
1188
1189 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) {
1190         for path in expected_paths.iter() {
1191                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1192         }
1193         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1194         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1195
1196         macro_rules! msgs_from_ev {
1197                 ($ev: expr) => {
1198                         match $ev {
1199                                 &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 } } => {
1200                                         assert!(update_add_htlcs.is_empty());
1201                                         assert_eq!(update_fulfill_htlcs.len(), 1);
1202                                         assert!(update_fail_htlcs.is_empty());
1203                                         assert!(update_fail_malformed_htlcs.is_empty());
1204                                         assert!(update_fee.is_none());
1205                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1206                                 },
1207                                 _ => panic!("Unexpected event"),
1208                         }
1209                 }
1210         }
1211         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1212         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1213         assert_eq!(events.len(), expected_paths.len());
1214         for ev in events.iter() {
1215                 per_path_msgs.push(msgs_from_ev!(ev));
1216         }
1217
1218         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1219                 let mut next_msgs = Some(path_msgs);
1220                 let mut expected_next_node = next_hop;
1221
1222                 macro_rules! last_update_fulfill_dance {
1223                         ($node: expr, $prev_node: expr) => {
1224                                 {
1225                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1226                                         check_added_monitors!($node, 0);
1227                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1228                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1229                                 }
1230                         }
1231                 }
1232                 macro_rules! mid_update_fulfill_dance {
1233                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1234                                 {
1235                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1236                                         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;
1237                                         expect_payment_forwarded!($node, Some(fee as u64), false);
1238                                         check_added_monitors!($node, 1);
1239                                         let new_next_msgs = if $new_msgs {
1240                                                 let events = $node.node.get_and_clear_pending_msg_events();
1241                                                 assert_eq!(events.len(), 1);
1242                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1243                                                 expected_next_node = nexthop;
1244                                                 Some(res)
1245                                         } else {
1246                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1247                                                 None
1248                                         };
1249                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1250                                         next_msgs = new_next_msgs;
1251                                 }
1252                         }
1253                 }
1254
1255                 let mut prev_node = expected_route.last().unwrap();
1256                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1257                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1258                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1259                         if next_msgs.is_some() {
1260                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1261                         } else {
1262                                 assert!(!update_next_msgs);
1263                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1264                         }
1265                         if !skip_last && idx == expected_route.len() - 1 {
1266                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1267                         }
1268
1269                         prev_node = node;
1270                 }
1271
1272                 if !skip_last {
1273                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1274                 }
1275         }
1276         if !skip_last {
1277                 expect_payment_sent!(origin_node, our_payment_preimage);
1278         }
1279 }
1280
1281 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1282         claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1283 }
1284
1285 pub const TEST_FINAL_CLTV: u32 = 70;
1286
1287 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) {
1288         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1289         let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
1290                 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
1291                 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
1292                 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
1293         assert_eq!(route.paths.len(), 1);
1294         assert_eq!(route.paths[0].len(), expected_route.len());
1295         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1296                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1297         }
1298
1299         send_along_route(origin_node, route, expected_route, recv_value)
1300 }
1301
1302 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1303         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1304         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();
1305         assert_eq!(route.paths.len(), 1);
1306         assert_eq!(route.paths[0].len(), expected_route.len());
1307         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1308                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1309         }
1310
1311         let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1312         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1313                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1314 }
1315
1316 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1317         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1318         claim_payment(&origin, expected_route, our_payment_preimage);
1319 }
1320
1321 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)  {
1322         let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1323         for path in expected_paths.iter() {
1324                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1325         }
1326         assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1327         expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1328         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1329
1330         let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1331         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1332         assert_eq!(events.len(), expected_paths.len());
1333         for ev in events.iter() {
1334                 let (update_fail, commitment_signed, node_id) = match ev {
1335                         &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 } } => {
1336                                 assert!(update_add_htlcs.is_empty());
1337                                 assert!(update_fulfill_htlcs.is_empty());
1338                                 assert_eq!(update_fail_htlcs.len(), 1);
1339                                 assert!(update_fail_malformed_htlcs.is_empty());
1340                                 assert!(update_fee.is_none());
1341                                 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1342                         },
1343                         _ => panic!("Unexpected event"),
1344                 };
1345                 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1346         }
1347         per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1348         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()));
1349
1350         for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1351                 let mut next_msgs = Some(path_msgs);
1352                 let mut expected_next_node = next_hop;
1353                 let mut prev_node = expected_route.last().unwrap();
1354
1355                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1356                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1357                         let update_next_node = !skip_last || idx != expected_route.len() - 1;
1358                         if next_msgs.is_some() {
1359                                 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1360                                 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1361                                 if !update_next_node {
1362                                         expect_pending_htlcs_forwardable!(node);
1363                                 }
1364                         }
1365                         let events = node.node.get_and_clear_pending_msg_events();
1366                         if update_next_node {
1367                                 assert_eq!(events.len(), 1);
1368                                 match events[0] {
1369                                         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 } } => {
1370                                                 assert!(update_add_htlcs.is_empty());
1371                                                 assert!(update_fulfill_htlcs.is_empty());
1372                                                 assert_eq!(update_fail_htlcs.len(), 1);
1373                                                 assert!(update_fail_malformed_htlcs.is_empty());
1374                                                 assert!(update_fee.is_none());
1375                                                 expected_next_node = node_id.clone();
1376                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1377                                         },
1378                                         _ => panic!("Unexpected event"),
1379                                 }
1380                         } else {
1381                                 assert!(events.is_empty());
1382                         }
1383                         if !skip_last && idx == expected_route.len() - 1 {
1384                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1385                         }
1386
1387                         prev_node = node;
1388                 }
1389
1390                 if !skip_last {
1391                         let prev_node = expected_route.first().unwrap();
1392                         origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1393                         check_added_monitors!(origin_node, 0);
1394                         assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1395                         commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1396                         let events = origin_node.node.get_and_clear_pending_events();
1397                         assert_eq!(events.len(), 1);
1398                         match events[0] {
1399                                 Event::PaymentFailed { payment_hash, rejected_by_dest, all_paths_failed, .. } => {
1400                                         assert_eq!(payment_hash, our_payment_hash);
1401                                         assert!(rejected_by_dest);
1402                                         assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1403                                 },
1404                                 _ => panic!("Unexpected event"),
1405                         }
1406                 }
1407         }
1408 }
1409
1410 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1411         fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1412 }
1413
1414 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1415         let mut chan_mon_cfgs = Vec::new();
1416         for i in 0..node_count {
1417                 let tx_broadcaster = test_utils::TestBroadcaster {
1418                         txn_broadcasted: Mutex::new(Vec::new()),
1419                         blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1420                 };
1421                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1422                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1423                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1424                 let persister = test_utils::TestPersister::new();
1425                 let seed = [i as u8; 32];
1426                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1427
1428                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1429         }
1430
1431         chan_mon_cfgs
1432 }
1433
1434 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1435         let mut nodes = Vec::new();
1436
1437         for i in 0..node_count {
1438                 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);
1439                 let seed = [i as u8; 32];
1440                 nodes.push(NodeCfg {
1441                         chain_source: &chanmon_cfgs[i].chain_source,
1442                         logger: &chanmon_cfgs[i].logger,
1443                         tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1444                         fee_estimator: &chanmon_cfgs[i].fee_estimator,
1445                         chain_monitor,
1446                         keys_manager: &chanmon_cfgs[i].keys_manager,
1447                         node_seed: seed,
1448                         features: InitFeatures::known(),
1449                 });
1450         }
1451
1452         nodes
1453 }
1454
1455 pub fn test_default_channel_config() -> UserConfig {
1456         let mut default_config = UserConfig::default();
1457         // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1458         // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1459         default_config.channel_options.cltv_expiry_delta = 6*6;
1460         default_config.channel_options.announced_channel = true;
1461         default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1462         // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1463         // It now defaults to 1, so we simply set it to the expected value here.
1464         default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1465         // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1466         // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1467         default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1468         default_config
1469 }
1470
1471 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>> {
1472         let mut chanmgrs = Vec::new();
1473         for i in 0..node_count {
1474                 let network = Network::Testnet;
1475                 let params = ChainParameters {
1476                         network,
1477                         best_block: BestBlock::from_genesis(network),
1478                 };
1479                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1480                         if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1481                 chanmgrs.push(node);
1482         }
1483
1484         chanmgrs
1485 }
1486
1487 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>> {
1488         let mut nodes = Vec::new();
1489         let chan_count = Rc::new(RefCell::new(0));
1490         let payment_count = Rc::new(RefCell::new(0));
1491         let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1492
1493         for i in 0..node_count {
1494                 let network_graph = NetworkGraph::new(cfgs[i].chain_source.genesis_hash);
1495                 let net_graph_msg_handler = NetGraphMsgHandler::new(network_graph, None, cfgs[i].logger);
1496                 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1497                                  tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1498                                  keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1499                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1500                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1501                                  blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1502                                  connect_style: Rc::clone(&connect_style),
1503                 })
1504         }
1505
1506         for i in 0..node_count {
1507                 for j in (i+1)..node_count {
1508                         nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1509                         nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1510                 }
1511         }
1512
1513         nodes
1514 }
1515
1516 // Note that the following only works for CLTV values up to 128
1517 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1518 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1519
1520 #[derive(PartialEq)]
1521 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1522 /// Tests that the given node has broadcast transactions for the given Channel
1523 ///
1524 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1525 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1526 /// broadcast and the revoked outputs were claimed.
1527 ///
1528 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1529 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1530 ///
1531 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1532 /// also fail.
1533 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>  {
1534         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1535         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1536
1537         let mut res = Vec::with_capacity(2);
1538         node_txn.retain(|tx| {
1539                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1540                         check_spends!(tx, chan.3);
1541                         if commitment_tx.is_none() {
1542                                 res.push(tx.clone());
1543                         }
1544                         false
1545                 } else { true }
1546         });
1547         if let Some(explicit_tx) = commitment_tx {
1548                 res.push(explicit_tx.clone());
1549         }
1550
1551         assert_eq!(res.len(), 1);
1552
1553         if has_htlc_tx != HTLCType::NONE {
1554                 node_txn.retain(|tx| {
1555                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1556                                 check_spends!(tx, res[0]);
1557                                 if has_htlc_tx == HTLCType::TIMEOUT {
1558                                         assert!(tx.lock_time != 0);
1559                                 } else {
1560                                         assert!(tx.lock_time == 0);
1561                                 }
1562                                 res.push(tx.clone());
1563                                 false
1564                         } else { true }
1565                 });
1566                 assert!(res.len() == 2 || res.len() == 3);
1567                 if res.len() == 3 {
1568                         assert_eq!(res[1], res[2]);
1569                 }
1570         }
1571
1572         assert!(node_txn.is_empty());
1573         res
1574 }
1575
1576 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1577 /// HTLC transaction.
1578 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1579         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1580         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1581         // for revoked htlc outputs
1582         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1583         node_txn.retain(|tx| {
1584                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1585                         check_spends!(tx, revoked_tx);
1586                         false
1587                 } else { true }
1588         });
1589         node_txn.retain(|tx| {
1590                 check_spends!(tx, commitment_revoked_tx);
1591                 false
1592         });
1593         assert!(node_txn.is_empty());
1594 }
1595
1596 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1597         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1598
1599         assert!(node_txn.len() >= 1);
1600         assert_eq!(node_txn[0].input.len(), 1);
1601         let mut found_prev = false;
1602
1603         for tx in prev_txn {
1604                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1605                         check_spends!(node_txn[0], tx);
1606                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1607                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1608
1609                         found_prev = true;
1610                         break;
1611                 }
1612         }
1613         assert!(found_prev);
1614
1615         let mut res = Vec::new();
1616         mem::swap(&mut *node_txn, &mut res);
1617         res
1618 }
1619
1620 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)  {
1621         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1622         assert_eq!(events_1.len(), 2);
1623         let as_update = match events_1[0] {
1624                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1625                         msg.clone()
1626                 },
1627                 _ => panic!("Unexpected event"),
1628         };
1629         match events_1[1] {
1630                 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1631                         assert_eq!(node_id, nodes[b].node.get_our_node_id());
1632                         assert_eq!(msg.data, expected_error);
1633                         if needs_err_handle {
1634                                 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1635                         }
1636                 },
1637                 _ => panic!("Unexpected event"),
1638         }
1639
1640         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1641         assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1642         let bs_update = match events_2[0] {
1643                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1644                         msg.clone()
1645                 },
1646                 _ => panic!("Unexpected event"),
1647         };
1648         if !needs_err_handle {
1649                 match events_2[1] {
1650                         MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1651                                 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1652                                 assert_eq!(msg.data, expected_error);
1653                         },
1654                         _ => panic!("Unexpected event"),
1655                 }
1656         }
1657
1658         for node in nodes {
1659                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1660                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1661         }
1662 }
1663
1664 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1665         handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1666 }
1667
1668 #[cfg(test)]
1669 macro_rules! get_channel_value_stat {
1670         ($node: expr, $channel_id: expr) => {{
1671                 let chan_lock = $node.node.channel_state.lock().unwrap();
1672                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1673                 chan.get_value_stat()
1674         }}
1675 }
1676
1677 macro_rules! get_chan_reestablish_msgs {
1678         ($src_node: expr, $dst_node: expr) => {
1679                 {
1680                         let mut res = Vec::with_capacity(1);
1681                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1682                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1683                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1684                                         res.push(msg.clone());
1685                                 } else {
1686                                         panic!("Unexpected event")
1687                                 }
1688                         }
1689                         res
1690                 }
1691         }
1692 }
1693
1694 macro_rules! handle_chan_reestablish_msgs {
1695         ($src_node: expr, $dst_node: expr) => {
1696                 {
1697                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1698                         let mut idx = 0;
1699                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1700                                 idx += 1;
1701                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1702                                 Some(msg.clone())
1703                         } else {
1704                                 None
1705                         };
1706
1707                         if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1708                                 idx += 1;
1709                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1710                         }
1711
1712                         let mut revoke_and_ack = None;
1713                         let mut commitment_update = None;
1714                         let order = if let Some(ev) = msg_events.get(idx) {
1715                                 match ev {
1716                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1717                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1718                                                 revoke_and_ack = Some(msg.clone());
1719                                                 idx += 1;
1720                                                 RAACommitmentOrder::RevokeAndACKFirst
1721                                         },
1722                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1723                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1724                                                 commitment_update = Some(updates.clone());
1725                                                 idx += 1;
1726                                                 RAACommitmentOrder::CommitmentFirst
1727                                         },
1728                                         &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1729                                         _ => panic!("Unexpected event"),
1730                                 }
1731                         } else {
1732                                 RAACommitmentOrder::CommitmentFirst
1733                         };
1734
1735                         if let Some(ev) = msg_events.get(idx) {
1736                                 match ev {
1737                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1738                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1739                                                 assert!(revoke_and_ack.is_none());
1740                                                 revoke_and_ack = Some(msg.clone());
1741                                                 idx += 1;
1742                                         },
1743                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1744                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1745                                                 assert!(commitment_update.is_none());
1746                                                 commitment_update = Some(updates.clone());
1747                                                 idx += 1;
1748                                         },
1749                                         &MessageSendEvent::SendChannelUpdate { .. } => {},
1750                                         _ => panic!("Unexpected event"),
1751                                 }
1752                         }
1753
1754                         if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1755                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1756                                 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1757                         }
1758
1759                         (funding_locked, revoke_and_ack, commitment_update, order)
1760                 }
1761         }
1762 }
1763
1764 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1765 /// for claims/fails they are separated out.
1766 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))  {
1767         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1768         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1769         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1770         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1771
1772         if send_funding_locked.0 {
1773                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1774                 // from b
1775                 for reestablish in reestablish_1.iter() {
1776                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1777                 }
1778         }
1779         if send_funding_locked.1 {
1780                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1781                 // from a
1782                 for reestablish in reestablish_2.iter() {
1783                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1784                 }
1785         }
1786         if send_funding_locked.0 || send_funding_locked.1 {
1787                 // If we expect any funding_locked's, both sides better have set
1788                 // next_holder_commitment_number to 1
1789                 for reestablish in reestablish_1.iter() {
1790                         assert_eq!(reestablish.next_local_commitment_number, 1);
1791                 }
1792                 for reestablish in reestablish_2.iter() {
1793                         assert_eq!(reestablish.next_local_commitment_number, 1);
1794                 }
1795         }
1796
1797         let mut resp_1 = Vec::new();
1798         for msg in reestablish_1 {
1799                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1800                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1801         }
1802         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1803                 check_added_monitors!(node_b, 1);
1804         } else {
1805                 check_added_monitors!(node_b, 0);
1806         }
1807
1808         let mut resp_2 = Vec::new();
1809         for msg in reestablish_2 {
1810                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1811                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1812         }
1813         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1814                 check_added_monitors!(node_a, 1);
1815         } else {
1816                 check_added_monitors!(node_a, 0);
1817         }
1818
1819         // We don't yet support both needing updates, as that would require a different commitment dance:
1820         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1821                          pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1822                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1823                          pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1824
1825         for chan_msgs in resp_1.drain(..) {
1826                 if send_funding_locked.0 {
1827                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1828                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1829                         if !announcement_event.is_empty() {
1830                                 assert_eq!(announcement_event.len(), 1);
1831                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1832                                         //TODO: Test announcement_sigs re-sending
1833                                 } else { panic!("Unexpected event!"); }
1834                         }
1835                 } else {
1836                         assert!(chan_msgs.0.is_none());
1837                 }
1838                 if pending_raa.0 {
1839                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1840                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1841                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1842                         check_added_monitors!(node_a, 1);
1843                 } else {
1844                         assert!(chan_msgs.1.is_none());
1845                 }
1846                 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 {
1847                         let commitment_update = chan_msgs.2.unwrap();
1848                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1849                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1850                         } else {
1851                                 assert!(commitment_update.update_add_htlcs.is_empty());
1852                         }
1853                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1854                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1855                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1856                         for update_add in commitment_update.update_add_htlcs {
1857                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1858                         }
1859                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1860                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1861                         }
1862                         for update_fail in commitment_update.update_fail_htlcs {
1863                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1864                         }
1865
1866                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1867                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1868                         } else {
1869                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1870                                 check_added_monitors!(node_a, 1);
1871                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1872                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1873                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1874                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1875                                 check_added_monitors!(node_b, 1);
1876                         }
1877                 } else {
1878                         assert!(chan_msgs.2.is_none());
1879                 }
1880         }
1881
1882         for chan_msgs in resp_2.drain(..) {
1883                 if send_funding_locked.1 {
1884                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1885                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1886                         if !announcement_event.is_empty() {
1887                                 assert_eq!(announcement_event.len(), 1);
1888                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1889                                         //TODO: Test announcement_sigs re-sending
1890                                 } else { panic!("Unexpected event!"); }
1891                         }
1892                 } else {
1893                         assert!(chan_msgs.0.is_none());
1894                 }
1895                 if pending_raa.1 {
1896                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1897                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1898                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1899                         check_added_monitors!(node_b, 1);
1900                 } else {
1901                         assert!(chan_msgs.1.is_none());
1902                 }
1903                 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 {
1904                         let commitment_update = chan_msgs.2.unwrap();
1905                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1906                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1907                         }
1908                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
1909                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
1910                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1911                         for update_add in commitment_update.update_add_htlcs {
1912                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1913                         }
1914                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1915                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1916                         }
1917                         for update_fail in commitment_update.update_fail_htlcs {
1918                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1919                         }
1920
1921                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1922                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1923                         } else {
1924                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1925                                 check_added_monitors!(node_b, 1);
1926                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1927                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1928                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1929                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1930                                 check_added_monitors!(node_a, 1);
1931                         }
1932                 } else {
1933                         assert!(chan_msgs.2.is_none());
1934                 }
1935         }
1936 }