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