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