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