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