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