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