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