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