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