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