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