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