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

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