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

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