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