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

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