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