1 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
2 //! nodes for functional tests.
4 use chain::chaininterface;
5 use chain::transaction::OutPoint;
6 use chain::keysinterface::KeysInterface;
7 use ln::channelmanager::{ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure};
8 use ln::channelmonitor::{ChannelMonitor, ManyChannelMonitor};
9 use ln::router::{Route, Router, RouterReadArgs};
10 use ln::features::InitFeatures;
12 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
13 use util::enforcing_trait_impls::EnforcingChannelKeys;
15 use util::test_utils::TestChannelMonitor;
16 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
17 use util::errors::APIError;
18 use util::logger::Logger;
19 use util::config::UserConfig;
20 use util::ser::{ReadableArgs, Writeable};
22 use bitcoin::util::hash::BitcoinHash;
23 use bitcoin::blockdata::block::BlockHeader;
24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
25 use bitcoin::network::constants::Network;
27 use bitcoin::hashes::sha256::Hash as Sha256;
28 use bitcoin::hashes::Hash;
29 use bitcoin::hash_types::BlockHash;
31 use bitcoin::secp256k1::Secp256k1;
32 use bitcoin::secp256k1::key::PublicKey;
34 use rand::{thread_rng,Rng};
36 use std::cell::RefCell;
38 use std::sync::{Arc, Mutex};
40 use std::collections::HashMap;
42 pub const CHAN_CONFIRM_DEPTH: u32 = 100;
43 pub fn confirm_transaction<'a, 'b: 'a>(notifier: &'a chaininterface::BlockNotifierRef<'b>, chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
44 assert!(chain.does_match_tx(tx));
45 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
46 notifier.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
47 for i in 2..CHAN_CONFIRM_DEPTH {
48 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
49 notifier.block_connected_checked(&header, i, &vec![], &[0; 0]);
53 pub fn connect_blocks<'a, 'b>(notifier: &'a chaininterface::BlockNotifierRef<'b>, depth: u32, height: u32, parent: bool, prev_blockhash: BlockHash) -> BlockHash {
54 let mut header = BlockHeader { version: 0x2000000, prev_blockhash: if parent { prev_blockhash } else { Default::default() }, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
55 notifier.block_connected_checked(&header, height + 1, &Vec::new(), &Vec::new());
56 for i in 2..depth + 1 {
57 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
58 notifier.block_connected_checked(&header, height + i, &Vec::new(), &Vec::new());
63 pub struct TestChanMonCfg {
64 pub tx_broadcaster: test_utils::TestBroadcaster,
65 pub fee_estimator: test_utils::TestFeeEstimator,
68 pub struct NodeCfg<'a> {
69 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
70 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
71 pub fee_estimator: &'a test_utils::TestFeeEstimator,
72 pub chan_monitor: test_utils::TestChannelMonitor<'a>,
73 pub keys_manager: test_utils::TestKeysInterface,
74 pub logger: Arc<test_utils::TestLogger>,
75 pub node_seed: [u8; 32],
78 pub struct Node<'a, 'b: 'a, 'c: 'b> {
79 pub block_notifier: chaininterface::BlockNotifierRef<'a>,
80 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
81 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
82 pub chan_monitor: &'b test_utils::TestChannelMonitor<'c>,
83 pub keys_manager: &'b test_utils::TestKeysInterface,
84 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator>,
86 pub node_seed: [u8; 32],
87 pub network_payment_count: Rc<RefCell<u8>>,
88 pub network_chan_count: Rc<RefCell<u32>>,
89 pub logger: Arc<test_utils::TestLogger>
92 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
94 if !::std::thread::panicking() {
95 // Check that we processed all pending events
96 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
97 assert!(self.node.get_and_clear_pending_events().is_empty());
98 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
100 // Check that if we serialize the Router, we can deserialize it again.
102 let mut w = test_utils::TestVecWriter(Vec::new());
103 self.router.write(&mut w).unwrap();
104 let deserialized_router = Router::read(&mut ::std::io::Cursor::new(&w.0), RouterReadArgs {
105 chain_monitor: Arc::clone(&self.chain_monitor) as Arc<chaininterface::ChainWatchInterface>,
106 logger: Arc::clone(&self.logger) as Arc<Logger>
108 let mut chan_progress = 0;
110 let orig_announcements = self.router.get_next_channel_announcements(chan_progress, 255);
111 let deserialized_announcements = deserialized_router.get_next_channel_announcements(chan_progress, 255);
112 assert!(orig_announcements == deserialized_announcements);
113 chan_progress = match orig_announcements.last() {
114 Some(announcement) => announcement.0.contents.short_channel_id + 1,
118 let mut node_progress = None;
120 let orig_announcements = self.router.get_next_node_announcements(node_progress.as_ref(), 255);
121 let deserialized_announcements = deserialized_router.get_next_node_announcements(node_progress.as_ref(), 255);
122 assert!(orig_announcements == deserialized_announcements);
123 node_progress = match orig_announcements.last() {
124 Some(announcement) => Some(announcement.contents.node_id),
130 // Check that if we serialize and then deserialize all our channel monitors we get the
131 // same set of outputs to watch for on chain as we have now. Note that if we write
132 // tests that fully close channels and remove the monitors at some point this may break.
133 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
134 let mut deserialized_monitors = Vec::new();
136 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
137 for (_, old_monitor) in old_monitors.iter() {
138 let mut w = test_utils::TestVecWriter(Vec::new());
139 old_monitor.write_for_disk(&mut w).unwrap();
140 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(
141 &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
142 deserialized_monitors.push(deserialized_monitor);
146 // Before using all the new monitors to check the watch outpoints, use the full set of
147 // them to ensure we can write and reload our ChannelManager.
149 let mut channel_monitors = HashMap::new();
150 for monitor in deserialized_monitors.iter_mut() {
151 channel_monitors.insert(monitor.get_funding_txo(), monitor);
154 let mut w = test_utils::TestVecWriter(Vec::new());
155 self.node.write(&mut w).unwrap();
156 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
157 default_config: UserConfig::default(),
158 keys_manager: self.keys_manager,
159 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
160 monitor: self.chan_monitor,
161 tx_broadcaster: self.tx_broadcaster.clone(),
162 logger: Arc::new(test_utils::TestLogger::new()),
163 channel_monitors: &mut channel_monitors,
167 let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
168 let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), &feeest);
169 for deserialized_monitor in deserialized_monitors.drain(..) {
170 if let Err(_) = channel_monitor.add_monitor(deserialized_monitor.get_funding_txo(), deserialized_monitor) {
174 if *chain_watch != *self.chain_monitor {
181 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
182 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
185 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
186 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
187 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
188 (announcement, as_update, bs_update, channel_id, tx)
191 macro_rules! get_revoke_commit_msgs {
192 ($node: expr, $node_id: expr) => {
194 let events = $node.node.get_and_clear_pending_msg_events();
195 assert_eq!(events.len(), 2);
197 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
198 assert_eq!(*node_id, $node_id);
201 _ => panic!("Unexpected event"),
203 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
204 assert_eq!(*node_id, $node_id);
205 assert!(updates.update_add_htlcs.is_empty());
206 assert!(updates.update_fulfill_htlcs.is_empty());
207 assert!(updates.update_fail_htlcs.is_empty());
208 assert!(updates.update_fail_malformed_htlcs.is_empty());
209 assert!(updates.update_fee.is_none());
210 updates.commitment_signed.clone()
212 _ => panic!("Unexpected event"),
218 macro_rules! get_event_msg {
219 ($node: expr, $event_type: path, $node_id: expr) => {
221 let events = $node.node.get_and_clear_pending_msg_events();
222 assert_eq!(events.len(), 1);
224 $event_type { ref node_id, ref msg } => {
225 assert_eq!(*node_id, $node_id);
228 _ => panic!("Unexpected event"),
234 macro_rules! get_htlc_update_msgs {
235 ($node: expr, $node_id: expr) => {
237 let events = $node.node.get_and_clear_pending_msg_events();
238 assert_eq!(events.len(), 1);
240 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
241 assert_eq!(*node_id, $node_id);
244 _ => panic!("Unexpected event"),
250 macro_rules! get_feerate {
251 ($node: expr, $channel_id: expr) => {
253 let chan_lock = $node.node.channel_state.lock().unwrap();
254 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
260 macro_rules! get_local_commitment_txn {
261 ($node: expr, $channel_id: expr) => {
263 let mut monitors = $node.chan_monitor.simple_monitor.monitors.lock().unwrap();
264 let mut commitment_txn = None;
265 for (funding_txo, monitor) in monitors.iter_mut() {
266 if funding_txo.to_channel_id() == $channel_id {
267 commitment_txn = Some(monitor.unsafe_get_latest_local_commitment_txn());
271 commitment_txn.unwrap()
276 macro_rules! unwrap_send_err {
277 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
279 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
280 assert_eq!(fails.len(), 1);
286 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
287 assert_eq!(fails.len(), 1);
289 Err($type) => { $check },
298 macro_rules! check_added_monitors {
299 ($node: expr, $count: expr) => {
301 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
302 assert_eq!(added_monitors.len(), $count);
303 added_monitors.clear();
308 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) {
309 let chan_id = *node.network_chan_count.borrow();
311 let events = node.node.get_and_clear_pending_events();
312 assert_eq!(events.len(), 1);
314 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
315 assert_eq!(*channel_value_satoshis, expected_chan_value);
316 assert_eq!(user_channel_id, expected_user_chan_id);
318 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
319 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
321 let funding_outpoint = OutPoint::new(tx.txid(), 0);
322 (*temporary_channel_id, tx, funding_outpoint)
324 _ => panic!("Unexpected event"),
328 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 {
329 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
330 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()));
331 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()));
333 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
335 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
336 check_added_monitors!(node_a, 0);
338 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()));
340 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
341 assert_eq!(added_monitors.len(), 1);
342 assert_eq!(added_monitors[0].0, funding_output);
343 added_monitors.clear();
346 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()));
348 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
349 assert_eq!(added_monitors.len(), 1);
350 assert_eq!(added_monitors[0].0, funding_output);
351 added_monitors.clear();
354 let events_4 = node_a.node.get_and_clear_pending_events();
355 assert_eq!(events_4.len(), 1);
357 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
358 assert_eq!(user_channel_id, 42);
359 assert_eq!(*funding_txo, funding_output);
361 _ => panic!("Unexpected event"),
367 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) {
368 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
369 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()));
372 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]) {
374 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
375 assert_eq!(events_6.len(), 2);
376 ((match events_6[0] {
377 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
378 channel_id = msg.channel_id.clone();
379 assert_eq!(*node_id, node_recv.node.get_our_node_id());
382 _ => panic!("Unexpected event"),
383 }, match events_6[1] {
384 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
385 assert_eq!(*node_id, node_recv.node.get_our_node_id());
388 _ => panic!("Unexpected event"),
392 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]) {
393 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
394 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
395 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
398 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) {
399 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
400 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
404 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) {
405 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
406 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
407 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
409 let events_7 = node_b.node.get_and_clear_pending_msg_events();
410 assert_eq!(events_7.len(), 1);
411 let (announcement, bs_update) = match events_7[0] {
412 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
415 _ => panic!("Unexpected event"),
418 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
419 let events_8 = node_a.node.get_and_clear_pending_msg_events();
420 assert_eq!(events_8.len(), 1);
421 let as_update = match events_8[0] {
422 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
423 assert!(*announcement == *msg);
424 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
425 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
428 _ => panic!("Unexpected event"),
431 *node_a.network_chan_count.borrow_mut() += 1;
433 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
436 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) {
437 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
440 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) {
441 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
443 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
444 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
445 assert_eq!(a_events.len(), 1);
446 let a_node_announcement = match a_events[0] {
447 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
450 _ => panic!("Unexpected event"),
453 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
454 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
455 assert_eq!(b_events.len(), 1);
456 let b_node_announcement = match b_events[0] {
457 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
460 _ => panic!("Unexpected event"),
464 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
465 node.router.handle_channel_update(&chan_announcement.1).unwrap();
466 node.router.handle_channel_update(&chan_announcement.2).unwrap();
467 node.router.handle_node_announcement(&a_node_announcement).unwrap();
468 node.router.handle_node_announcement(&b_node_announcement).unwrap();
470 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
473 macro_rules! check_spends {
474 ($tx: expr, $($spends_txn: expr),*) => {
476 $tx.verify(|out_point| {
478 if out_point.txid == $spends_txn.txid() {
479 return $spends_txn.output.get(out_point.vout as usize).cloned()
488 macro_rules! get_closing_signed_broadcast {
489 ($node: expr, $dest_pubkey: expr) => {
491 let events = $node.get_and_clear_pending_msg_events();
492 assert!(events.len() == 1 || events.len() == 2);
493 (match events[events.len() - 1] {
494 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
495 assert_eq!(msg.contents.flags & 2, 2);
498 _ => panic!("Unexpected event"),
499 }, if events.len() == 2 {
501 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
502 assert_eq!(*node_id, $dest_pubkey);
505 _ => panic!("Unexpected event"),
512 macro_rules! check_closed_broadcast {
513 ($node: expr, $with_error_msg: expr) => {{
514 let events = $node.node.get_and_clear_pending_msg_events();
515 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
517 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
518 assert_eq!(msg.contents.flags & 2, 2);
520 _ => panic!("Unexpected event"),
524 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
525 // TODO: Check node_id
528 _ => panic!("Unexpected event"),
534 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) {
535 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) };
536 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
539 node_a.close_channel(channel_id).unwrap();
540 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
542 let events_1 = node_b.get_and_clear_pending_msg_events();
543 assert!(events_1.len() >= 1);
544 let shutdown_b = match events_1[0] {
545 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
546 assert_eq!(node_id, &node_a.get_our_node_id());
549 _ => panic!("Unexpected event"),
552 let closing_signed_b = if !close_inbound_first {
553 assert_eq!(events_1.len(), 1);
556 Some(match events_1[1] {
557 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
558 assert_eq!(node_id, &node_a.get_our_node_id());
561 _ => panic!("Unexpected event"),
565 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
566 let (as_update, bs_update) = if close_inbound_first {
567 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
568 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
569 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
570 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
571 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
573 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
574 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
575 assert!(none_b.is_none());
576 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
577 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
578 (as_update, bs_update)
580 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
582 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
583 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
584 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
585 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
587 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
588 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
589 assert!(none_a.is_none());
590 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
591 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
592 (as_update, bs_update)
594 assert_eq!(tx_a, tx_b);
595 check_spends!(tx_a, funding_tx);
597 (as_update, bs_update, tx_a)
600 pub struct SendEvent {
601 pub node_id: PublicKey,
602 pub msgs: Vec<msgs::UpdateAddHTLC>,
603 pub commitment_msg: msgs::CommitmentSigned,
606 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
607 assert!(updates.update_fulfill_htlcs.is_empty());
608 assert!(updates.update_fail_htlcs.is_empty());
609 assert!(updates.update_fail_malformed_htlcs.is_empty());
610 assert!(updates.update_fee.is_none());
611 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
614 pub fn from_event(event: MessageSendEvent) -> SendEvent {
616 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
617 _ => panic!("Unexpected event type!"),
621 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
622 let mut events = node.node.get_and_clear_pending_msg_events();
623 assert_eq!(events.len(), 1);
624 SendEvent::from_event(events.pop().unwrap())
628 macro_rules! commitment_signed_dance {
629 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
631 check_added_monitors!($node_a, 0);
632 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
633 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
634 check_added_monitors!($node_a, 1);
635 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
638 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
640 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
641 check_added_monitors!($node_b, 0);
642 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
643 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
644 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
645 check_added_monitors!($node_b, 1);
646 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
647 let (bs_revoke_and_ack, extra_msg_option) = {
648 let events = $node_b.node.get_and_clear_pending_msg_events();
649 assert!(events.len() <= 2);
651 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
652 assert_eq!(*node_id, $node_a.node.get_our_node_id());
655 _ => panic!("Unexpected event"),
656 }, events.get(1).map(|e| e.clone()))
658 check_added_monitors!($node_b, 1);
660 assert!($node_a.node.get_and_clear_pending_events().is_empty());
661 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
663 (extra_msg_option, bs_revoke_and_ack)
666 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
668 check_added_monitors!($node_a, 0);
669 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
670 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
671 check_added_monitors!($node_a, 1);
672 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
673 assert!(extra_msg_option.is_none());
677 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
679 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
680 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
681 check_added_monitors!($node_a, 1);
685 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
687 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
690 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
692 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
694 expect_pending_htlcs_forwardable!($node_a);
695 check_added_monitors!($node_a, 1);
697 let channel_state = $node_a.node.channel_state.lock().unwrap();
698 assert_eq!(channel_state.pending_msg_events.len(), 1);
699 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
700 assert_ne!(*node_id, $node_b.node.get_our_node_id());
701 } else { panic!("Unexpected event"); }
703 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
709 macro_rules! get_payment_preimage_hash {
712 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
713 *$node.network_payment_count.borrow_mut() += 1;
714 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
715 (payment_preimage, payment_hash)
720 macro_rules! expect_pending_htlcs_forwardable_ignore {
722 let events = $node.node.get_and_clear_pending_events();
723 assert_eq!(events.len(), 1);
725 Event::PendingHTLCsForwardable { .. } => { },
726 _ => panic!("Unexpected event"),
731 macro_rules! expect_pending_htlcs_forwardable {
733 expect_pending_htlcs_forwardable_ignore!($node);
734 $node.node.process_pending_htlc_forwards();
738 macro_rules! expect_payment_received {
739 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
740 let events = $node.node.get_and_clear_pending_events();
741 assert_eq!(events.len(), 1);
743 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
744 assert_eq!($expected_payment_hash, *payment_hash);
745 assert_eq!(None, *payment_secret);
746 assert_eq!($expected_recv_value, amt);
748 _ => panic!("Unexpected event"),
753 macro_rules! expect_payment_sent {
754 ($node: expr, $expected_payment_preimage: expr) => {
755 let events = $node.node.get_and_clear_pending_events();
756 assert_eq!(events.len(), 1);
758 Event::PaymentSent { ref payment_preimage } => {
759 assert_eq!($expected_payment_preimage, *payment_preimage);
761 _ => panic!("Unexpected event"),
766 macro_rules! expect_payment_failed {
767 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
768 let events = $node.node.get_and_clear_pending_events();
769 assert_eq!(events.len(), 1);
771 Event::PaymentFailed { ref payment_hash, rejected_by_dest, ref error_code, ref error_data } => {
772 assert_eq!(*payment_hash, $expected_payment_hash);
773 assert_eq!(rejected_by_dest, $rejected_by_dest);
774 assert!(error_code.is_some());
775 assert!(error_data.is_some());
777 assert_eq!(error_code.unwrap(), $expected_error_code);
778 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data);
781 _ => panic!("Unexpected event"),
786 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>) {
787 origin_node.node.send_payment(&route, our_payment_hash, &our_payment_secret).unwrap();
788 check_added_monitors!(origin_node, expected_paths.len());
789 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
792 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) {
793 let mut payment_event = SendEvent::from_event(ev);
794 let mut prev_node = origin_node;
796 for (idx, &node) in expected_path.iter().enumerate() {
797 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
799 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
800 check_added_monitors!(node, 0);
801 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
803 expect_pending_htlcs_forwardable!(node);
805 if idx == expected_path.len() - 1 {
806 let events_2 = node.node.get_and_clear_pending_events();
807 if payment_received_expected {
808 assert_eq!(events_2.len(), 1);
810 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
811 assert_eq!(our_payment_hash, *payment_hash);
812 assert_eq!(our_payment_secret, *payment_secret);
813 assert_eq!(amt, recv_value);
815 _ => panic!("Unexpected event"),
818 assert!(events_2.is_empty());
821 let mut events_2 = node.node.get_and_clear_pending_msg_events();
822 assert_eq!(events_2.len(), 1);
823 check_added_monitors!(node, 1);
824 payment_event = SendEvent::from_event(events_2.remove(0));
825 assert_eq!(payment_event.msgs.len(), 1);
832 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>) {
833 let mut events = origin_node.node.get_and_clear_pending_msg_events();
834 assert_eq!(events.len(), expected_route.len());
835 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
836 // Once we've gotten through all the HTLCs, the last one should result in a
837 // PaymentReceived (but each previous one should not!), .
838 let expect_payment = path_idx == expected_route.len() - 1;
839 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), our_payment_secret, ev, expect_payment);
843 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) {
844 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, None);
847 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) {
848 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
849 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
850 (our_payment_preimage, our_payment_hash)
853 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) {
854 for path in expected_paths.iter() {
855 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
857 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage, &our_payment_secret, expected_amount));
858 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
860 macro_rules! msgs_from_ev {
863 &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 } } => {
864 assert!(update_add_htlcs.is_empty());
865 assert_eq!(update_fulfill_htlcs.len(), 1);
866 assert!(update_fail_htlcs.is_empty());
867 assert!(update_fail_malformed_htlcs.is_empty());
868 assert!(update_fee.is_none());
869 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
871 _ => panic!("Unexpected event"),
875 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
876 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
877 assert_eq!(events.len(), expected_paths.len());
878 for ev in events.iter() {
879 per_path_msgs.push(msgs_from_ev!(ev));
882 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
883 let mut next_msgs = Some(path_msgs);
884 let mut expected_next_node = next_hop;
886 macro_rules! last_update_fulfill_dance {
887 ($node: expr, $prev_node: expr) => {
889 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
890 check_added_monitors!($node, 0);
891 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
892 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
896 macro_rules! mid_update_fulfill_dance {
897 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
899 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
900 check_added_monitors!($node, 1);
901 let new_next_msgs = if $new_msgs {
902 let events = $node.node.get_and_clear_pending_msg_events();
903 assert_eq!(events.len(), 1);
904 let (res, nexthop) = msgs_from_ev!(&events[0]);
905 expected_next_node = nexthop;
908 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
911 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
912 next_msgs = new_next_msgs;
917 let mut prev_node = expected_route.last().unwrap();
918 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
919 assert_eq!(expected_next_node, node.node.get_our_node_id());
920 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
921 if next_msgs.is_some() {
922 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
924 assert!(!update_next_msgs);
925 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
927 if !skip_last && idx == expected_route.len() - 1 {
928 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
935 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
936 expect_payment_sent!(origin_node, our_payment_preimage);
941 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) {
942 claim_payment_along_route_with_secret(origin_node, &[expected_route], skip_last, our_payment_preimage, None, expected_amount);
945 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) {
946 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
949 pub const TEST_FINAL_CLTV: u32 = 32;
951 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
952 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();
953 assert_eq!(route.paths.len(), 1);
954 assert_eq!(route.paths[0].len(), expected_route.len());
955 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
956 assert_eq!(hop.pubkey, node.node.get_our_node_id());
959 send_along_route(origin_node, route, expected_route, recv_value)
962 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
963 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();
964 assert_eq!(route.paths.len(), 1);
965 assert_eq!(route.paths[0].len(), expected_route.len());
966 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
967 assert_eq!(hop.pubkey, node.node.get_our_node_id());
970 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
971 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
972 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
975 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
976 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
977 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
980 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) {
981 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, &None));
982 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
983 check_added_monitors!(expected_route.last().unwrap(), 1);
985 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
986 macro_rules! update_fail_dance {
987 ($node: expr, $prev_node: expr, $last_node: expr) => {
989 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
990 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
991 if skip_last && $last_node {
992 expect_pending_htlcs_forwardable!($node);
998 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
999 let mut prev_node = expected_route.last().unwrap();
1000 for (idx, node) in expected_route.iter().rev().enumerate() {
1001 assert_eq!(expected_next_node, node.node.get_our_node_id());
1002 if next_msgs.is_some() {
1003 // We may be the "last node" for the purpose of the commitment dance if we're
1004 // skipping the last node (implying it is disconnected) and we're the
1005 // second-to-last node!
1006 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
1009 let events = node.node.get_and_clear_pending_msg_events();
1010 if !skip_last || idx != expected_route.len() - 1 {
1011 assert_eq!(events.len(), 1);
1013 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 } } => {
1014 assert!(update_add_htlcs.is_empty());
1015 assert!(update_fulfill_htlcs.is_empty());
1016 assert_eq!(update_fail_htlcs.len(), 1);
1017 assert!(update_fail_malformed_htlcs.is_empty());
1018 assert!(update_fee.is_none());
1019 expected_next_node = node_id.clone();
1020 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1022 _ => panic!("Unexpected event"),
1025 assert!(events.is_empty());
1027 if !skip_last && idx == expected_route.len() - 1 {
1028 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1035 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
1037 let events = origin_node.node.get_and_clear_pending_events();
1038 assert_eq!(events.len(), 1);
1040 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1041 assert_eq!(payment_hash, our_payment_hash);
1042 assert!(rejected_by_dest);
1044 _ => panic!("Unexpected event"),
1049 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1050 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
1053 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1054 let mut chan_mon_cfgs = Vec::new();
1055 for _ in 0..node_count {
1056 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
1057 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
1058 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator });
1064 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1065 let mut nodes = Vec::new();
1066 let mut rng = thread_rng();
1068 for i in 0..node_count {
1069 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
1070 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
1071 let mut seed = [0; 32];
1072 rng.fill_bytes(&mut seed);
1073 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>);
1074 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &chanmon_cfgs[i].tx_broadcaster, logger.clone(), &chanmon_cfgs[i].fee_estimator);
1075 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chan_monitor, keys_manager, node_seed: seed });
1081 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator>> {
1082 let mut chanmgrs = Vec::new();
1083 for i in 0..node_count {
1084 let mut default_config = UserConfig::default();
1085 default_config.channel_options.announced_channel = true;
1086 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1087 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
1088 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator, &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger.clone(), &cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
1089 chanmgrs.push(node);
1095 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator>>) -> Vec<Node<'a, 'b, 'c>> {
1096 let secp_ctx = Secp256k1::new();
1097 let mut nodes = Vec::new();
1098 let chan_count = Rc::new(RefCell::new(0));
1099 let payment_count = Rc::new(RefCell::new(0));
1101 for i in 0..node_count {
1102 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
1103 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
1104 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
1105 let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &cfgs[i].keys_manager.get_node_secret()), cfgs[i].chain_monitor.clone(), cfgs[i].logger.clone() as Arc<Logger>);
1106 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
1107 tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
1108 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], router,
1109 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1110 network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
1117 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1118 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1120 #[derive(PartialEq)]
1121 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1122 /// Tests that the given node has broadcast transactions for the given Channel
1124 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
1125 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1126 /// broadcast and the revoked outputs were claimed.
1128 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1129 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1131 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1133 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> {
1134 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1135 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1137 let mut res = Vec::with_capacity(2);
1138 node_txn.retain(|tx| {
1139 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1140 check_spends!(tx, chan.3);
1141 if commitment_tx.is_none() {
1142 res.push(tx.clone());
1147 if let Some(explicit_tx) = commitment_tx {
1148 res.push(explicit_tx.clone());
1151 assert_eq!(res.len(), 1);
1153 if has_htlc_tx != HTLCType::NONE {
1154 node_txn.retain(|tx| {
1155 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1156 check_spends!(tx, res[0]);
1157 if has_htlc_tx == HTLCType::TIMEOUT {
1158 assert!(tx.lock_time != 0);
1160 assert!(tx.lock_time == 0);
1162 res.push(tx.clone());
1166 assert!(res.len() == 2 || res.len() == 3);
1168 assert_eq!(res[1], res[2]);
1172 assert!(node_txn.is_empty());
1176 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1177 /// HTLC transaction.
1178 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1179 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1180 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1181 // for revoked htlc outputs
1182 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1183 node_txn.retain(|tx| {
1184 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1185 check_spends!(tx, revoked_tx);
1189 node_txn.retain(|tx| {
1190 check_spends!(tx, commitment_revoked_tx);
1193 assert!(node_txn.is_empty());
1196 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1197 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1199 assert!(node_txn.len() >= 1);
1200 assert_eq!(node_txn[0].input.len(), 1);
1201 let mut found_prev = false;
1203 for tx in prev_txn {
1204 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1205 check_spends!(node_txn[0], tx);
1206 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1207 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1213 assert!(found_prev);
1215 let mut res = Vec::new();
1216 mem::swap(&mut *node_txn, &mut res);
1220 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1221 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1222 assert_eq!(events_1.len(), 1);
1223 let as_update = match events_1[0] {
1224 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1227 _ => panic!("Unexpected event"),
1230 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1231 assert_eq!(events_2.len(), 1);
1232 let bs_update = match events_2[0] {
1233 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1236 _ => panic!("Unexpected event"),
1240 node.router.handle_channel_update(&as_update).unwrap();
1241 node.router.handle_channel_update(&bs_update).unwrap();
1245 macro_rules! get_channel_value_stat {
1246 ($node: expr, $channel_id: expr) => {{
1247 let chan_lock = $node.node.channel_state.lock().unwrap();
1248 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1249 chan.get_value_stat()
1253 macro_rules! get_chan_reestablish_msgs {
1254 ($src_node: expr, $dst_node: expr) => {
1256 let mut res = Vec::with_capacity(1);
1257 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1258 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1259 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1260 res.push(msg.clone());
1262 panic!("Unexpected event")
1270 macro_rules! handle_chan_reestablish_msgs {
1271 ($src_node: expr, $dst_node: expr) => {
1273 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1275 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1277 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1283 let mut revoke_and_ack = None;
1284 let mut commitment_update = None;
1285 let order = if let Some(ev) = msg_events.get(idx) {
1288 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1289 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1290 revoke_and_ack = Some(msg.clone());
1291 RAACommitmentOrder::RevokeAndACKFirst
1293 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1294 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1295 commitment_update = Some(updates.clone());
1296 RAACommitmentOrder::CommitmentFirst
1298 _ => panic!("Unexpected event"),
1301 RAACommitmentOrder::CommitmentFirst
1304 if let Some(ev) = msg_events.get(idx) {
1306 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1307 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1308 assert!(revoke_and_ack.is_none());
1309 revoke_and_ack = Some(msg.clone());
1311 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1312 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1313 assert!(commitment_update.is_none());
1314 commitment_update = Some(updates.clone());
1316 _ => panic!("Unexpected event"),
1320 (funding_locked, revoke_and_ack, commitment_update, order)
1325 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1326 /// for claims/fails they are separated out.
1327 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)) {
1328 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1329 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1330 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1331 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1333 if send_funding_locked.0 {
1334 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1336 for reestablish in reestablish_1.iter() {
1337 assert_eq!(reestablish.next_remote_commitment_number, 0);
1340 if send_funding_locked.1 {
1341 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1343 for reestablish in reestablish_2.iter() {
1344 assert_eq!(reestablish.next_remote_commitment_number, 0);
1347 if send_funding_locked.0 || send_funding_locked.1 {
1348 // If we expect any funding_locked's, both sides better have set
1349 // next_local_commitment_number to 1
1350 for reestablish in reestablish_1.iter() {
1351 assert_eq!(reestablish.next_local_commitment_number, 1);
1353 for reestablish in reestablish_2.iter() {
1354 assert_eq!(reestablish.next_local_commitment_number, 1);
1358 let mut resp_1 = Vec::new();
1359 for msg in reestablish_1 {
1360 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1361 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1363 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1364 check_added_monitors!(node_b, 1);
1366 check_added_monitors!(node_b, 0);
1369 let mut resp_2 = Vec::new();
1370 for msg in reestablish_2 {
1371 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1372 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1374 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1375 check_added_monitors!(node_a, 1);
1377 check_added_monitors!(node_a, 0);
1380 // We don't yet support both needing updates, as that would require a different commitment dance:
1381 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1382 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1384 for chan_msgs in resp_1.drain(..) {
1385 if send_funding_locked.0 {
1386 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1387 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1388 if !announcement_event.is_empty() {
1389 assert_eq!(announcement_event.len(), 1);
1390 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1391 //TODO: Test announcement_sigs re-sending
1392 } else { panic!("Unexpected event!"); }
1395 assert!(chan_msgs.0.is_none());
1398 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1399 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1400 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1401 check_added_monitors!(node_a, 1);
1403 assert!(chan_msgs.1.is_none());
1405 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1406 let commitment_update = chan_msgs.2.unwrap();
1407 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1408 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1410 assert!(commitment_update.update_add_htlcs.is_empty());
1412 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1413 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1414 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1415 for update_add in commitment_update.update_add_htlcs {
1416 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1418 for update_fulfill in commitment_update.update_fulfill_htlcs {
1419 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1421 for update_fail in commitment_update.update_fail_htlcs {
1422 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1425 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1426 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1428 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1429 check_added_monitors!(node_a, 1);
1430 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1431 // No commitment_signed so get_event_msg's assert(len == 1) passes
1432 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1433 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1434 check_added_monitors!(node_b, 1);
1437 assert!(chan_msgs.2.is_none());
1441 for chan_msgs in resp_2.drain(..) {
1442 if send_funding_locked.1 {
1443 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1444 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1445 if !announcement_event.is_empty() {
1446 assert_eq!(announcement_event.len(), 1);
1447 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1448 //TODO: Test announcement_sigs re-sending
1449 } else { panic!("Unexpected event!"); }
1452 assert!(chan_msgs.0.is_none());
1455 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1456 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1457 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1458 check_added_monitors!(node_b, 1);
1460 assert!(chan_msgs.1.is_none());
1462 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1463 let commitment_update = chan_msgs.2.unwrap();
1464 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1465 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1467 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1468 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1469 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1470 for update_add in commitment_update.update_add_htlcs {
1471 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1473 for update_fulfill in commitment_update.update_fulfill_htlcs {
1474 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1476 for update_fail in commitment_update.update_fail_htlcs {
1477 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1480 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1481 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1483 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1484 check_added_monitors!(node_b, 1);
1485 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1486 // No commitment_signed so get_event_msg's assert(len == 1) passes
1487 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1488 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1489 check_added_monitors!(node_a, 1);
1492 assert!(chan_msgs.2.is_none());