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