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