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

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