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

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