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