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

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