git.bitcoin.ninja Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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