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

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