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