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