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