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