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