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

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