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