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