git.bitcoin.ninja 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().unwrap(), 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().unwrap(), 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.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 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) {
 299         let chan_id = *node.network_chan_count.borrow();
 300
 301         let events = node.node.get_and_clear_pending_events();
 302         assert_eq!(events.len(), 1);
 303         match events[0] {
 304                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 305                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 306                         assert_eq!(user_channel_id, expected_user_chan_id);
 307
 308                         let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 309                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 310                         }]};
 311                         let funding_outpoint = OutPoint::new(tx.txid(), 0);
 312                         (*temporary_channel_id, tx, funding_outpoint)
 313                 },
 314                 _ => panic!("Unexpected event"),
 315         }
 316 }
 317
 318 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 {
 319         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
 320         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()));
 321         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()));
 322
 323         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
 324
 325         {
 326                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
 327                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
 328                 assert_eq!(added_monitors.len(), 1);
 329                 assert_eq!(added_monitors[0].0, funding_output);
 330                 added_monitors.clear();
 331         }
 332
 333         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()));
 334         {
 335                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
 336                 assert_eq!(added_monitors.len(), 1);
 337                 assert_eq!(added_monitors[0].0, funding_output);
 338                 added_monitors.clear();
 339         }
 340
 341         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()));
 342         {
 343                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
 344                 assert_eq!(added_monitors.len(), 1);
 345                 assert_eq!(added_monitors[0].0, funding_output);
 346                 added_monitors.clear();
 347         }
 348
 349         let events_4 = node_a.node.get_and_clear_pending_events();
 350         assert_eq!(events_4.len(), 1);
 351         match events_4[0] {
 352                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 353                         assert_eq!(user_channel_id, 42);
 354                         assert_eq!(*funding_txo, funding_output);
 355                 },
 356                 _ => panic!("Unexpected event"),
 357         };
 358
 359         tx
 360 }
 361
 362 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) {
 363         confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
 364         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()));
 365 }
 366
 367 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]) {
 368         let channel_id;
 369         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 370         assert_eq!(events_6.len(), 2);
 371         ((match events_6[0] {
 372                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 373                         channel_id = msg.channel_id.clone();
 374                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 375                         msg.clone()
 376                 },
 377                 _ => panic!("Unexpected event"),
 378         }, match events_6[1] {
 379                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 380                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 381                         msg.clone()
 382                 },
 383                 _ => panic!("Unexpected event"),
 384         }), channel_id)
 385 }
 386
 387 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]) {
 388         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
 389         confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
 390         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 391 }
 392
 393 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) {
 394         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 395         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 396         (msgs, chan_id, tx)
 397 }
 398
 399 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) {
 400         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 401         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 402         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 403
 404         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 405         assert_eq!(events_7.len(), 1);
 406         let (announcement, bs_update) = match events_7[0] {
 407                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 408                         (msg, update_msg)
 409                 },
 410                 _ => panic!("Unexpected event"),
 411         };
 412
 413         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 414         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 415         assert_eq!(events_8.len(), 1);
 416         let as_update = match events_8[0] {
 417                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 418                         assert!(*announcement == *msg);
 419                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 420                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 421                         update_msg
 422                 },
 423                 _ => panic!("Unexpected event"),
 424         };
 425
 426         *node_a.network_chan_count.borrow_mut() += 1;
 427
 428         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 429 }
 430
 431 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) {
 432         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 433 }
 434
 435 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) {
 436         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 437
 438         nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
 439         let a_events = nodes[a].node.get_and_clear_pending_msg_events();
 440         assert_eq!(a_events.len(), 1);
 441         let a_node_announcement = match a_events[0] {
 442                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 443                         (*msg).clone()
 444                 },
 445                 _ => panic!("Unexpected event"),
 446         };
 447
 448         nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
 449         let b_events = nodes[b].node.get_and_clear_pending_msg_events();
 450         assert_eq!(b_events.len(), 1);
 451         let b_node_announcement = match b_events[0] {
 452                 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
 453                         (*msg).clone()
 454                 },
 455                 _ => panic!("Unexpected event"),
 456         };
 457
 458         for node in nodes {
 459                 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
 460                 node.router.handle_channel_update(&chan_announcement.1).unwrap();
 461                 node.router.handle_channel_update(&chan_announcement.2).unwrap();
 462                 node.router.handle_node_announcement(&a_node_announcement).unwrap();
 463                 node.router.handle_node_announcement(&b_node_announcement).unwrap();
 464         }
 465         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 466 }
 467
 468 macro_rules! check_spends {
 469         ($tx: expr, $($spends_txn: expr),*) => {
 470                 {
 471                         $tx.verify(|out_point| {
 472                                 $(
 473                                         if out_point.txid == $spends_txn.txid() {
 474                                                 return $spends_txn.output.get(out_point.vout as usize).cloned()
 475                                         }
 476                                 )*
 477                                 None
 478                         }).unwrap();
 479                 }
 480         }
 481 }
 482
 483 macro_rules! get_closing_signed_broadcast {
 484         ($node: expr, $dest_pubkey: expr) => {
 485                 {
 486                         let events = $node.get_and_clear_pending_msg_events();
 487                         assert!(events.len() == 1 || events.len() == 2);
 488                         (match events[events.len() - 1] {
 489                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 490                                         assert_eq!(msg.contents.flags & 2, 2);
 491                                         msg.clone()
 492                                 },
 493                                 _ => panic!("Unexpected event"),
 494                         }, if events.len() == 2 {
 495                                 match events[0] {
 496                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 497                                                 assert_eq!(*node_id, $dest_pubkey);
 498                                                 Some(msg.clone())
 499                                         },
 500                                         _ => panic!("Unexpected event"),
 501                                 }
 502                         } else { None })
 503                 }
 504         }
 505 }
 506
 507 macro_rules! check_closed_broadcast {
 508         ($node: expr, $with_error_msg: expr) => {{
 509                 let events = $node.node.get_and_clear_pending_msg_events();
 510                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
 511                 match events[0] {
 512                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 513                                 assert_eq!(msg.contents.flags & 2, 2);
 514                         },
 515                         _ => panic!("Unexpected event"),
 516                 }
 517                 if $with_error_msg {
 518                         match events[1] {
 519                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 520                                         // TODO: Check node_id
 521                                         Some(msg.clone())
 522                                 },
 523                                 _ => panic!("Unexpected event"),
 524                         }
 525                 } else { None }
 526         }}
 527 }
 528
 529 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) {
 530         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) };
 531         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 532         let (tx_a, tx_b);
 533
 534         node_a.close_channel(channel_id).unwrap();
 535         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
 536
 537         let events_1 = node_b.get_and_clear_pending_msg_events();
 538         assert!(events_1.len() >= 1);
 539         let shutdown_b = match events_1[0] {
 540                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 541                         assert_eq!(node_id, &node_a.get_our_node_id());
 542                         msg.clone()
 543                 },
 544                 _ => panic!("Unexpected event"),
 545         };
 546
 547         let closing_signed_b = if !close_inbound_first {
 548                 assert_eq!(events_1.len(), 1);
 549                 None
 550         } else {
 551                 Some(match events_1[1] {
 552                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 553                                 assert_eq!(node_id, &node_a.get_our_node_id());
 554                                 msg.clone()
 555                         },
 556                         _ => panic!("Unexpected event"),
 557                 })
 558         };
 559
 560         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
 561         let (as_update, bs_update) = if close_inbound_first {
 562                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 563                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 564                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 565                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 566                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 567
 568                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 569                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 570                 assert!(none_b.is_none());
 571                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 572                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 573                 (as_update, bs_update)
 574         } else {
 575                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 576
 577                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 578                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 579                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 580                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 581
 582                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 583                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 584                 assert!(none_a.is_none());
 585                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 586                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 587                 (as_update, bs_update)
 588         };
 589         assert_eq!(tx_a, tx_b);
 590         check_spends!(tx_a, funding_tx);
 591
 592         (as_update, bs_update, tx_a)
 593 }
 594
 595 pub struct SendEvent {
 596         pub node_id: PublicKey,
 597         pub msgs: Vec<msgs::UpdateAddHTLC>,
 598         pub commitment_msg: msgs::CommitmentSigned,
 599 }
 600 impl SendEvent {
 601         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 602                 assert!(updates.update_fulfill_htlcs.is_empty());
 603                 assert!(updates.update_fail_htlcs.is_empty());
 604                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 605                 assert!(updates.update_fee.is_none());
 606                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 607         }
 608
 609         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 610                 match event {
 611                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 612                         _ => panic!("Unexpected event type!"),
 613                 }
 614         }
 615
 616         pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
 617                 let mut events = node.node.get_and_clear_pending_msg_events();
 618                 assert_eq!(events.len(), 1);
 619                 SendEvent::from_event(events.pop().unwrap())
 620         }
 621 }
 622
 623 macro_rules! check_added_monitors {
 624         ($node: expr, $count: expr) => {
 625                 {
 626                         let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
 627                         assert_eq!(added_monitors.len(), $count);
 628                         added_monitors.clear();
 629                 }
 630         }
 631 }
 632
 633 macro_rules! commitment_signed_dance {
 634         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 635                 {
 636                         check_added_monitors!($node_a, 0);
 637                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 638                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 639                         check_added_monitors!($node_a, 1);
 640                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 641                 }
 642         };
 643         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 644                 {
 645                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 646                         check_added_monitors!($node_b, 0);
 647                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 648                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 649                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 650                         check_added_monitors!($node_b, 1);
 651                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 652                         let (bs_revoke_and_ack, extra_msg_option) = {
 653                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 654                                 assert!(events.len() <= 2);
 655                                 (match events[0] {
 656                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 657                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 658                                                 (*msg).clone()
 659                                         },
 660                                         _ => panic!("Unexpected event"),
 661                                 }, events.get(1).map(|e| e.clone()))
 662                         };
 663                         check_added_monitors!($node_b, 1);
 664                         if $fail_backwards {
 665                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 666                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 667                         }
 668                         (extra_msg_option, bs_revoke_and_ack)
 669                 }
 670         };
 671         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 672                 {
 673                         check_added_monitors!($node_a, 0);
 674                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 675                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 676                         check_added_monitors!($node_a, 1);
 677                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 678                         assert!(extra_msg_option.is_none());
 679                         bs_revoke_and_ack
 680                 }
 681         };
 682         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 683                 {
 684                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 685                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 686                         check_added_monitors!($node_a, 1);
 687                         extra_msg_option
 688                 }
 689         };
 690         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 691                 {
 692                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 693                 }
 694         };
 695         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 696                 {
 697                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 698                         if $fail_backwards {
 699                                 expect_pending_htlcs_forwardable!($node_a);
 700                                 check_added_monitors!($node_a, 1);
 701
 702                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 703                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 704                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 705                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 706                                 } else { panic!("Unexpected event"); }
 707                         } else {
 708                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 709                         }
 710                 }
 711         }
 712 }
 713
 714 macro_rules! get_payment_preimage_hash {
 715         ($node: expr) => {
 716                 {
 717                         let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
 718                         *$node.network_payment_count.borrow_mut() += 1;
 719                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 720                         (payment_preimage, payment_hash)
 721                 }
 722         }
 723 }
 724
 725 macro_rules! expect_pending_htlcs_forwardable {
 726         ($node: expr) => {{
 727                 let events = $node.node.get_and_clear_pending_events();
 728                 assert_eq!(events.len(), 1);
 729                 match events[0] {
 730                         Event::PendingHTLCsForwardable { .. } => { },
 731                         _ => panic!("Unexpected event"),
 732                 };
 733                 $node.node.process_pending_htlc_forwards();
 734         }}
 735 }
 736
 737 macro_rules! expect_payment_received {
 738         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
 739                 let events = $node.node.get_and_clear_pending_events();
 740                 assert_eq!(events.len(), 1);
 741                 match events[0] {
 742                         Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
 743                                 assert_eq!($expected_payment_hash, *payment_hash);
 744                                 assert_eq!(None, *payment_secret);
 745                                 assert_eq!($expected_recv_value, amt);
 746                         },
 747                         _ => panic!("Unexpected event"),
 748                 }
 749         }
 750 }
 751
 752 macro_rules! expect_payment_sent {
 753         ($node: expr, $expected_payment_preimage: expr) => {
 754                 let events = $node.node.get_and_clear_pending_events();
 755                 assert_eq!(events.len(), 1);
 756                 match events[0] {
 757                         Event::PaymentSent { ref payment_preimage } => {
 758                                 assert_eq!($expected_payment_preimage, *payment_preimage);
 759                         },
 760                         _ => panic!("Unexpected event"),
 761                 }
 762         }
 763 }
 764
 765 macro_rules! expect_payment_failed {
 766         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr) => {
 767                 let events = $node.node.get_and_clear_pending_events();
 768                 assert_eq!(events.len(), 1);
 769                 match events[0] {
 770                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, .. } => {
 771                                 assert_eq!(*payment_hash, $expected_payment_hash);
 772                                 assert_eq!(rejected_by_dest, $rejected_by_dest);
 773                         },
 774                         _ => panic!("Unexpected event"),
 775                 }
 776         }
 777 }
 778
 779 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>) {
 780         origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
 781         check_added_monitors!(origin_node, expected_paths.len());
 782
 783         let mut events = origin_node.node.get_and_clear_pending_msg_events();
 784         assert_eq!(events.len(), expected_paths.len());
 785         for (path_idx, (ev, expected_route)) in events.drain(..).zip(expected_paths.iter()).enumerate() {
 786                 let mut payment_event = SendEvent::from_event(ev);
 787                 let mut prev_node = origin_node;
 788
 789                 for (idx, &node) in expected_route.iter().enumerate() {
 790                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
 791
 792                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
 793                         check_added_monitors!(node, 0);
 794                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
 795
 796                         expect_pending_htlcs_forwardable!(node);
 797
 798                         if idx == expected_route.len() - 1 {
 799                                 let events_2 = node.node.get_and_clear_pending_events();
 800                                 // Once we've gotten through all the HTLCs, the last one should result in a
 801                                 // PaymentReceived (but each previous one should not!).
 802                                 if path_idx == expected_paths.len() - 1 {
 803                                         assert_eq!(events_2.len(), 1);
 804                                         match events_2[0] {
 805                                                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
 806                                                         assert_eq!(our_payment_hash, *payment_hash);
 807                                                         assert_eq!(our_payment_secret, *payment_secret);
 808                                                         assert_eq!(amt, recv_value);
 809                                                 },
 810                                                 _ => panic!("Unexpected event"),
 811                                         }
 812                                 } else {
 813                                         assert!(events_2.is_empty());
 814                                 }
 815                         } else {
 816                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
 817                                 assert_eq!(events_2.len(), 1);
 818                                 check_added_monitors!(node, 1);
 819                                 payment_event = SendEvent::from_event(events_2.remove(0));
 820                                 assert_eq!(payment_event.msgs.len(), 1);
 821                         }
 822
 823                         prev_node = node;
 824                 }
 825         }
 826 }
 827
 828 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) {
 829         send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
 830 }
 831
 832 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) {
 833         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 834         send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
 835         (our_payment_preimage, our_payment_hash)
 836 }
 837
 838 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) {
 839         for path in expected_paths.iter() {
 840                 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
 841         }
 842         assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
 843         check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
 844
 845         macro_rules! msgs_from_ev {
 846                 ($ev: expr) => {
 847                         match $ev {
 848                                 &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 } } => {
 849                                         assert!(update_add_htlcs.is_empty());
 850                                         assert_eq!(update_fulfill_htlcs.len(), 1);
 851                                         assert!(update_fail_htlcs.is_empty());
 852                                         assert!(update_fail_malformed_htlcs.is_empty());
 853                                         assert!(update_fee.is_none());
 854                                         ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
 855                                 },
 856                                 _ => panic!("Unexpected event"),
 857                         }
 858                 }
 859         }
 860         let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
 861         let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
 862         assert_eq!(events.len(), expected_paths.len());
 863         for ev in events.iter() {
 864                 per_path_msgs.push(msgs_from_ev!(ev));
 865         }
 866
 867         for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
 868                 let mut next_msgs = Some(path_msgs);
 869                 let mut expected_next_node = next_hop;
 870
 871                 macro_rules! last_update_fulfill_dance {
 872                         ($node: expr, $prev_node: expr) => {
 873                                 {
 874                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 875                                         check_added_monitors!($node, 0);
 876                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 877                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 878                                 }
 879                         }
 880                 }
 881                 macro_rules! mid_update_fulfill_dance {
 882                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 883                                 {
 884                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 885                                         check_added_monitors!($node, 1);
 886                                         let new_next_msgs = if $new_msgs {
 887                                                 let events = $node.node.get_and_clear_pending_msg_events();
 888                                                 assert_eq!(events.len(), 1);
 889                                                 let (res, nexthop) = msgs_from_ev!(&events[0]);
 890                                                 expected_next_node = nexthop;
 891                                                 Some(res)
 892                                         } else {
 893                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 894                                                 None
 895                                         };
 896                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 897                                         next_msgs = new_next_msgs;
 898                                 }
 899                         }
 900                 }
 901
 902                 let mut prev_node = expected_route.last().unwrap();
 903                 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
 904                         assert_eq!(expected_next_node, node.node.get_our_node_id());
 905                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 906                         if next_msgs.is_some() {
 907                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 908                         } else {
 909                                 assert!(!update_next_msgs);
 910                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
 911                         }
 912                         if !skip_last && idx == expected_route.len() - 1 {
 913                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
 914                         }
 915
 916                         prev_node = node;
 917                 }
 918
 919                 if !skip_last {
 920                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
 921                         expect_payment_sent!(origin_node, our_payment_preimage);
 922                 }
 923         }
 924 }
 925
 926 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) {
 927         claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
 928 }
 929
 930 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) {
 931         claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
 932 }
 933
 934 pub const TEST_FINAL_CLTV: u32 = 32;
 935
 936 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
 937         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();
 938         assert_eq!(route.paths.len(), 1);
 939         assert_eq!(route.paths[0].len(), expected_route.len());
 940         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
 941                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 942         }
 943
 944         send_along_route(origin_node, route, expected_route, recv_value)
 945 }
 946
 947 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64)  {
 948         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();
 949         assert_eq!(route.paths.len(), 1);
 950         assert_eq!(route.paths[0].len(), expected_route.len());
 951         for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
 952                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 953         }
 954
 955         let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 956         unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
 957                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
 958 }
 959
 960 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64)  {
 961         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
 962         claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
 963 }
 964
 965 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)  {
 966         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
 967         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
 968         check_added_monitors!(expected_route.last().unwrap(), 1);
 969
 970         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
 971         macro_rules! update_fail_dance {
 972                 ($node: expr, $prev_node: expr, $last_node: expr) => {
 973                         {
 974                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 975                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
 976                                 if skip_last && $last_node {
 977                                         expect_pending_htlcs_forwardable!($node);
 978                                 }
 979                         }
 980                 }
 981         }
 982
 983         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
 984         let mut prev_node = expected_route.last().unwrap();
 985         for (idx, node) in expected_route.iter().rev().enumerate() {
 986                 assert_eq!(expected_next_node, node.node.get_our_node_id());
 987                 if next_msgs.is_some() {
 988                         // We may be the "last node" for the purpose of the commitment dance if we're
 989                         // skipping the last node (implying it is disconnected) and we're the
 990                         // second-to-last node!
 991                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
 992                 }
 993
 994                 let events = node.node.get_and_clear_pending_msg_events();
 995                 if !skip_last || idx != expected_route.len() - 1 {
 996                         assert_eq!(events.len(), 1);
 997                         match events[0] {
 998                                 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 } } => {
 999                                         assert!(update_add_htlcs.is_empty());
1000                                         assert!(update_fulfill_htlcs.is_empty());
1001                                         assert_eq!(update_fail_htlcs.len(), 1);
1002                                         assert!(update_fail_malformed_htlcs.is_empty());
1003                                         assert!(update_fee.is_none());
1004                                         expected_next_node = node_id.clone();
1005                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1006                                 },
1007                                 _ => panic!("Unexpected event"),
1008                         }
1009                 } else {
1010                         assert!(events.is_empty());
1011                 }
1012                 if !skip_last && idx == expected_route.len() - 1 {
1013                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1014                 }
1015
1016                 prev_node = node;
1017         }
1018
1019         if !skip_last {
1020                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1021
1022                 let events = origin_node.node.get_and_clear_pending_events();
1023                 assert_eq!(events.len(), 1);
1024                 match events[0] {
1025                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1026                                 assert_eq!(payment_hash, our_payment_hash);
1027                                 assert!(rejected_by_dest);
1028                         },
1029                         _ => panic!("Unexpected event"),
1030                 }
1031         }
1032 }
1033
1034 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash)  {
1035         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1036 }
1037
1038 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1039         let mut chan_mon_cfgs = Vec::new();
1040         for _ in 0..node_count {
1041                 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashMap::new())};
1042                 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1043                 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator });
1044         }
1045
1046         chan_mon_cfgs
1047 }
1048
1049 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1050         let mut nodes = Vec::new();
1051         let mut rng = thread_rng();
1052
1053         for i in 0..node_count {
1054                 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
1055                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
1056                 let mut seed = [0; 32];
1057                 rng.fill_bytes(&mut seed);
1058                 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>);
1059                 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &chanmon_cfgs[i].tx_broadcaster, logger.clone(), &chanmon_cfgs[i].fee_estimator);
1060                 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 });
1061         }
1062
1063         nodes
1064 }
1065
1066 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>> {
1067         let mut chanmgrs = Vec::new();
1068         for i in 0..node_count {
1069                 let mut default_config = UserConfig::default();
1070                 default_config.channel_options.announced_channel = true;
1071                 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1072                 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
1073                 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();
1074                 chanmgrs.push(node);
1075         }
1076
1077         chanmgrs
1078 }
1079
1080 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>> {
1081         let secp_ctx = Secp256k1::new();
1082         let mut nodes = Vec::new();
1083         let chan_count = Rc::new(RefCell::new(0));
1084         let payment_count = Rc::new(RefCell::new(0));
1085
1086         for i in 0..node_count {
1087                 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
1088                 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
1089                 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
1090                 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>);
1091                 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
1092                                                                                  tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
1093                                                                                  keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], router,
1094                                                                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1095                                                                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
1096                 })
1097         }
1098
1099         nodes
1100 }
1101
1102 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1103 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1104
1105 #[derive(PartialEq)]
1106 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1107 /// Tests that the given node has broadcast transactions for the given Channel
1108 ///
1109 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
1110 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1111 /// broadcast and the revoked outputs were claimed.
1112 ///
1113 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1114 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1115 ///
1116 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1117 /// also fail.
1118 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>  {
1119         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1120         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1121
1122         let mut res = Vec::with_capacity(2);
1123         node_txn.retain(|tx| {
1124                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1125                         check_spends!(tx, chan.3);
1126                         if commitment_tx.is_none() {
1127                                 res.push(tx.clone());
1128                         }
1129                         false
1130                 } else { true }
1131         });
1132         if let Some(explicit_tx) = commitment_tx {
1133                 res.push(explicit_tx.clone());
1134         }
1135
1136         assert_eq!(res.len(), 1);
1137
1138         if has_htlc_tx != HTLCType::NONE {
1139                 node_txn.retain(|tx| {
1140                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1141                                 check_spends!(tx, res[0]);
1142                                 if has_htlc_tx == HTLCType::TIMEOUT {
1143                                         assert!(tx.lock_time != 0);
1144                                 } else {
1145                                         assert!(tx.lock_time == 0);
1146                                 }
1147                                 res.push(tx.clone());
1148                                 false
1149                         } else { true }
1150                 });
1151                 assert!(res.len() == 2 || res.len() == 3);
1152                 if res.len() == 3 {
1153                         assert_eq!(res[1], res[2]);
1154                 }
1155         }
1156
1157         assert!(node_txn.is_empty());
1158         res
1159 }
1160
1161 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1162 /// HTLC transaction.
1163 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1164         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1165         // We may issue multiple claiming transaction on revoked outputs due to block rescan
1166         // for revoked htlc outputs
1167         if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1168         node_txn.retain(|tx| {
1169                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1170                         check_spends!(tx, revoked_tx);
1171                         false
1172                 } else { true }
1173         });
1174         node_txn.retain(|tx| {
1175                 check_spends!(tx, commitment_revoked_tx);
1176                 false
1177         });
1178         assert!(node_txn.is_empty());
1179 }
1180
1181 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1182         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1183
1184         assert!(node_txn.len() >= 1);
1185         assert_eq!(node_txn[0].input.len(), 1);
1186         let mut found_prev = false;
1187
1188         for tx in prev_txn {
1189                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1190                         check_spends!(node_txn[0], tx);
1191                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1192                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1193
1194                         found_prev = true;
1195                         break;
1196                 }
1197         }
1198         assert!(found_prev);
1199
1200         let mut res = Vec::new();
1201         mem::swap(&mut *node_txn, &mut res);
1202         res
1203 }
1204
1205 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize)  {
1206         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1207         assert_eq!(events_1.len(), 1);
1208         let as_update = match events_1[0] {
1209                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1210                         msg.clone()
1211                 },
1212                 _ => panic!("Unexpected event"),
1213         };
1214
1215         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1216         assert_eq!(events_2.len(), 1);
1217         let bs_update = match events_2[0] {
1218                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1219                         msg.clone()
1220                 },
1221                 _ => panic!("Unexpected event"),
1222         };
1223
1224         for node in nodes {
1225                 node.router.handle_channel_update(&as_update).unwrap();
1226                 node.router.handle_channel_update(&bs_update).unwrap();
1227         }
1228 }
1229
1230 macro_rules! get_channel_value_stat {
1231         ($node: expr, $channel_id: expr) => {{
1232                 let chan_lock = $node.node.channel_state.lock().unwrap();
1233                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1234                 chan.get_value_stat()
1235         }}
1236 }
1237
1238 macro_rules! get_chan_reestablish_msgs {
1239         ($src_node: expr, $dst_node: expr) => {
1240                 {
1241                         let mut res = Vec::with_capacity(1);
1242                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1243                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1244                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1245                                         res.push(msg.clone());
1246                                 } else {
1247                                         panic!("Unexpected event")
1248                                 }
1249                         }
1250                         res
1251                 }
1252         }
1253 }
1254
1255 macro_rules! handle_chan_reestablish_msgs {
1256         ($src_node: expr, $dst_node: expr) => {
1257                 {
1258                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1259                         let mut idx = 0;
1260                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1261                                 idx += 1;
1262                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1263                                 Some(msg.clone())
1264                         } else {
1265                                 None
1266                         };
1267
1268                         let mut revoke_and_ack = None;
1269                         let mut commitment_update = None;
1270                         let order = if let Some(ev) = msg_events.get(idx) {
1271                                 idx += 1;
1272                                 match ev {
1273                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1274                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1275                                                 revoke_and_ack = Some(msg.clone());
1276                                                 RAACommitmentOrder::RevokeAndACKFirst
1277                                         },
1278                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1279                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1280                                                 commitment_update = Some(updates.clone());
1281                                                 RAACommitmentOrder::CommitmentFirst
1282                                         },
1283                                         _ => panic!("Unexpected event"),
1284                                 }
1285                         } else {
1286                                 RAACommitmentOrder::CommitmentFirst
1287                         };
1288
1289                         if let Some(ev) = msg_events.get(idx) {
1290                                 match ev {
1291                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1292                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1293                                                 assert!(revoke_and_ack.is_none());
1294                                                 revoke_and_ack = Some(msg.clone());
1295                                         },
1296                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1297                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1298                                                 assert!(commitment_update.is_none());
1299                                                 commitment_update = Some(updates.clone());
1300                                         },
1301                                         _ => panic!("Unexpected event"),
1302                                 }
1303                         }
1304
1305                         (funding_locked, revoke_and_ack, commitment_update, order)
1306                 }
1307         }
1308 }
1309
1310 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1311 /// for claims/fails they are separated out.
1312 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))  {
1313         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1314         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1315         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1316         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1317
1318         if send_funding_locked.0 {
1319                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1320                 // from b
1321                 for reestablish in reestablish_1.iter() {
1322                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1323                 }
1324         }
1325         if send_funding_locked.1 {
1326                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1327                 // from a
1328                 for reestablish in reestablish_2.iter() {
1329                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1330                 }
1331         }
1332         if send_funding_locked.0 || send_funding_locked.1 {
1333                 // If we expect any funding_locked's, both sides better have set
1334                 // next_local_commitment_number to 1
1335                 for reestablish in reestablish_1.iter() {
1336                         assert_eq!(reestablish.next_local_commitment_number, 1);
1337                 }
1338                 for reestablish in reestablish_2.iter() {
1339                         assert_eq!(reestablish.next_local_commitment_number, 1);
1340                 }
1341         }
1342
1343         let mut resp_1 = Vec::new();
1344         for msg in reestablish_1 {
1345                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1346                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1347         }
1348         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1349                 check_added_monitors!(node_b, 1);
1350         } else {
1351                 check_added_monitors!(node_b, 0);
1352         }
1353
1354         let mut resp_2 = Vec::new();
1355         for msg in reestablish_2 {
1356                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1357                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1358         }
1359         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1360                 check_added_monitors!(node_a, 1);
1361         } else {
1362                 check_added_monitors!(node_a, 0);
1363         }
1364
1365         // We don't yet support both needing updates, as that would require a different commitment dance:
1366         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1367                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1368
1369         for chan_msgs in resp_1.drain(..) {
1370                 if send_funding_locked.0 {
1371                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1372                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1373                         if !announcement_event.is_empty() {
1374                                 assert_eq!(announcement_event.len(), 1);
1375                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1376                                         //TODO: Test announcement_sigs re-sending
1377                                 } else { panic!("Unexpected event!"); }
1378                         }
1379                 } else {
1380                         assert!(chan_msgs.0.is_none());
1381                 }
1382                 if pending_raa.0 {
1383                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1384                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1385                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1386                         check_added_monitors!(node_a, 1);
1387                 } else {
1388                         assert!(chan_msgs.1.is_none());
1389                 }
1390                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1391                         let commitment_update = chan_msgs.2.unwrap();
1392                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1393                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1394                         } else {
1395                                 assert!(commitment_update.update_add_htlcs.is_empty());
1396                         }
1397                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1398                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1399                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1400                         for update_add in commitment_update.update_add_htlcs {
1401                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1402                         }
1403                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1404                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1405                         }
1406                         for update_fail in commitment_update.update_fail_htlcs {
1407                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1408                         }
1409
1410                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1411                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1412                         } else {
1413                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1414                                 check_added_monitors!(node_a, 1);
1415                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1416                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1417                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1418                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1419                                 check_added_monitors!(node_b, 1);
1420                         }
1421                 } else {
1422                         assert!(chan_msgs.2.is_none());
1423                 }
1424         }
1425
1426         for chan_msgs in resp_2.drain(..) {
1427                 if send_funding_locked.1 {
1428                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1429                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1430                         if !announcement_event.is_empty() {
1431                                 assert_eq!(announcement_event.len(), 1);
1432                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1433                                         //TODO: Test announcement_sigs re-sending
1434                                 } else { panic!("Unexpected event!"); }
1435                         }
1436                 } else {
1437                         assert!(chan_msgs.0.is_none());
1438                 }
1439                 if pending_raa.1 {
1440                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1441                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1442                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1443                         check_added_monitors!(node_b, 1);
1444                 } else {
1445                         assert!(chan_msgs.1.is_none());
1446                 }
1447                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1448                         let commitment_update = chan_msgs.2.unwrap();
1449                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1450                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1451                         }
1452                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1453                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1454                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1455                         for update_add in commitment_update.update_add_htlcs {
1456                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1457                         }
1458                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1459                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1460                         }
1461                         for update_fail in commitment_update.update_fail_htlcs {
1462                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1463                         }
1464
1465                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1466                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1467                         } else {
1468                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1469                                 check_added_monitors!(node_b, 1);
1470                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1471                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1472                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1473                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1474                                 check_added_monitors!(node_a, 1);
1475                         }
1476                 } else {
1477                         assert!(chan_msgs.2.is_none());
1478                 }
1479         }
1480 }