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