_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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