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

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