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