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