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