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