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