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

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