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

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