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