_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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