_ 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::Watch;
  14 use chain::channelmonitor::ChannelMonitor;
  15 use chain::transaction::OutPoint;
  16 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
  17 use routing::router::{Route, get_route};
  18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
  19 use ln::features::InitFeatures;
  20 use ln::msgs;
  21 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
  22 use util::enforcing_trait_impls::EnforcingSigner;
  23 use util::test_utils;
  24 use util::test_utils::TestChainMonitor;
  25 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  26 use util::errors::APIError;
  27 use util::config::UserConfig;
  28 use util::ser::{ReadableArgs, Writeable, Readable};
  29
  30 use bitcoin::blockdata::block::{Block, BlockHeader};
  31 use bitcoin::blockdata::constants::genesis_block;
  32 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  33 use bitcoin::network::constants::Network;
  34
  35 use bitcoin::hashes::sha256::Hash as Sha256;
  36 use bitcoin::hashes::Hash;
  37 use bitcoin::hash_types::BlockHash;
  38
  39 use bitcoin::secp256k1::key::PublicKey;
  40
  41 use std::cell::RefCell;
  42 use std::rc::Rc;
  43 use std::sync::Mutex;
  44 use std::mem;
  45 use std::collections::HashMap;
  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 starting_block = node.best_block_info();
  64         let mut block = Block {
  65                 header: BlockHeader { version: 0x20000000, prev_blockhash: starting_block.0, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
  66                 txdata: Vec::new(),
  67         };
  68         let height = starting_block.1 + 1;
  69         assert!(height <= conf_height);
  70         for i in height..conf_height {
  71                 connect_block(node, &block, i);
  72                 block = Block {
  73                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
  74                         txdata: vec![],
  75                 };
  76         }
  77
  78         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
  79                 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
  80         }
  81         block.txdata.push(tx.clone());
  82         connect_block(node, &block, conf_height);
  83 }
  84
  85 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
  86         let mut block = Block {
  87                 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
  88                 txdata: vec![],
  89         };
  90         let height = node.best_block_info().1;
  91         connect_block(node, &block, height + 1);
  92         for i in 2..depth + 1 {
  93                 block = Block {
  94                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
  95                         txdata: vec![],
  96                 };
  97                 connect_block(node, &block, height + i);
  98         }
  99         block.header.block_hash()
 100 }
 101
 102 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, height: u32) {
 103         let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
 104         node.chain_monitor.chain_monitor.block_connected(&block.header, &txdata, height);
 105         node.node.block_connected(&block.header, &txdata, height);
 106         node.node.test_process_background_events();
 107         node.blocks.borrow_mut().push((block.header, height));
 108 }
 109
 110 pub fn disconnect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, header: &BlockHeader, height: u32) {
 111         node.chain_monitor.chain_monitor.block_disconnected(header, height);
 112         node.node.block_disconnected(header);
 113         node.blocks.borrow_mut().pop();
 114 }
 115 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
 116         assert!(node.blocks.borrow_mut().len() as u32 > count); // Cannot disconnect genesis
 117         for _ in 0..count {
 118                 let (block_header, height) = {
 119                         let blocks = node.blocks.borrow_mut();
 120                         (blocks[blocks.len() - 1].0, blocks[blocks.len() - 1].1)
 121                 };
 122                 disconnect_block(&node, &block_header, height);
 123         }
 124 }
 125
 126 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
 127         let count = node.blocks.borrow_mut().len() as u32 - 1;
 128         disconnect_blocks(node, count);
 129 }
 130
 131 pub struct TestChanMonCfg {
 132         pub tx_broadcaster: test_utils::TestBroadcaster,
 133         pub fee_estimator: test_utils::TestFeeEstimator,
 134         pub chain_source: test_utils::TestChainSource,
 135         pub persister: test_utils::TestPersister,
 136         pub logger: test_utils::TestLogger,
 137         pub keys_manager: test_utils::TestKeysInterface,
 138 }
 139
 140 pub struct NodeCfg<'a> {
 141         pub chain_source: &'a test_utils::TestChainSource,
 142         pub tx_broadcaster: &'a test_utils::TestBroadcaster,
 143         pub fee_estimator: &'a test_utils::TestFeeEstimator,
 144         pub chain_monitor: test_utils::TestChainMonitor<'a>,
 145         pub keys_manager: &'a test_utils::TestKeysInterface,
 146         pub logger: &'a test_utils::TestLogger,
 147         pub node_seed: [u8; 32],
 148 }
 149
 150 pub struct Node<'a, 'b: 'a, 'c: 'b> {
 151         pub chain_source: &'c test_utils::TestChainSource,
 152         pub tx_broadcaster: &'c test_utils::TestBroadcaster,
 153         pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
 154         pub keys_manager: &'b test_utils::TestKeysInterface,
 155         pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
 156         pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
 157         pub node_seed: [u8; 32],
 158         pub network_payment_count: Rc<RefCell<u8>>,
 159         pub network_chan_count: Rc<RefCell<u32>>,
 160         pub logger: &'c test_utils::TestLogger,
 161         pub blocks: RefCell<Vec<(BlockHeader, u32)>>,
 162 }
 163 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
 164         pub fn best_block_hash(&self) -> BlockHash {
 165                 self.blocks.borrow_mut().last().unwrap().0.block_hash()
 166         }
 167         pub fn best_block_info(&self) -> (BlockHash, u32) {
 168                 self.blocks.borrow_mut().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
 169         }
 170 }
 171
 172 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
 173         fn drop(&mut self) {
 174                 if !::std::thread::panicking() {
 175                         // Check that we processed all pending events
 176                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
 177                         assert!(self.node.get_and_clear_pending_events().is_empty());
 178                         assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
 179
 180                         // Check that if we serialize the Router, we can deserialize it again.
 181                         {
 182                                 let mut w = test_utils::TestVecWriter(Vec::new());
 183                                 let network_graph_ser = self.net_graph_msg_handler.network_graph.read().unwrap();
 184                                 network_graph_ser.write(&mut w).unwrap();
 185                                 let network_graph_deser = <NetworkGraph>::read(&mut ::std::io::Cursor::new(&w.0)).unwrap();
 186                                 assert!(network_graph_deser == *self.net_graph_msg_handler.network_graph.read().unwrap());
 187                                 let net_graph_msg_handler = NetGraphMsgHandler::from_net_graph(
 188                                         Some(self.chain_source), self.logger, network_graph_deser
 189                                 );
 190                                 let mut chan_progress = 0;
 191                                 loop {
 192                                         let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 193                                         let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
 194                                         assert!(orig_announcements == deserialized_announcements);
 195                                         chan_progress = match orig_announcements.last() {
 196                                                 Some(announcement) => announcement.0.contents.short_channel_id + 1,
 197                                                 None => break,
 198                                         };
 199                                 }
 200                                 let mut node_progress = None;
 201                                 loop {
 202                                         let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 203                                         let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
 204                                         assert!(orig_announcements == deserialized_announcements);
 205                                         node_progress = match orig_announcements.last() {
 206                                                 Some(announcement) => Some(announcement.contents.node_id),
 207                                                 None => break,
 208                                         };
 209                                 }
 210                         }
 211
 212                         // Check that if we serialize and then deserialize all our channel monitors we get the
 213                         // same set of outputs to watch for on chain as we have now. Note that if we write
 214                         // tests that fully close channels and remove the monitors at some point this may break.
 215                         let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
 216                         let mut deserialized_monitors = Vec::new();
 217                         {
 218                                 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
 219                                 for (_, old_monitor) in old_monitors.iter() {
 220                                         let mut w = test_utils::TestVecWriter(Vec::new());
 221                                         old_monitor.write(&mut w).unwrap();
 222                                         let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
 223                                                 &mut ::std::io::Cursor::new(&w.0), self.keys_manager).unwrap();
 224                                         deserialized_monitors.push(deserialized_monitor);
 225                                 }
 226                         }
 227
 228                         // Before using all the new monitors to check the watch outpoints, use the full set of
 229                         // them to ensure we can write and reload our ChannelManager.
 230                         {
 231                                 let mut channel_monitors = HashMap::new();
 232                                 for monitor in deserialized_monitors.iter_mut() {
 233                                         channel_monitors.insert(monitor.get_funding_txo().0, monitor);
 234                                 }
 235
 236                                 let mut w = test_utils::TestVecWriter(Vec::new());
 237                                 self.node.write(&mut w).unwrap();
 238                                 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
 239                                         default_config: UserConfig::default(),
 240                                         keys_manager: self.keys_manager,
 241                                         fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
 242                                         chain_monitor: self.chain_monitor,
 243                                         tx_broadcaster: &test_utils::TestBroadcaster {
 244                                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
 245                                         },
 246                                         logger: &test_utils::TestLogger::new(),
 247                                         channel_monitors,
 248                                 }).unwrap();
 249                         }
 250
 251                         let persister = test_utils::TestPersister::new();
 252                         let broadcaster = test_utils::TestBroadcaster {
 253                                 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone())
 254                         };
 255                         let chain_source = test_utils::TestChainSource::new(Network::Testnet);
 256                         let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
 257                         for deserialized_monitor in deserialized_monitors.drain(..) {
 258                                 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
 259                                         panic!();
 260                                 }
 261                         }
 262                         assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
 263                         assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
 264                 }
 265         }
 266 }
 267
 268 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) {
 269         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
 270 }
 271
 272 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) {
 273         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);
 274         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
 275         (announcement, as_update, bs_update, channel_id, tx)
 276 }
 277
 278 macro_rules! get_revoke_commit_msgs {
 279         ($node: expr, $node_id: expr) => {
 280                 {
 281                         let events = $node.node.get_and_clear_pending_msg_events();
 282                         assert_eq!(events.len(), 2);
 283                         (match events[0] {
 284                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 285                                         assert_eq!(*node_id, $node_id);
 286                                         (*msg).clone()
 287                                 },
 288                                 _ => panic!("Unexpected event"),
 289                         }, match events[1] {
 290                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 291                                         assert_eq!(*node_id, $node_id);
 292                                         assert!(updates.update_add_htlcs.is_empty());
 293                                         assert!(updates.update_fulfill_htlcs.is_empty());
 294                                         assert!(updates.update_fail_htlcs.is_empty());
 295                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 296                                         assert!(updates.update_fee.is_none());
 297                                         updates.commitment_signed.clone()
 298                                 },
 299                                 _ => panic!("Unexpected event"),
 300                         })
 301                 }
 302         }
 303 }
 304
 305 /// Get an specific event message from the pending events queue.
 306 #[macro_export]
 307 macro_rules! get_event_msg {
 308         ($node: expr, $event_type: path, $node_id: expr) => {
 309                 {
 310                         let events = $node.node.get_and_clear_pending_msg_events();
 311                         assert_eq!(events.len(), 1);
 312                         match events[0] {
 313                                 $event_type { ref node_id, ref msg } => {
 314                                         assert_eq!(*node_id, $node_id);
 315                                         (*msg).clone()
 316                                 },
 317                                 _ => panic!("Unexpected event"),
 318                         }
 319                 }
 320         }
 321 }
 322
 323 #[cfg(test)]
 324 macro_rules! get_htlc_update_msgs {
 325         ($node: expr, $node_id: expr) => {
 326                 {
 327                         let events = $node.node.get_and_clear_pending_msg_events();
 328                         assert_eq!(events.len(), 1);
 329                         match events[0] {
 330                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 331                                         assert_eq!(*node_id, $node_id);
 332                                         (*updates).clone()
 333                                 },
 334                                 _ => panic!("Unexpected event"),
 335                         }
 336                 }
 337         }
 338 }
 339
 340 #[cfg(test)]
 341 macro_rules! get_feerate {
 342         ($node: expr, $channel_id: expr) => {
 343                 {
 344                         let chan_lock = $node.node.channel_state.lock().unwrap();
 345                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
 346                         chan.get_feerate()
 347                 }
 348         }
 349 }
 350
 351 #[cfg(test)]
 352 macro_rules! get_local_commitment_txn {
 353         ($node: expr, $channel_id: expr) => {
 354                 {
 355                         let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
 356                         let mut commitment_txn = None;
 357                         for (funding_txo, monitor) in monitors.iter() {
 358                                 if funding_txo.to_channel_id() == $channel_id {
 359                                         commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
 360                                         break;
 361                                 }
 362                         }
 363                         commitment_txn.unwrap()
 364                 }
 365         }
 366 }
 367
 368 /// Check the error from attempting a payment.
 369 #[macro_export]
 370 macro_rules! unwrap_send_err {
 371         ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
 372                 match &$res {
 373                         &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
 374                                 assert_eq!(fails.len(), 1);
 375                                 match fails[0] {
 376                                         $type => { $check },
 377                                         _ => panic!(),
 378                                 }
 379                         },
 380                         &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
 381                                 assert_eq!(fails.len(), 1);
 382                                 match fails[0] {
 383                                         Err($type) => { $check },
 384                                         _ => panic!(),
 385                                 }
 386                         },
 387                         _ => panic!(),
 388                 }
 389         }
 390 }
 391
 392 /// Check whether N channel monitor(s) have been added.
 393 #[macro_export]
 394 macro_rules! check_added_monitors {
 395         ($node: expr, $count: expr) => {
 396                 {
 397                         let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
 398                         assert_eq!(added_monitors.len(), $count);
 399                         added_monitors.clear();
 400                 }
 401         }
 402 }
 403
 404 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) {
 405         let chan_id = *node.network_chan_count.borrow();
 406
 407         let events = node.node.get_and_clear_pending_events();
 408         assert_eq!(events.len(), 1);
 409         match events[0] {
 410                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 411                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 412                         assert_eq!(user_channel_id, expected_user_chan_id);
 413
 414                         let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 415                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 416                         }]};
 417                         let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
 418                         (*temporary_channel_id, tx, funding_outpoint)
 419                 },
 420                 _ => panic!("Unexpected event"),
 421         }
 422 }
 423
 424 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 {
 425         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 426         node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id()));
 427         node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id()));
 428
 429         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
 430
 431         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
 432         check_added_monitors!(node_a, 0);
 433
 434         node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id()));
 435         {
 436                 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
 437                 assert_eq!(added_monitors.len(), 1);
 438                 assert_eq!(added_monitors[0].0, funding_output);
 439                 added_monitors.clear();
 440         }
 441
 442         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()));
 443         {
 444                 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
 445                 assert_eq!(added_monitors.len(), 1);
 446                 assert_eq!(added_monitors[0].0, funding_output);
 447                 added_monitors.clear();
 448         }
 449
 450         let events_4 = node_a.node.get_and_clear_pending_events();
 451         assert_eq!(events_4.len(), 1);
 452         match events_4[0] {
 453                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 454                         assert_eq!(user_channel_id, 42);
 455                         assert_eq!(*funding_txo, funding_output);
 456                 },
 457                 _ => panic!("Unexpected event"),
 458         };
 459
 460         tx
 461 }
 462
 463 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) {
 464         confirm_transaction_at(node_conf, tx, conf_height);
 465         connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
 466         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()));
 467 }
 468
 469 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]) {
 470         let channel_id;
 471         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 472         assert_eq!(events_6.len(), 2);
 473         ((match events_6[0] {
 474                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 475                         channel_id = msg.channel_id.clone();
 476                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 477                         msg.clone()
 478                 },
 479                 _ => panic!("Unexpected event"),
 480         }, match events_6[1] {
 481                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 482                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 483                         msg.clone()
 484                 },
 485                 _ => panic!("Unexpected event"),
 486         }), channel_id)
 487 }
 488
 489 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]) {
 490         let conf_height = std::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
 491         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
 492         confirm_transaction_at(node_a, tx, conf_height);
 493         connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
 494         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 495 }
 496
 497 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) {
 498         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 499         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 500         (msgs, chan_id, tx)
 501 }
 502
 503 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) {
 504         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 505         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 506         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 507
 508         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 509         assert_eq!(events_7.len(), 1);
 510         let (announcement, bs_update) = match events_7[0] {
 511                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 512                         (msg, update_msg)
 513                 },
 514                 _ => panic!("Unexpected event"),
 515         };
 516
 517         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 518         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 519         assert_eq!(events_8.len(), 1);
 520         let as_update = match events_8[0] {
 521                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 522                         assert!(*announcement == *msg);
 523                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 524                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 525                         update_msg
 526                 },
 527                 _ => panic!("Unexpected event"),
 528         };
 529
 530         *node_a.network_chan_count.borrow_mut() += 1;
 531
 532         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 533 }
 534
 535 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) {
 536         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 537 }
 538
 539 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) {
 540         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 541         update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
 542         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 543 }
 544
 545 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) {
 546         nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
 547         let a_events = nodes[a].node.get_and_clear_pending_msg_events();
 548         assert_eq!(a_events.len(), 1);
 549         let a_node_announcement = match a_events[0] {
 550                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 551                         (*msg).clone()
 552                 },
 553                 _ => panic!("Unexpected event"),
 554         };
 555
 556         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
 557         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
 558         assert_eq!(b_events.len(), 1);
 559         let b_node_announcement = match b_events[0] {
 560                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 561                         (*msg).clone()
 562                 },
 563                 _ => panic!("Unexpected event"),
 564         };
 565
 566         for node in nodes {
 567                 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
 568                 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
 569                 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
 570                 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
 571                 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
 572         }
 573 }
 574
 575 macro_rules! check_spends {
 576         ($tx: expr, $($spends_txn: expr),*) => {
 577                 {
 578                         let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
 579                                 $(
 580                                         if out_point.txid == $spends_txn.txid() {
 581                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 582                                         }
 583                                 )*
 584                                 None
 585                         };
 586                         let mut total_value_in = 0;
 587                         for input in $tx.input.iter() {
 588                                 total_value_in += get_output(&input.previous_output).unwrap().value;
 589                         }
 590                         let mut total_value_out = 0;
 591                         for output in $tx.output.iter() {
 592                                 total_value_out += output.value;
 593                         }
 594                         let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
 595                         // Input amount - output amount = fee, so check that out + min_fee is smaller than input
 596                         assert!(total_value_out + min_fee <= total_value_in);
 597                         $tx.verify(get_output).unwrap();
 598                 }
 599         }
 600 }
 601
 602 macro_rules! get_closing_signed_broadcast {
 603         ($node: expr, $dest_pubkey: expr) => {
 604                 {
 605                         let events = $node.get_and_clear_pending_msg_events();
 606                         assert!(events.len() == 1 || events.len() == 2);
 607                         (match events[events.len() - 1] {
 608                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 609                                         assert_eq!(msg.contents.flags & 2, 2);
 610                                         msg.clone()
 611                                 },
 612                                 _ => panic!("Unexpected event"),
 613                         }, if events.len() == 2 {
 614                                 match events[0] {
 615                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 616                                                 assert_eq!(*node_id, $dest_pubkey);
 617                                                 Some(msg.clone())
 618                                         },
 619                                         _ => panic!("Unexpected event"),
 620                                 }
 621                         } else { None })
 622                 }
 623         }
 624 }
 625
 626 /// Check that a channel's closing channel update has been broadcasted, and optionally
 627 /// check whether an error message event has occurred.
 628 #[macro_export]
 629 macro_rules! check_closed_broadcast {
 630         ($node: expr, $with_error_msg: expr) => {{
 631                 let events = $node.node.get_and_clear_pending_msg_events();
 632                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
 633                 match events[0] {
 634                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 635                                 assert_eq!(msg.contents.flags & 2, 2);
 636                         },
 637                         _ => panic!("Unexpected event"),
 638                 }
 639                 if $with_error_msg {
 640                         match events[1] {
 641                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 642                                         // TODO: Check node_id
 643                                         Some(msg.clone())
 644                                 },
 645                                 _ => panic!("Unexpected event"),
 646                         }
 647                 } else { None }
 648         }}
 649 }
 650
 651 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) {
 652         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) };
 653         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 654         let (tx_a, tx_b);
 655
 656         node_a.close_channel(channel_id).unwrap();
 657         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()));
 658
 659         let events_1 = node_b.get_and_clear_pending_msg_events();
 660         assert!(events_1.len() >= 1);
 661         let shutdown_b = match events_1[0] {
 662                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 663                         assert_eq!(node_id, &node_a.get_our_node_id());
 664                         msg.clone()
 665                 },
 666                 _ => panic!("Unexpected event"),
 667         };
 668
 669         let closing_signed_b = if !close_inbound_first {
 670                 assert_eq!(events_1.len(), 1);
 671                 None
 672         } else {
 673                 Some(match events_1[1] {
 674                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 675                                 assert_eq!(node_id, &node_a.get_our_node_id());
 676                                 msg.clone()
 677                         },
 678                         _ => panic!("Unexpected event"),
 679                 })
 680         };
 681
 682         node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
 683         let (as_update, bs_update) = if close_inbound_first {
 684                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 685                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 686                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 687                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 688                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 689
 690                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 691                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 692                 assert!(none_b.is_none());
 693                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 694                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 695                 (as_update, bs_update)
 696         } else {
 697                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 698
 699                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 700                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 701                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 702                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 703
 704                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 705                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 706                 assert!(none_a.is_none());
 707                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 708                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 709                 (as_update, bs_update)
 710         };
 711         assert_eq!(tx_a, tx_b);
 712         check_spends!(tx_a, funding_tx);
 713
 714         (as_update, bs_update, tx_a)
 715 }
 716
 717 pub struct SendEvent {
 718         pub node_id: PublicKey,
 719         pub msgs: Vec<msgs::UpdateAddHTLC>,
 720         pub commitment_msg: msgs::CommitmentSigned,
 721 }
 722 impl SendEvent {
 723         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 724                 assert!(updates.update_fulfill_htlcs.is_empty());
 725                 assert!(updates.update_fail_htlcs.is_empty());
 726                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 727                 assert!(updates.update_fee.is_none());
 728                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 729         }
 730
 731         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 732                 match event {
 733                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 734                         _ => panic!("Unexpected event type!"),
 735                 }
 736         }
 737
 738         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 739                 let mut events = node.node.get_and_clear_pending_msg_events();
 740                 assert_eq!(events.len(), 1);
 741                 SendEvent::from_event(events.pop().unwrap())
 742         }
 743 }
 744
 745 macro_rules! commitment_signed_dance {
 746         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 747                 {
 748                         check_added_monitors!($node_a, 0);
 749                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 750                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 751                         check_added_monitors!($node_a, 1);
 752                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 753                 }
 754         };
 755         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 756                 {
 757                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 758                         check_added_monitors!($node_b, 0);
 759                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 760                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 761                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 762                         check_added_monitors!($node_b, 1);
 763                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 764                         let (bs_revoke_and_ack, extra_msg_option) = {
 765                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 766                                 assert!(events.len() <= 2);
 767                                 (match events[0] {
 768                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 769                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 770                                                 (*msg).clone()
 771                                         },
 772                                         _ => panic!("Unexpected event"),
 773                                 }, events.get(1).map(|e| e.clone()))
 774                         };
 775                         check_added_monitors!($node_b, 1);
 776                         if $fail_backwards {
 777                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 778                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 779                         }
 780                         (extra_msg_option, bs_revoke_and_ack)
 781                 }
 782         };
 783         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 784                 {
 785                         check_added_monitors!($node_a, 0);
 786                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 787                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 788                         check_added_monitors!($node_a, 1);
 789                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 790                         assert!(extra_msg_option.is_none());
 791                         bs_revoke_and_ack
 792                 }
 793         };
 794         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 795                 {
 796                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 797                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 798                         check_added_monitors!($node_a, 1);
 799                         extra_msg_option
 800                 }
 801         };
 802         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 803                 {
 804                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 805                 }
 806         };
 807         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 808                 {
 809                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 810                         if $fail_backwards {
 811                                 expect_pending_htlcs_forwardable!($node_a);
 812                                 check_added_monitors!($node_a, 1);
 813
 814                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 815                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 816                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 817                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 818                                 } else { panic!("Unexpected event"); }
 819                         } else {
 820                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 821                         }
 822                 }
 823         }
 824 }
 825
 826 /// Get a payment preimage and hash.
 827 #[macro_export]
 828 macro_rules! get_payment_preimage_hash {
 829         ($node: expr) => {
 830                 {
 831                         let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
 832                         *$node.network_payment_count.borrow_mut() += 1;
 833                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 834                         (payment_preimage, payment_hash)
 835                 }
 836         }
 837 }
 838
 839 macro_rules! expect_pending_htlcs_forwardable_ignore {
 840         ($node: expr) => {{
 841                 let events = $node.node.get_and_clear_pending_events();
 842                 assert_eq!(events.len(), 1);
 843                 match events[0] {
 844                         Event::PendingHTLCsForwardable { .. } => { },
 845                         _ => panic!("Unexpected event"),
 846                 };
 847         }}
 848 }
 849
 850 macro_rules! expect_pending_htlcs_forwardable {
 851         ($node: expr) => {{
 852                 expect_pending_htlcs_forwardable_ignore!($node);
 853                 $node.node.process_pending_htlc_forwards();
 854         }}
 855 }
 856
 857 #[cfg(test)]
 858 macro_rules! expect_payment_received {
 859         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
 860                 let events = $node.node.get_and_clear_pending_events();
 861                 assert_eq!(events.len(), 1);
 862                 match events[0] {
 863                         Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
 864                                 assert_eq!($expected_payment_hash, *payment_hash);
 865                                 assert_eq!(None, *payment_secret);
 866                                 assert_eq!($expected_recv_value, amt);
 867                         },
 868                         _ => panic!("Unexpected event"),
 869                 }
 870         }
 871 }
 872
 873 macro_rules! expect_payment_sent {
 874         ($node: expr, $expected_payment_preimage: expr) => {
 875                 let events = $node.node.get_and_clear_pending_events();
 876                 assert_eq!(events.len(), 1);
 877                 match events[0] {
 878                         Event::PaymentSent { ref payment_preimage } => {
 879                                 assert_eq!($expected_payment_preimage, *payment_preimage);
 880                         },
 881                         _ => panic!("Unexpected event"),
 882                 }
 883         }
 884 }
 885
 886 #[cfg(test)]
 887 macro_rules! expect_payment_failed {
 888         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
 889                 let events = $node.node.get_and_clear_pending_events();
 890                 assert_eq!(events.len(), 1);
 891                 match events[0] {
 892                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
 893                                 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
 894                                 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
 895                                 assert!(error_code.is_some(), "expected error_code.is_some() = true");
 896                                 assert!(error_data.is_some(), "expected error_data.is_some() = true");
 897                                 $(
 898                                         assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
 899                                         assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
 900                                 )*
 901                         },
 902                         _ => panic!("Unexpected event"),
 903                 }
 904         }
 905 }
 906
 907 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: Option<PaymentSecret>) {
 908         origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
 909         check_added_monitors!(origin_node, expected_paths.len());
 910         pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
 911 }
 912
 913 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) {
 914         let mut payment_event = SendEvent::from_event(ev);
 915         let mut prev_node = origin_node;
 916
 917         for (idx, &node) in expected_path.iter().enumerate() {
 918                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
 919
 920                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
 921                 check_added_monitors!(node, 0);
 922                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
 923
 924                 expect_pending_htlcs_forwardable!(node);
 925
 926                 if idx == expected_path.len() - 1 {
 927                         let events_2 = node.node.get_and_clear_pending_events();
 928                         if payment_received_expected {
 929                                 assert_eq!(events_2.len(), 1);
 930                                 match events_2[0] {
 931                                         Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
 932                                                 assert_eq!(our_payment_hash, *payment_hash);
 933                                                 assert_eq!(our_payment_secret, *payment_secret);
 934                                                 assert_eq!(amt, recv_value);
 935                                         },
 936                                         _ => panic!("Unexpected event"),
 937                                 }
 938                         } else {
 939                                 assert!(events_2.is_empty());
 940                         }
 941                 } else {
 942                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
 943                         assert_eq!(events_2.len(), 1);
 944                         check_added_monitors!(node, 1);
 945                         payment_event = SendEvent::from_event(events_2.remove(0));
 946                         assert_eq!(payment_event.msgs.len(), 1);
 947                 }
 948
 949                 prev_node = node;
 950         }
 951 }
 952
 953 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: Option<PaymentSecret>) {
 954         let mut events = origin_node.node.get_and_clear_pending_msg_events();
 955         assert_eq!(events.len(), expected_route.len());
 956         for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
 957                 // Once we've gotten through all the HTLCs, the last one should result in a
 958                 // PaymentReceived (but each previous one should not!), .
 959                 let expect_payment = path_idx == expected_route.len() - 1;
 960                 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
 961         }
 962 }
 963
 964 pub fn send_along_route_with_hash<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash) {
 965         send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
 966 }
 967
 968 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) {
 969         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 970         send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
 971         (our_payment_preimage, our_payment_hash)
 972 }
 973
 974 pub fn claim_payment_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage, our_payment_secret: Option<PaymentSecret>, expected_amount: u64) {
 975         for path in expected_paths.iter() {
 976                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
 977         }
 978         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
 979         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
 980
 981         macro_rules! msgs_from_ev {
 982                 ($ev: expr) => {
 983                         match $ev {
 984                                 &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 } } => {
 985                                         assert!(update_add_htlcs.is_empty());
 986                                         assert_eq!(update_fulfill_htlcs.len(), 1);
 987                                         assert!(update_fail_htlcs.is_empty());
 988                                         assert!(update_fail_malformed_htlcs.is_empty());
 989                                         assert!(update_fee.is_none());
 990                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
 991                                 },
 992                                 _ => panic!("Unexpected event"),
 993                         }
 994                 }
 995         }
 996         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
 997         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
 998         assert_eq!(events.len(), expected_paths.len());
 999         for ev in events.iter() {
1000                 per_path_msgs.push(msgs_from_ev!(ev));
1001         }
1002
1003         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1004                 let mut next_msgs = Some(path_msgs);
1005                 let mut expected_next_node = next_hop;
1006
1007                 macro_rules! last_update_fulfill_dance {
1008                         ($node: expr, $prev_node: expr) => {
1009                                 {
1010                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1011                                         check_added_monitors!($node, 0);
1012                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1013                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1014                                 }
1015                         }
1016                 }
1017                 macro_rules! mid_update_fulfill_dance {
1018                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1019                                 {
1020                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1021                                         check_added_monitors!($node, 1);
1022                                         let new_next_msgs = if $new_msgs {
1023                                                 let events = $node.node.get_and_clear_pending_msg_events();
1024                                                 assert_eq!(events.len(), 1);
1025                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
1026                                                 expected_next_node = nexthop;
1027                                                 Some(res)
1028                                         } else {
1029                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1030                                                 None
1031                                         };
1032                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1033                                         next_msgs = new_next_msgs;
1034                                 }
1035                         }
1036                 }
1037
1038                 let mut prev_node = expected_route.last().unwrap();
1039                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1040                         assert_eq!(expected_next_node, node.node.get_our_node_id());
1041                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1042                         if next_msgs.is_some() {
1043                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1044                         } else {
1045                                 assert!(!update_next_msgs);
1046                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1047                         }
1048                         if !skip_last && idx == expected_route.len() - 1 {
1049                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1050                         }
1051
1052                         prev_node = node;
1053                 }
1054
1055                 if !skip_last {
1056                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1057                         expect_payment_sent!(origin_node, our_payment_preimage);
1058                 }
1059         }
1060 }
1061
1062 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
1063         claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
1064 }
1065
1066 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
1067         claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
1068 }
1069
1070 pub const TEST_FINAL_CLTV: u32 = 50;
1071
1072 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
1073         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1074         let logger = test_utils::TestLogger::new();
1075         let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1076         assert_eq!(route.paths.len(), 1);
1077         assert_eq!(route.paths[0].len(), expected_route.len());
1078         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1079                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1080         }
1081
1082         send_along_route(origin_node, route, expected_route, recv_value)
1083 }
1084
1085 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
1086         let logger = test_utils::TestLogger::new();
1087         let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1088         let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &expected_route.last().unwrap().node.get_our_node_id(), None, None, &Vec::new(), recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1089         assert_eq!(route.paths.len(), 1);
1090         assert_eq!(route.paths[0].len(), expected_route.len());
1091         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1092                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1093         }
1094
1095         let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
1096         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1097                 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1098 }
1099
1100 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64)  {
1101         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1102         claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
1103 }
1104
1105 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], skip_last: bool, our_payment_hash: PaymentHash)  {
1106         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
1107         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
1108         check_added_monitors!(expected_route.last().unwrap(), 1);
1109
1110         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
1111         macro_rules! update_fail_dance {
1112                 ($node: expr, $prev_node: expr, $last_node: expr) => {
1113                         {
1114                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1115                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
1116                                 if skip_last && $last_node {
1117                                         expect_pending_htlcs_forwardable!($node);
1118                                 }
1119                         }
1120                 }
1121         }
1122
1123         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
1124         let mut prev_node = expected_route.last().unwrap();
1125         for (idx, node) in expected_route.iter().rev().enumerate() {
1126                 assert_eq!(expected_next_node, node.node.get_our_node_id());
1127                 if next_msgs.is_some() {
1128                         // We may be the "last node" for the purpose of the commitment dance if we're
1129                         // skipping the last node (implying it is disconnected) and we're the
1130                         // second-to-last node!
1131                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1132                 }
1133
1134                 let events = node.node.get_and_clear_pending_msg_events();
1135                 if !skip_last || idx != expected_route.len() - 1 {
1136                         assert_eq!(events.len(), 1);
1137                         match events[0] {
1138                                 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 } } => {
1139                                         assert!(update_add_htlcs.is_empty());
1140                                         assert!(update_fulfill_htlcs.is_empty());
1141                                         assert_eq!(update_fail_htlcs.len(), 1);
1142                                         assert!(update_fail_malformed_htlcs.is_empty());
1143                                         assert!(update_fee.is_none());
1144                                         expected_next_node = node_id.clone();
1145                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1146                                 },
1147                                 _ => panic!("Unexpected event"),
1148                         }
1149                 } else {
1150                         assert!(events.is_empty());
1151                 }
1152                 if !skip_last && idx == expected_route.len() - 1 {
1153                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1154                 }
1155
1156                 prev_node = node;
1157         }
1158
1159         if !skip_last {
1160                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1161
1162                 let events = origin_node.node.get_and_clear_pending_events();
1163                 assert_eq!(events.len(), 1);
1164                 match events[0] {
1165                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1166                                 assert_eq!(payment_hash, our_payment_hash);
1167                                 assert!(rejected_by_dest);
1168                         },
1169                         _ => panic!("Unexpected event"),
1170                 }
1171         }
1172 }
1173
1174 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1175         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1176 }
1177
1178 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1179         let mut chan_mon_cfgs = Vec::new();
1180         for i in 0..node_count {
1181                 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1182                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1183                 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1184                 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1185                 let persister = test_utils::TestPersister::new();
1186                 let seed = [i as u8; 32];
1187                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1188
1189                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1190         }
1191
1192         chan_mon_cfgs
1193 }
1194
1195 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1196         let mut nodes = Vec::new();
1197
1198         for i in 0..node_count {
1199                 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);
1200                 let seed = [i as u8; 32];
1201                 nodes.push(NodeCfg { chain_source: &chanmon_cfgs[i].chain_source, logger: &chanmon_cfgs[i].logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chain_monitor, keys_manager: &chanmon_cfgs[i].keys_manager, node_seed: seed });
1202         }
1203
1204         nodes
1205 }
1206
1207 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>> {
1208         let mut chanmgrs = Vec::new();
1209         for i in 0..node_count {
1210                 let mut default_config = UserConfig::default();
1211                 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1212                 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1213                 default_config.channel_options.cltv_expiry_delta = 6*6;
1214                 default_config.channel_options.announced_channel = true;
1215                 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1216                 default_config.own_channel_config.our_htlc_minimum_msat = 1000; // sanitization being done by the sender, to exerce receiver logic we need to lift of limit
1217                 let network = Network::Testnet;
1218                 let params = ChainParameters {
1219                         network,
1220                         latest_hash: genesis_block(network).header.block_hash(),
1221                         latest_height: 0,
1222                 };
1223                 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, params);
1224                 chanmgrs.push(node);
1225         }
1226
1227         chanmgrs
1228 }
1229
1230 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>> {
1231         let mut nodes = Vec::new();
1232         let chan_count = Rc::new(RefCell::new(0));
1233         let payment_count = Rc::new(RefCell::new(0));
1234
1235         for i in 0..node_count {
1236                 let net_graph_msg_handler = NetGraphMsgHandler::new(cfgs[i].chain_source.genesis_hash, None, cfgs[i].logger);
1237                 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1238                                  tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1239                                  keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1240                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1241                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1242                                  blocks: RefCell::new(vec![(genesis_block(Network::Testnet).header, 0)])
1243                 })
1244         }
1245
1246         nodes
1247 }
1248
1249 // Note that the following only works for CLTV values up to 128
1250 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1251 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1252
1253 #[derive(PartialEq)]
1254 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1255 /// Tests that the given node has broadcast transactions for the given Channel
1256 ///
1257 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1258 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1259 /// broadcast and the revoked outputs were claimed.
1260 ///
1261 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1262 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1263 ///
1264 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1265 /// also fail.
1266 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>  {
1267         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1268         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1269
1270         let mut res = Vec::with_capacity(2);
1271         node_txn.retain(|tx| {
1272                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1273                         check_spends!(tx, chan.3);
1274                         if commitment_tx.is_none() {
1275                                 res.push(tx.clone());
1276                         }
1277                         false
1278                 } else { true }
1279         });
1280         if let Some(explicit_tx) = commitment_tx {
1281                 res.push(explicit_tx.clone());
1282         }
1283
1284         assert_eq!(res.len(), 1);
1285
1286         if has_htlc_tx != HTLCType::NONE {
1287                 node_txn.retain(|tx| {
1288                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1289                                 check_spends!(tx, res[0]);
1290                                 if has_htlc_tx == HTLCType::TIMEOUT {
1291                                         assert!(tx.lock_time != 0);
1292                                 } else {
1293                                         assert!(tx.lock_time == 0);
1294                                 }
1295                                 res.push(tx.clone());
1296                                 false
1297                         } else { true }
1298                 });
1299                 assert!(res.len() == 2 || res.len() == 3);
1300                 if res.len() == 3 {
1301                         assert_eq!(res[1], res[2]);
1302                 }
1303         }
1304
1305         assert!(node_txn.is_empty());
1306         res
1307 }
1308
1309 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1310 /// HTLC transaction.
1311 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1312         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1313         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1314         // for revoked htlc outputs
1315         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1316         node_txn.retain(|tx| {
1317                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1318                         check_spends!(tx, revoked_tx);
1319                         false
1320                 } else { true }
1321         });
1322         node_txn.retain(|tx| {
1323                 check_spends!(tx, commitment_revoked_tx);
1324                 false
1325         });
1326         assert!(node_txn.is_empty());
1327 }
1328
1329 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1330         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1331
1332         assert!(node_txn.len() >= 1);
1333         assert_eq!(node_txn[0].input.len(), 1);
1334         let mut found_prev = false;
1335
1336         for tx in prev_txn {
1337                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1338                         check_spends!(node_txn[0], tx);
1339                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1340                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1341
1342                         found_prev = true;
1343                         break;
1344                 }
1345         }
1346         assert!(found_prev);
1347
1348         let mut res = Vec::new();
1349         mem::swap(&mut *node_txn, &mut res);
1350         res
1351 }
1352
1353 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1354         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1355         assert_eq!(events_1.len(), 1);
1356         let as_update = match events_1[0] {
1357                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1358                         msg.clone()
1359                 },
1360                 _ => panic!("Unexpected event"),
1361         };
1362
1363         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1364         assert_eq!(events_2.len(), 1);
1365         let bs_update = match events_2[0] {
1366                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1367                         msg.clone()
1368                 },
1369                 _ => panic!("Unexpected event"),
1370         };
1371
1372         for node in nodes {
1373                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1374                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1375         }
1376 }
1377
1378 #[cfg(test)]
1379 macro_rules! get_channel_value_stat {
1380         ($node: expr, $channel_id: expr) => {{
1381                 let chan_lock = $node.node.channel_state.lock().unwrap();
1382                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1383                 chan.get_value_stat()
1384         }}
1385 }
1386
1387 macro_rules! get_chan_reestablish_msgs {
1388         ($src_node: expr, $dst_node: expr) => {
1389                 {
1390                         let mut res = Vec::with_capacity(1);
1391                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1392                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1393                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1394                                         res.push(msg.clone());
1395                                 } else {
1396                                         panic!("Unexpected event")
1397                                 }
1398                         }
1399                         res
1400                 }
1401         }
1402 }
1403
1404 macro_rules! handle_chan_reestablish_msgs {
1405         ($src_node: expr, $dst_node: expr) => {
1406                 {
1407                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1408                         let mut idx = 0;
1409                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1410                                 idx += 1;
1411                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1412                                 Some(msg.clone())
1413                         } else {
1414                                 None
1415                         };
1416
1417                         let mut revoke_and_ack = None;
1418                         let mut commitment_update = None;
1419                         let order = if let Some(ev) = msg_events.get(idx) {
1420                                 idx += 1;
1421                                 match ev {
1422                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1423                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1424                                                 revoke_and_ack = Some(msg.clone());
1425                                                 RAACommitmentOrder::RevokeAndACKFirst
1426                                         },
1427                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1428                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1429                                                 commitment_update = Some(updates.clone());
1430                                                 RAACommitmentOrder::CommitmentFirst
1431                                         },
1432                                         _ => panic!("Unexpected event"),
1433                                 }
1434                         } else {
1435                                 RAACommitmentOrder::CommitmentFirst
1436                         };
1437
1438                         if let Some(ev) = msg_events.get(idx) {
1439                                 match ev {
1440                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1441                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1442                                                 assert!(revoke_and_ack.is_none());
1443                                                 revoke_and_ack = Some(msg.clone());
1444                                         },
1445                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1446                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1447                                                 assert!(commitment_update.is_none());
1448                                                 commitment_update = Some(updates.clone());
1449                                         },
1450                                         _ => panic!("Unexpected event"),
1451                                 }
1452                         }
1453
1454                         (funding_locked, revoke_and_ack, commitment_update, order)
1455                 }
1456         }
1457 }
1458
1459 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1460 /// for claims/fails they are separated out.
1461 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_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
1462         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1463         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1464         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1465         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1466
1467         if send_funding_locked.0 {
1468                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1469                 // from b
1470                 for reestablish in reestablish_1.iter() {
1471                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1472                 }
1473         }
1474         if send_funding_locked.1 {
1475                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1476                 // from a
1477                 for reestablish in reestablish_2.iter() {
1478                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1479                 }
1480         }
1481         if send_funding_locked.0 || send_funding_locked.1 {
1482                 // If we expect any funding_locked's, both sides better have set
1483                 // next_holder_commitment_number to 1
1484                 for reestablish in reestablish_1.iter() {
1485                         assert_eq!(reestablish.next_local_commitment_number, 1);
1486                 }
1487                 for reestablish in reestablish_2.iter() {
1488                         assert_eq!(reestablish.next_local_commitment_number, 1);
1489                 }
1490         }
1491
1492         let mut resp_1 = Vec::new();
1493         for msg in reestablish_1 {
1494                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1495                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1496         }
1497         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1498                 check_added_monitors!(node_b, 1);
1499         } else {
1500                 check_added_monitors!(node_b, 0);
1501         }
1502
1503         let mut resp_2 = Vec::new();
1504         for msg in reestablish_2 {
1505                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1506                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1507         }
1508         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1509                 check_added_monitors!(node_a, 1);
1510         } else {
1511                 check_added_monitors!(node_a, 0);
1512         }
1513
1514         // We don't yet support both needing updates, as that would require a different commitment dance:
1515         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1516                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1517
1518         for chan_msgs in resp_1.drain(..) {
1519                 if send_funding_locked.0 {
1520                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1521                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1522                         if !announcement_event.is_empty() {
1523                                 assert_eq!(announcement_event.len(), 1);
1524                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1525                                         //TODO: Test announcement_sigs re-sending
1526                                 } else { panic!("Unexpected event!"); }
1527                         }
1528                 } else {
1529                         assert!(chan_msgs.0.is_none());
1530                 }
1531                 if pending_raa.0 {
1532                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1533                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1534                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1535                         check_added_monitors!(node_a, 1);
1536                 } else {
1537                         assert!(chan_msgs.1.is_none());
1538                 }
1539                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1540                         let commitment_update = chan_msgs.2.unwrap();
1541                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1542                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1543                         } else {
1544                                 assert!(commitment_update.update_add_htlcs.is_empty());
1545                         }
1546                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1547                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1548                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1549                         for update_add in commitment_update.update_add_htlcs {
1550                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1551                         }
1552                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1553                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1554                         }
1555                         for update_fail in commitment_update.update_fail_htlcs {
1556                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1557                         }
1558
1559                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1560                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1561                         } else {
1562                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1563                                 check_added_monitors!(node_a, 1);
1564                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1565                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1566                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1567                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1568                                 check_added_monitors!(node_b, 1);
1569                         }
1570                 } else {
1571                         assert!(chan_msgs.2.is_none());
1572                 }
1573         }
1574
1575         for chan_msgs in resp_2.drain(..) {
1576                 if send_funding_locked.1 {
1577                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1578                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1579                         if !announcement_event.is_empty() {
1580                                 assert_eq!(announcement_event.len(), 1);
1581                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1582                                         //TODO: Test announcement_sigs re-sending
1583                                 } else { panic!("Unexpected event!"); }
1584                         }
1585                 } else {
1586                         assert!(chan_msgs.0.is_none());
1587                 }
1588                 if pending_raa.1 {
1589                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1590                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1591                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1592                         check_added_monitors!(node_b, 1);
1593                 } else {
1594                         assert!(chan_msgs.1.is_none());
1595                 }
1596                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1597                         let commitment_update = chan_msgs.2.unwrap();
1598                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1599                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1600                         }
1601                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1602                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1603                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1604                         for update_add in commitment_update.update_add_htlcs {
1605                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1606                         }
1607                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1608                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1609                         }
1610                         for update_fail in commitment_update.update_fail_htlcs {
1611                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1612                         }
1613
1614                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1615                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1616                         } else {
1617                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1618                                 check_added_monitors!(node_b, 1);
1619                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1620                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1621                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1622                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1623                                 check_added_monitors!(node_a, 1);
1624                         }
1625                 } else {
1626                         assert!(chan_msgs.2.is_none());
1627                 }
1628         }
1629 }