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