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