_ Git - rust-lightning/blob - lightning/src/ln/functional_test_utils.rs

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