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