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

   1 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
   2 //! nodes for functional tests.
   3
   4 use chain::chaininterface;
   5 use chain::transaction::OutPoint;
   6 use chain::keysinterface::KeysInterface;
   7 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash};
   8 use ln::channelmonitor::{ChannelMonitor, ManyChannelMonitor};
   9 use ln::router::{Route, Router};
  10 use ln::features::InitFeatures;
  11 use ln::msgs;
  12 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
  13 use util::enforcing_trait_impls::EnforcingChannelKeys;
  14 use util::test_utils;
  15 use util::test_utils::TestChannelMonitor;
  16 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  17 use util::errors::APIError;
  18 use util::logger::Logger;
  19 use util::config::UserConfig;
  20 use util::ser::{ReadableArgs, Writeable};
  21
  22 use bitcoin::util::hash::BitcoinHash;
  23 use bitcoin::blockdata::block::BlockHeader;
  24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
  25 use bitcoin::network::constants::Network;
  26
  27 use bitcoin_hashes::sha256::Hash as Sha256;
  28 use bitcoin_hashes::sha256d::Hash as Sha256d;
  29 use bitcoin_hashes::Hash;
  30
  31 use secp256k1::Secp256k1;
  32 use secp256k1::key::PublicKey;
  33
  34 use rand::{thread_rng,Rng};
  35
  36 use std::cell::RefCell;
  37 use std::rc::Rc;
  38 use std::sync::{Arc, Mutex};
  39 use std::mem;
  40 use std::collections::{HashSet, HashMap};
  41
  42 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
  43 pub fn confirm_transaction<'a, 'b: 'a>(notifier: &'a chaininterface::BlockNotifierRef<'b>, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
  44         assert!(chain.does_match_tx(tx));
  45         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  46         notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
  47         for i in 2..CHAN_CONFIRM_DEPTH {
  48                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  49                 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
  50         }
  51 }
  52
  53 pub fn connect_blocks<'a, 'b>(notifier: &'a chaininterface::BlockNotifierRef<'b>, depth: u32, height: u32, parent: bool, prev_blockhash: Sha256d) -> Sha256d {
  54         let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  55         notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
  56         for i in 2..depth + 1 {
  57                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
  58                 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
  59         }
  60         header.bitcoin_hash()
  61 }
  62
  63 pub struct NodeCfg {
  64         pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
  65         pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
  66         pub fee_estimator: Arc<test_utils::TestFeeEstimator>,
  67         pub chan_monitor: test_utils::TestChannelMonitor,
  68         pub keys_manager: Arc<test_utils::TestKeysInterface>,
  69         pub logger: Arc<test_utils::TestLogger>,
  70         pub node_seed: [u8; 32],
  71 }
  72
  73 pub struct Node<'a, 'b: 'a> {
  74         pub block_notifier: chaininterface::BlockNotifierRef<'b>,
  75         pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
  76         pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
  77         pub chan_monitor: &'b test_utils::TestChannelMonitor,
  78         pub keys_manager: Arc<test_utils::TestKeysInterface>,
  79         pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor>,
  80         pub router: Router,
  81         pub node_seed: [u8; 32],
  82         pub network_payment_count: Rc<RefCell<u8>>,
  83         pub network_chan_count: Rc<RefCell<u32>>,
  84         pub logger: Arc<test_utils::TestLogger>
  85 }
  86
  87 impl<'a, 'b> Drop for Node<'a, 'b> {
  88         fn drop(&mut self) {
  89                 if !::std::thread::panicking() {
  90                         // Check that we processed all pending events
  91                         assert!(self.node.get_and_clear_pending_msg_events().is_empty());
  92                         assert!(self.node.get_and_clear_pending_events().is_empty());
  93                         assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
  94
  95                         // Check that if we serialize and then deserialize all our channel monitors we get the
  96                         // same set of outputs to watch for on chain as we have now. Note that if we write
  97                         // tests that fully close channels and remove the monitors at some point this may break.
  98                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
  99                         let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
 100                         let mut deserialized_monitors = Vec::new();
 101                         for (_, old_monitor) in old_monitors.iter() {
 102                                 let mut w = test_utils::TestVecWriter(Vec::new());
 103                                 old_monitor.write_for_disk(&mut w).unwrap();
 104                                 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
 105                                         &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
 106                                 deserialized_monitors.push(deserialized_monitor);
 107                         }
 108
 109                         // Before using all the new monitors to check the watch outpoints, use the full set of
 110                         // them to ensure we can write and reload our ChannelManager.
 111                         {
 112                                 let mut channel_monitors = HashMap::new();
 113                                 for monitor in deserialized_monitors.iter_mut() {
 114                                         channel_monitors.insert(monitor.get_funding_txo().unwrap(), monitor);
 115                                 }
 116
 117                                 let mut w = test_utils::TestVecWriter(Vec::new());
 118                                 self.node.write(&mut w).unwrap();
 119                                 <(Sha256d, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
 120                                         default_config: UserConfig::default(),
 121                                         keys_manager: self.keys_manager.clone(),
 122                                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
 123                                         monitor: self.chan_monitor,
 124                                         tx_broadcaster: self.tx_broadcaster.clone(),
 125                                         logger: Arc::new(test_utils::TestLogger::new()),
 126                                         channel_monitors: &mut channel_monitors,
 127                                 }).unwrap();
 128                         }
 129
 130                         let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
 131                         let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), feeest);
 132                         for deserialized_monitor in deserialized_monitors.drain(..) {
 133                                 if let Err(_) = channel_monitor.add_update_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
 134                                         panic!();
 135                                 }
 136                         }
 137                         if *chain_watch != *self.chain_monitor {
 138                                 panic!();
 139                         }
 140                 }
 141         }
 142 }
 143
 144 pub fn create_chan_between_nodes<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
 145         create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
 146 }
 147
 148 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
 149         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);
 150         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
 151         (announcement, as_update, bs_update, channel_id, tx)
 152 }
 153
 154 macro_rules! get_revoke_commit_msgs {
 155         ($node: expr, $node_id: expr) => {
 156                 {
 157                         let events = $node.node.get_and_clear_pending_msg_events();
 158                         assert_eq!(events.len(), 2);
 159                         (match events[0] {
 160                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 161                                         assert_eq!(*node_id, $node_id);
 162                                         (*msg).clone()
 163                                 },
 164                                 _ => panic!("Unexpected event"),
 165                         }, match events[1] {
 166                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 167                                         assert_eq!(*node_id, $node_id);
 168                                         assert!(updates.update_add_htlcs.is_empty());
 169                                         assert!(updates.update_fulfill_htlcs.is_empty());
 170                                         assert!(updates.update_fail_htlcs.is_empty());
 171                                         assert!(updates.update_fail_malformed_htlcs.is_empty());
 172                                         assert!(updates.update_fee.is_none());
 173                                         updates.commitment_signed.clone()
 174                                 },
 175                                 _ => panic!("Unexpected event"),
 176                         })
 177                 }
 178         }
 179 }
 180
 181 macro_rules! get_event_msg {
 182         ($node: expr, $event_type: path, $node_id: expr) => {
 183                 {
 184                         let events = $node.node.get_and_clear_pending_msg_events();
 185                         assert_eq!(events.len(), 1);
 186                         match events[0] {
 187                                 $event_type { ref node_id, ref msg } => {
 188                                         assert_eq!(*node_id, $node_id);
 189                                         (*msg).clone()
 190                                 },
 191                                 _ => panic!("Unexpected event"),
 192                         }
 193                 }
 194         }
 195 }
 196
 197 macro_rules! get_htlc_update_msgs {
 198         ($node: expr, $node_id: expr) => {
 199                 {
 200                         let events = $node.node.get_and_clear_pending_msg_events();
 201                         assert_eq!(events.len(), 1);
 202                         match events[0] {
 203                                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
 204                                         assert_eq!(*node_id, $node_id);
 205                                         (*updates).clone()
 206                                 },
 207                                 _ => panic!("Unexpected event"),
 208                         }
 209                 }
 210         }
 211 }
 212
 213 macro_rules! get_feerate {
 214         ($node: expr, $channel_id: expr) => {
 215                 {
 216                         let chan_lock = $node.node.channel_state.lock().unwrap();
 217                         let chan = chan_lock.by_id.get(&$channel_id).unwrap();
 218                         chan.get_feerate()
 219                 }
 220         }
 221 }
 222
 223 pub fn create_funding_transaction<'a, 'b>(node: &Node<'a, 'b>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
 224         let chan_id = *node.network_chan_count.borrow();
 225
 226         let events = node.node.get_and_clear_pending_events();
 227         assert_eq!(events.len(), 1);
 228         match events[0] {
 229                 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
 230                         assert_eq!(*channel_value_satoshis, expected_chan_value);
 231                         assert_eq!(user_channel_id, expected_user_chan_id);
 232
 233                         let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
 234                                 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
 235                         }]};
 236                         let funding_outpoint = OutPoint::new(tx.txid(), 0);
 237                         (*temporary_channel_id, tx, funding_outpoint)
 238                 },
 239                 _ => panic!("Unexpected event"),
 240         }
 241 }
 242
 243 pub fn create_chan_between_nodes_with_value_init<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> Transaction {
 244         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
 245         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()));
 246         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()));
 247
 248         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
 249
 250         {
 251                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
 252                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
 253                 assert_eq!(added_monitors.len(), 1);
 254                 assert_eq!(added_monitors[0].0, funding_output);
 255                 added_monitors.clear();
 256         }
 257
 258         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()));
 259         {
 260                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
 261                 assert_eq!(added_monitors.len(), 1);
 262                 assert_eq!(added_monitors[0].0, funding_output);
 263                 added_monitors.clear();
 264         }
 265
 266         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()));
 267         {
 268                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
 269                 assert_eq!(added_monitors.len(), 1);
 270                 assert_eq!(added_monitors[0].0, funding_output);
 271                 added_monitors.clear();
 272         }
 273
 274         let events_4 = node_a.node.get_and_clear_pending_events();
 275         assert_eq!(events_4.len(), 1);
 276         match events_4[0] {
 277                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 278                         assert_eq!(user_channel_id, 42);
 279                         assert_eq!(*funding_txo, funding_output);
 280                 },
 281                 _ => panic!("Unexpected event"),
 282         };
 283
 284         tx
 285 }
 286
 287 pub fn create_chan_between_nodes_with_value_confirm_first<'a, 'b, 'c>(node_recv: &'a Node<'a, 'b>, node_conf: &'a Node<'a, 'b>, tx: &Transaction) {
 288         confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
 289         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()));
 290 }
 291
 292 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b>(node_recv: &Node<'a, 'b>, node_conf: &Node<'a, 'b>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
 293         let channel_id;
 294         let events_6 = node_conf.node.get_and_clear_pending_msg_events();
 295         assert_eq!(events_6.len(), 2);
 296         ((match events_6[0] {
 297                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
 298                         channel_id = msg.channel_id.clone();
 299                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 300                         msg.clone()
 301                 },
 302                 _ => panic!("Unexpected event"),
 303         }, match events_6[1] {
 304                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
 305                         assert_eq!(*node_id, node_recv.node.get_our_node_id());
 306                         msg.clone()
 307                 },
 308                 _ => panic!("Unexpected event"),
 309         }), channel_id)
 310 }
 311
 312 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
 313         create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
 314         confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
 315         create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
 316 }
 317
 318 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
 319         let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
 320         let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
 321         (msgs, chan_id, tx)
 322 }
 323
 324 pub fn create_chan_between_nodes_with_value_b<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
 325         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
 326         let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
 327         node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
 328
 329         let events_7 = node_b.node.get_and_clear_pending_msg_events();
 330         assert_eq!(events_7.len(), 1);
 331         let (announcement, bs_update) = match events_7[0] {
 332                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 333                         (msg, update_msg)
 334                 },
 335                 _ => panic!("Unexpected event"),
 336         };
 337
 338         node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
 339         let events_8 = node_a.node.get_and_clear_pending_msg_events();
 340         assert_eq!(events_8.len(), 1);
 341         let as_update = match events_8[0] {
 342                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
 343                         assert!(*announcement == *msg);
 344                         assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
 345                         assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
 346                         update_msg
 347                 },
 348                 _ => panic!("Unexpected event"),
 349         };
 350
 351         *node_a.network_chan_count.borrow_mut() += 1;
 352
 353         ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
 354 }
 355
 356 pub fn create_announced_chan_between_nodes<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
 357         create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
 358 }
 359
 360 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
 361         let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
 362         for node in nodes {
 363                 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
 364                 node.router.handle_channel_update(&chan_announcement.1).unwrap();
 365                 node.router.handle_channel_update(&chan_announcement.2).unwrap();
 366         }
 367         (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
 368 }
 369
 370 macro_rules! check_spends {
 371         ($tx: expr, $spends_tx: expr) => {
 372                 {
 373                         $tx.verify(|out_point| {
 374                                 if out_point.txid == $spends_tx.txid() {
 375                                         $spends_tx.output.get(out_point.vout as usize).cloned()
 376                                 } else {
 377                                         None
 378                                 }
 379                         }).unwrap();
 380                 }
 381         }
 382 }
 383
 384 macro_rules! get_closing_signed_broadcast {
 385         ($node: expr, $dest_pubkey: expr) => {
 386                 {
 387                         let events = $node.get_and_clear_pending_msg_events();
 388                         assert!(events.len() == 1 || events.len() == 2);
 389                         (match events[events.len() - 1] {
 390                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 391                                         assert_eq!(msg.contents.flags & 2, 2);
 392                                         msg.clone()
 393                                 },
 394                                 _ => panic!("Unexpected event"),
 395                         }, if events.len() == 2 {
 396                                 match events[0] {
 397                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 398                                                 assert_eq!(*node_id, $dest_pubkey);
 399                                                 Some(msg.clone())
 400                                         },
 401                                         _ => panic!("Unexpected event"),
 402                                 }
 403                         } else { None })
 404                 }
 405         }
 406 }
 407
 408 macro_rules! check_closed_broadcast {
 409         ($node: expr, $with_error_msg: expr) => {{
 410                 let events = $node.node.get_and_clear_pending_msg_events();
 411                 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
 412                 match events[0] {
 413                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
 414                                 assert_eq!(msg.contents.flags & 2, 2);
 415                         },
 416                         _ => panic!("Unexpected event"),
 417                 }
 418                 if $with_error_msg {
 419                         match events[1] {
 420                                 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
 421                                         // TODO: Check node_id
 422                                         Some(msg.clone())
 423                                 },
 424                                 _ => panic!("Unexpected event"),
 425                         }
 426                 } else { None }
 427         }}
 428 }
 429
 430 pub fn close_channel<'a, 'b>(outbound_node: &Node<'a, 'b>, inbound_node: &Node<'a, 'b>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
 431         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) };
 432         let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
 433         let (tx_a, tx_b);
 434
 435         node_a.close_channel(channel_id).unwrap();
 436         node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
 437
 438         let events_1 = node_b.get_and_clear_pending_msg_events();
 439         assert!(events_1.len() >= 1);
 440         let shutdown_b = match events_1[0] {
 441                 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
 442                         assert_eq!(node_id, &node_a.get_our_node_id());
 443                         msg.clone()
 444                 },
 445                 _ => panic!("Unexpected event"),
 446         };
 447
 448         let closing_signed_b = if !close_inbound_first {
 449                 assert_eq!(events_1.len(), 1);
 450                 None
 451         } else {
 452                 Some(match events_1[1] {
 453                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 454                                 assert_eq!(node_id, &node_a.get_our_node_id());
 455                                 msg.clone()
 456                         },
 457                         _ => panic!("Unexpected event"),
 458                 })
 459         };
 460
 461         node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
 462         let (as_update, bs_update) = if close_inbound_first {
 463                 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
 464                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 465                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 466                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 467                 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 468
 469                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
 470                 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 471                 assert!(none_b.is_none());
 472                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 473                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 474                 (as_update, bs_update)
 475         } else {
 476                 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
 477
 478                 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
 479                 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
 480                 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
 481                 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
 482
 483                 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
 484                 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
 485                 assert!(none_a.is_none());
 486                 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
 487                 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
 488                 (as_update, bs_update)
 489         };
 490         assert_eq!(tx_a, tx_b);
 491         check_spends!(tx_a, funding_tx);
 492
 493         (as_update, bs_update, tx_a)
 494 }
 495
 496 pub struct SendEvent {
 497         pub node_id: PublicKey,
 498         pub msgs: Vec<msgs::UpdateAddHTLC>,
 499         pub commitment_msg: msgs::CommitmentSigned,
 500 }
 501 impl SendEvent {
 502         pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
 503                 assert!(updates.update_fulfill_htlcs.is_empty());
 504                 assert!(updates.update_fail_htlcs.is_empty());
 505                 assert!(updates.update_fail_malformed_htlcs.is_empty());
 506                 assert!(updates.update_fee.is_none());
 507                 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
 508         }
 509
 510         pub fn from_event(event: MessageSendEvent) -> SendEvent {
 511                 match event {
 512                         MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
 513                         _ => panic!("Unexpected event type!"),
 514                 }
 515         }
 516
 517         pub fn from_node<'a, 'b>(node: &Node<'a, 'b>) -> SendEvent {
 518                 let mut events = node.node.get_and_clear_pending_msg_events();
 519                 assert_eq!(events.len(), 1);
 520                 SendEvent::from_event(events.pop().unwrap())
 521         }
 522 }
 523
 524 macro_rules! check_added_monitors {
 525         ($node: expr, $count: expr) => {
 526                 {
 527                         let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
 528                         assert_eq!(added_monitors.len(), $count);
 529                         added_monitors.clear();
 530                 }
 531         }
 532 }
 533
 534 macro_rules! commitment_signed_dance {
 535         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
 536                 {
 537                         check_added_monitors!($node_a, 0);
 538                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 539                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 540                         check_added_monitors!($node_a, 1);
 541                         commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
 542                 }
 543         };
 544         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
 545                 {
 546                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
 547                         check_added_monitors!($node_b, 0);
 548                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 549                         $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
 550                         assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
 551                         check_added_monitors!($node_b, 1);
 552                         $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
 553                         let (bs_revoke_and_ack, extra_msg_option) = {
 554                                 let events = $node_b.node.get_and_clear_pending_msg_events();
 555                                 assert!(events.len() <= 2);
 556                                 (match events[0] {
 557                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
 558                                                 assert_eq!(*node_id, $node_a.node.get_our_node_id());
 559                                                 (*msg).clone()
 560                                         },
 561                                         _ => panic!("Unexpected event"),
 562                                 }, events.get(1).map(|e| e.clone()))
 563                         };
 564                         check_added_monitors!($node_b, 1);
 565                         if $fail_backwards {
 566                                 assert!($node_a.node.get_and_clear_pending_events().is_empty());
 567                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 568                         }
 569                         (extra_msg_option, bs_revoke_and_ack)
 570                 }
 571         };
 572         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
 573                 {
 574                         check_added_monitors!($node_a, 0);
 575                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 576                         $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
 577                         check_added_monitors!($node_a, 1);
 578                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 579                         assert!(extra_msg_option.is_none());
 580                         bs_revoke_and_ack
 581                 }
 582         };
 583         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
 584                 {
 585                         let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
 586                         $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
 587                         check_added_monitors!($node_a, 1);
 588                         extra_msg_option
 589                 }
 590         };
 591         ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
 592                 {
 593                         assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
 594                 }
 595         };
 596         ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
 597                 {
 598                         commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
 599                         if $fail_backwards {
 600                                 expect_pending_htlcs_forwardable!($node_a);
 601                                 check_added_monitors!($node_a, 1);
 602
 603                                 let channel_state = $node_a.node.channel_state.lock().unwrap();
 604                                 assert_eq!(channel_state.pending_msg_events.len(), 1);
 605                                 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
 606                                         assert_ne!(*node_id, $node_b.node.get_our_node_id());
 607                                 } else { panic!("Unexpected event"); }
 608                         } else {
 609                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
 610                         }
 611                 }
 612         }
 613 }
 614
 615 macro_rules! get_payment_preimage_hash {
 616         ($node: expr) => {
 617                 {
 618                         let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
 619                         *$node.network_payment_count.borrow_mut() += 1;
 620                         let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
 621                         (payment_preimage, payment_hash)
 622                 }
 623         }
 624 }
 625
 626 macro_rules! expect_pending_htlcs_forwardable {
 627         ($node: expr) => {{
 628                 let events = $node.node.get_and_clear_pending_events();
 629                 assert_eq!(events.len(), 1);
 630                 match events[0] {
 631                         Event::PendingHTLCsForwardable { .. } => { },
 632                         _ => panic!("Unexpected event"),
 633                 };
 634                 $node.node.process_pending_htlc_forwards();
 635         }}
 636 }
 637
 638 macro_rules! expect_payment_received {
 639         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
 640                 let events = $node.node.get_and_clear_pending_events();
 641                 assert_eq!(events.len(), 1);
 642                 match events[0] {
 643                         Event::PaymentReceived { ref payment_hash, amt } => {
 644                                 assert_eq!($expected_payment_hash, *payment_hash);
 645                                 assert_eq!($expected_recv_value, amt);
 646                         },
 647                         _ => panic!("Unexpected event"),
 648                 }
 649         }
 650 }
 651
 652 macro_rules! expect_payment_sent {
 653         ($node: expr, $expected_payment_preimage: expr) => {
 654                 let events = $node.node.get_and_clear_pending_events();
 655                 assert_eq!(events.len(), 1);
 656                 match events[0] {
 657                         Event::PaymentSent { ref payment_preimage } => {
 658                                 assert_eq!($expected_payment_preimage, *payment_preimage);
 659                         },
 660                         _ => panic!("Unexpected event"),
 661                 }
 662         }
 663 }
 664
 665 macro_rules! expect_payment_failed {
 666         ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr) => {
 667                 let events = $node.node.get_and_clear_pending_events();
 668                 assert_eq!(events.len(), 1);
 669                 match events[0] {
 670                         Event::PaymentFailed { ref payment_hash, rejected_by_dest, .. } => {
 671                                 assert_eq!(*payment_hash, $expected_payment_hash);
 672                                 assert_eq!(rejected_by_dest, $rejected_by_dest);
 673                         },
 674                         _ => panic!("Unexpected event"),
 675                 }
 676         }
 677 }
 678
 679 pub fn send_along_route_with_hash<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64, our_payment_hash: PaymentHash) {
 680         let mut payment_event = {
 681                 origin_node.node.send_payment(route, our_payment_hash).unwrap();
 682                 check_added_monitors!(origin_node, 1);
 683
 684                 let mut events = origin_node.node.get_and_clear_pending_msg_events();
 685                 assert_eq!(events.len(), 1);
 686                 SendEvent::from_event(events.remove(0))
 687         };
 688         let mut prev_node = origin_node;
 689
 690         for (idx, &node) in expected_route.iter().enumerate() {
 691                 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
 692
 693                 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
 694                 check_added_monitors!(node, 0);
 695                 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
 696
 697                 expect_pending_htlcs_forwardable!(node);
 698
 699                 if idx == expected_route.len() - 1 {
 700                         let events_2 = node.node.get_and_clear_pending_events();
 701                         assert_eq!(events_2.len(), 1);
 702                         match events_2[0] {
 703                                 Event::PaymentReceived { ref payment_hash, amt } => {
 704                                         assert_eq!(our_payment_hash, *payment_hash);
 705                                         assert_eq!(amt, recv_value);
 706                                 },
 707                                 _ => panic!("Unexpected event"),
 708                         }
 709                 } else {
 710                         let mut events_2 = node.node.get_and_clear_pending_msg_events();
 711                         assert_eq!(events_2.len(), 1);
 712                         check_added_monitors!(node, 1);
 713                         payment_event = SendEvent::from_event(events_2.remove(0));
 714                         assert_eq!(payment_event.msgs.len(), 1);
 715                 }
 716
 717                 prev_node = node;
 718         }
 719 }
 720
 721 pub fn send_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
 722         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 723         send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
 724         (our_payment_preimage, our_payment_hash)
 725 }
 726
 727 pub fn claim_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
 728         assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
 729         check_added_monitors!(expected_route.last().unwrap(), 1);
 730
 731         let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
 732         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
 733         macro_rules! get_next_msgs {
 734                 ($node: expr) => {
 735                         {
 736                                 let events = $node.node.get_and_clear_pending_msg_events();
 737                                 assert_eq!(events.len(), 1);
 738                                 match events[0] {
 739                                         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 } } => {
 740                                                 assert!(update_add_htlcs.is_empty());
 741                                                 assert_eq!(update_fulfill_htlcs.len(), 1);
 742                                                 assert!(update_fail_htlcs.is_empty());
 743                                                 assert!(update_fail_malformed_htlcs.is_empty());
 744                                                 assert!(update_fee.is_none());
 745                                                 expected_next_node = node_id.clone();
 746                                                 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
 747                                         },
 748                                         _ => panic!("Unexpected event"),
 749                                 }
 750                         }
 751                 }
 752         }
 753
 754         macro_rules! last_update_fulfill_dance {
 755                 ($node: expr, $prev_node: expr) => {
 756                         {
 757                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 758                                 check_added_monitors!($node, 0);
 759                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 760                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 761                         }
 762                 }
 763         }
 764         macro_rules! mid_update_fulfill_dance {
 765                 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
 766                         {
 767                                 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 768                                 check_added_monitors!($node, 1);
 769                                 let new_next_msgs = if $new_msgs {
 770                                         get_next_msgs!($node)
 771                                 } else {
 772                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
 773                                         None
 774                                 };
 775                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
 776                                 next_msgs = new_next_msgs;
 777                         }
 778                 }
 779         }
 780
 781         let mut prev_node = expected_route.last().unwrap();
 782         for (idx, node) in expected_route.iter().rev().enumerate() {
 783                 assert_eq!(expected_next_node, node.node.get_our_node_id());
 784                 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
 785                 if next_msgs.is_some() {
 786                         mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
 787                 } else if update_next_msgs {
 788                         next_msgs = get_next_msgs!(node);
 789                 } else {
 790                         assert!(node.node.get_and_clear_pending_msg_events().is_empty());
 791                 }
 792                 if !skip_last && idx == expected_route.len() - 1 {
 793                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
 794                 }
 795
 796                 prev_node = node;
 797         }
 798
 799         if !skip_last {
 800                 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
 801                 expect_payment_sent!(origin_node, our_payment_preimage);
 802         }
 803 }
 804
 805 pub fn claim_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
 806         claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
 807 }
 808
 809 pub const TEST_FINAL_CLTV: u32 = 32;
 810
 811 pub fn route_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
 812         let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
 813         assert_eq!(route.hops.len(), expected_route.len());
 814         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
 815                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 816         }
 817
 818         send_along_route(origin_node, route, expected_route, recv_value)
 819 }
 820
 821 pub fn route_over_limit<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64)  {
 822         let route = origin_node.router.get_route(&expected_route.last().unwrap().node.get_our_node_id(), None, &Vec::new(), recv_value, TEST_FINAL_CLTV).unwrap();
 823         assert_eq!(route.hops.len(), expected_route.len());
 824         for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
 825                 assert_eq!(hop.pubkey, node.node.get_our_node_id());
 826         }
 827
 828         let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
 829
 830         let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
 831         match err {
 832                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
 833                 _ => panic!("Unknown error variants"),
 834         };
 835 }
 836
 837 pub fn send_payment<'a, 'b>(origin: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64, expected_value: u64)  {
 838         let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
 839         claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
 840 }
 841
 842 pub fn fail_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_hash: PaymentHash)  {
 843         assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
 844         expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
 845         check_added_monitors!(expected_route.last().unwrap(), 1);
 846
 847         let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
 848         macro_rules! update_fail_dance {
 849                 ($node: expr, $prev_node: expr, $last_node: expr) => {
 850                         {
 851                                 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
 852                                 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
 853                                 if skip_last && $last_node {
 854                                         expect_pending_htlcs_forwardable!($node);
 855                                 }
 856                         }
 857                 }
 858         }
 859
 860         let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
 861         let mut prev_node = expected_route.last().unwrap();
 862         for (idx, node) in expected_route.iter().rev().enumerate() {
 863                 assert_eq!(expected_next_node, node.node.get_our_node_id());
 864                 if next_msgs.is_some() {
 865                         // We may be the "last node" for the purpose of the commitment dance if we're
 866                         // skipping the last node (implying it is disconnected) and we're the
 867                         // second-to-last node!
 868                         update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
 869                 }
 870
 871                 let events = node.node.get_and_clear_pending_msg_events();
 872                 if !skip_last || idx != expected_route.len() - 1 {
 873                         assert_eq!(events.len(), 1);
 874                         match events[0] {
 875                                 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 } } => {
 876                                         assert!(update_add_htlcs.is_empty());
 877                                         assert!(update_fulfill_htlcs.is_empty());
 878                                         assert_eq!(update_fail_htlcs.len(), 1);
 879                                         assert!(update_fail_malformed_htlcs.is_empty());
 880                                         assert!(update_fee.is_none());
 881                                         expected_next_node = node_id.clone();
 882                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
 883                                 },
 884                                 _ => panic!("Unexpected event"),
 885                         }
 886                 } else {
 887                         assert!(events.is_empty());
 888                 }
 889                 if !skip_last && idx == expected_route.len() - 1 {
 890                         assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
 891                 }
 892
 893                 prev_node = node;
 894         }
 895
 896         if !skip_last {
 897                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
 898
 899                 let events = origin_node.node.get_and_clear_pending_events();
 900                 assert_eq!(events.len(), 1);
 901                 match events[0] {
 902                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
 903                                 assert_eq!(payment_hash, our_payment_hash);
 904                                 assert!(rejected_by_dest);
 905                         },
 906                         _ => panic!("Unexpected event"),
 907                 }
 908         }
 909 }
 910
 911 pub fn fail_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_hash: PaymentHash)  {
 912         fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
 913 }
 914
 915 pub fn create_node_cfgs(node_count: usize) -> Vec<NodeCfg> {
 916         let mut nodes = Vec::new();
 917         let mut rng = thread_rng();
 918
 919         for i in 0..node_count {
 920                 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
 921                 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
 922                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
 923                 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
 924                 let mut seed = [0; 32];
 925                 rng.fill_bytes(&mut seed);
 926                 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>));
 927                 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone());
 928                 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster, fee_estimator, chan_monitor, keys_manager, node_seed: seed });
 929         }
 930
 931         nodes
 932 }
 933
 934 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>> {
 935         let mut chanmgrs = Vec::new();
 936         for i in 0..node_count {
 937                 let mut default_config = UserConfig::default();
 938                 default_config.channel_options.announced_channel = true;
 939                 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
 940                 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator.clone(), &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster.clone(), cfgs[i].logger.clone(), cfgs[i].keys_manager.clone(), if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
 941                 chanmgrs.push(node);
 942         }
 943
 944         chanmgrs
 945 }
 946
 947 pub fn create_network<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, chan_mgrs: &'b Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>>) -> Vec<Node<'a, 'b>> {
 948         let secp_ctx = Secp256k1::new();
 949         let mut nodes = Vec::new();
 950         let chan_count = Rc::new(RefCell::new(0));
 951         let payment_count = Rc::new(RefCell::new(0));
 952
 953         for i in 0..node_count {
 954                 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
 955                 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
 956                 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
 957                 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &cfgs[i].keys_manager.get_node_secret()), cfgs[i].chain_monitor.clone(), cfgs[i].logger.clone() as Arc<Logger>);
 958                 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
 959                                                                                  tx_broadcaster: cfgs[i].tx_broadcaster.clone(), chan_monitor: &cfgs[i].chan_monitor,
 960                                                                                  keys_manager: cfgs[i].keys_manager.clone(), node: &chan_mgrs[i], router,
 961                                                                                  node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
 962                                                                                  network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
 963                 })
 964         }
 965
 966         nodes
 967 }
 968
 969 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
 970 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
 971
 972 #[derive(PartialEq)]
 973 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
 974 /// Tests that the given node has broadcast transactions for the given Channel
 975 ///
 976 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
 977 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
 978 /// broadcast and the revoked outputs were claimed.
 979 ///
 980 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
 981 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
 982 ///
 983 /// All broadcast transactions must be accounted for in one of the above three types of we'll
 984 /// also fail.
 985 pub fn test_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction>  {
 986         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
 987         assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
 988
 989         let mut res = Vec::with_capacity(2);
 990         node_txn.retain(|tx| {
 991                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
 992                         check_spends!(tx, chan.3.clone());
 993                         if commitment_tx.is_none() {
 994                                 res.push(tx.clone());
 995                         }
 996                         false
 997                 } else { true }
 998         });
 999         if let Some(explicit_tx) = commitment_tx {
1000                 res.push(explicit_tx.clone());
1001         }
1002
1003         assert_eq!(res.len(), 1);
1004
1005         if has_htlc_tx != HTLCType::NONE {
1006                 node_txn.retain(|tx| {
1007                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1008                                 check_spends!(tx, res[0].clone());
1009                                 if has_htlc_tx == HTLCType::TIMEOUT {
1010                                         assert!(tx.lock_time != 0);
1011                                 } else {
1012                                         assert!(tx.lock_time == 0);
1013                                 }
1014                                 res.push(tx.clone());
1015                                 false
1016                         } else { true }
1017                 });
1018                 assert!(res.len() == 2 || res.len() == 3);
1019                 if res.len() == 3 {
1020                         assert_eq!(res[1], res[2]);
1021                 }
1022         }
1023
1024         assert!(node_txn.is_empty());
1025         res
1026 }
1027
1028 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1029 /// HTLC transaction.
1030 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, revoked_tx: Transaction, commitment_revoked_tx: Transaction)  {
1031         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1032         // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
1033         // but sometimes not as feerate is too-low
1034         if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
1035         node_txn.retain(|tx| {
1036                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1037                         check_spends!(tx, revoked_tx);
1038                         false
1039                 } else { true }
1040         });
1041         node_txn.retain(|tx| {
1042                 check_spends!(tx, commitment_revoked_tx);
1043                 false
1044         });
1045         assert!(node_txn.is_empty());
1046 }
1047
1048 pub fn check_preimage_claim<'a, 'b>(node: &Node<'a, 'b>, prev_txn: &Vec<Transaction>) -> Vec<Transaction>  {
1049         let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1050
1051         assert!(node_txn.len() >= 1);
1052         assert_eq!(node_txn[0].input.len(), 1);
1053         let mut found_prev = false;
1054
1055         for tx in prev_txn {
1056                 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1057                         check_spends!(node_txn[0], tx.clone());
1058                         assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1059                         assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1060
1061                         found_prev = true;
1062                         break;
1063                 }
1064         }
1065         assert!(found_prev);
1066
1067         let mut res = Vec::new();
1068         mem::swap(&mut *node_txn, &mut res);
1069         res
1070 }
1071
1072 pub fn get_announce_close_broadcast_events<'a, 'b>(nodes: &Vec<Node<'a, 'b>>, a: usize, b: usize)  {
1073         let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1074         assert_eq!(events_1.len(), 1);
1075         let as_update = match events_1[0] {
1076                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1077                         msg.clone()
1078                 },
1079                 _ => panic!("Unexpected event"),
1080         };
1081
1082         let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1083         assert_eq!(events_2.len(), 1);
1084         let bs_update = match events_2[0] {
1085                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1086                         msg.clone()
1087                 },
1088                 _ => panic!("Unexpected event"),
1089         };
1090
1091         for node in nodes {
1092                 node.router.handle_channel_update(&as_update).unwrap();
1093                 node.router.handle_channel_update(&bs_update).unwrap();
1094         }
1095 }
1096
1097 macro_rules! get_channel_value_stat {
1098         ($node: expr, $channel_id: expr) => {{
1099                 let chan_lock = $node.node.channel_state.lock().unwrap();
1100                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1101                 chan.get_value_stat()
1102         }}
1103 }
1104
1105 macro_rules! get_chan_reestablish_msgs {
1106         ($src_node: expr, $dst_node: expr) => {
1107                 {
1108                         let mut res = Vec::with_capacity(1);
1109                         for msg in $src_node.node.get_and_clear_pending_msg_events() {
1110                                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1111                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1112                                         res.push(msg.clone());
1113                                 } else {
1114                                         panic!("Unexpected event")
1115                                 }
1116                         }
1117                         res
1118                 }
1119         }
1120 }
1121
1122 macro_rules! handle_chan_reestablish_msgs {
1123         ($src_node: expr, $dst_node: expr) => {
1124                 {
1125                         let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1126                         let mut idx = 0;
1127                         let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1128                                 idx += 1;
1129                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1130                                 Some(msg.clone())
1131                         } else {
1132                                 None
1133                         };
1134
1135                         let mut revoke_and_ack = None;
1136                         let mut commitment_update = None;
1137                         let order = if let Some(ev) = msg_events.get(idx) {
1138                                 idx += 1;
1139                                 match ev {
1140                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1141                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1142                                                 revoke_and_ack = Some(msg.clone());
1143                                                 RAACommitmentOrder::RevokeAndACKFirst
1144                                         },
1145                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1146                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1147                                                 commitment_update = Some(updates.clone());
1148                                                 RAACommitmentOrder::CommitmentFirst
1149                                         },
1150                                         _ => panic!("Unexpected event"),
1151                                 }
1152                         } else {
1153                                 RAACommitmentOrder::CommitmentFirst
1154                         };
1155
1156                         if let Some(ev) = msg_events.get(idx) {
1157                                 match ev {
1158                                         &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1159                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1160                                                 assert!(revoke_and_ack.is_none());
1161                                                 revoke_and_ack = Some(msg.clone());
1162                                         },
1163                                         &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1164                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1165                                                 assert!(commitment_update.is_none());
1166                                                 commitment_update = Some(updates.clone());
1167                                         },
1168                                         _ => panic!("Unexpected event"),
1169                                 }
1170                         }
1171
1172                         (funding_locked, revoke_and_ack, commitment_update, order)
1173                 }
1174         }
1175 }
1176
1177 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1178 /// for claims/fails they are separated out.
1179 pub fn reconnect_nodes<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, send_funding_locked: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool))  {
1180         node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1181         let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1182         node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1183         let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1184
1185         if send_funding_locked.0 {
1186                 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1187                 // from b
1188                 for reestablish in reestablish_1.iter() {
1189                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1190                 }
1191         }
1192         if send_funding_locked.1 {
1193                 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1194                 // from a
1195                 for reestablish in reestablish_2.iter() {
1196                         assert_eq!(reestablish.next_remote_commitment_number, 0);
1197                 }
1198         }
1199         if send_funding_locked.0 || send_funding_locked.1 {
1200                 // If we expect any funding_locked's, both sides better have set
1201                 // next_local_commitment_number to 1
1202                 for reestablish in reestablish_1.iter() {
1203                         assert_eq!(reestablish.next_local_commitment_number, 1);
1204                 }
1205                 for reestablish in reestablish_2.iter() {
1206                         assert_eq!(reestablish.next_local_commitment_number, 1);
1207                 }
1208         }
1209
1210         let mut resp_1 = Vec::new();
1211         for msg in reestablish_1 {
1212                 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1213                 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1214         }
1215         if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1216                 check_added_monitors!(node_b, 1);
1217         } else {
1218                 check_added_monitors!(node_b, 0);
1219         }
1220
1221         let mut resp_2 = Vec::new();
1222         for msg in reestablish_2 {
1223                 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1224                 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1225         }
1226         if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1227                 check_added_monitors!(node_a, 1);
1228         } else {
1229                 check_added_monitors!(node_a, 0);
1230         }
1231
1232         // We don't yet support both needing updates, as that would require a different commitment dance:
1233         assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1234                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1235
1236         for chan_msgs in resp_1.drain(..) {
1237                 if send_funding_locked.0 {
1238                         node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1239                         let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1240                         if !announcement_event.is_empty() {
1241                                 assert_eq!(announcement_event.len(), 1);
1242                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1243                                         //TODO: Test announcement_sigs re-sending
1244                                 } else { panic!("Unexpected event!"); }
1245                         }
1246                 } else {
1247                         assert!(chan_msgs.0.is_none());
1248                 }
1249                 if pending_raa.0 {
1250                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1251                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1252                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1253                         check_added_monitors!(node_a, 1);
1254                 } else {
1255                         assert!(chan_msgs.1.is_none());
1256                 }
1257                 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1258                         let commitment_update = chan_msgs.2.unwrap();
1259                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1260                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1261                         } else {
1262                                 assert!(commitment_update.update_add_htlcs.is_empty());
1263                         }
1264                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1265                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1266                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1267                         for update_add in commitment_update.update_add_htlcs {
1268                                 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1269                         }
1270                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1271                                 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1272                         }
1273                         for update_fail in commitment_update.update_fail_htlcs {
1274                                 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1275                         }
1276
1277                         if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1278                                 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1279                         } else {
1280                                 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1281                                 check_added_monitors!(node_a, 1);
1282                                 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1283                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1284                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1285                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1286                                 check_added_monitors!(node_b, 1);
1287                         }
1288                 } else {
1289                         assert!(chan_msgs.2.is_none());
1290                 }
1291         }
1292
1293         for chan_msgs in resp_2.drain(..) {
1294                 if send_funding_locked.1 {
1295                         node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1296                         let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1297                         if !announcement_event.is_empty() {
1298                                 assert_eq!(announcement_event.len(), 1);
1299                                 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1300                                         //TODO: Test announcement_sigs re-sending
1301                                 } else { panic!("Unexpected event!"); }
1302                         }
1303                 } else {
1304                         assert!(chan_msgs.0.is_none());
1305                 }
1306                 if pending_raa.1 {
1307                         assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1308                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1309                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1310                         check_added_monitors!(node_b, 1);
1311                 } else {
1312                         assert!(chan_msgs.1.is_none());
1313                 }
1314                 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1315                         let commitment_update = chan_msgs.2.unwrap();
1316                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1317                                 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1318                         }
1319                         assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1320                         assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1321                         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1322                         for update_add in commitment_update.update_add_htlcs {
1323                                 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1324                         }
1325                         for update_fulfill in commitment_update.update_fulfill_htlcs {
1326                                 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1327                         }
1328                         for update_fail in commitment_update.update_fail_htlcs {
1329                                 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1330                         }
1331
1332                         if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1333                                 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1334                         } else {
1335                                 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1336                                 check_added_monitors!(node_b, 1);
1337                                 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1338                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
1339                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1340                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1341                                 check_added_monitors!(node_a, 1);
1342                         }
1343                 } else {
1344                         assert!(chan_msgs.2.is_none());
1345                 }
1346         }
1347 }