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};
8 use ln::channelmonitor::{ChannelMonitor, ManyChannelMonitor};
9 use ln::router::{Route, Router};
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::sha256d::Hash as Sha256d;
29 use bitcoin_hashes::Hash;
31 use secp256k1::Secp256k1;
32 use secp256k1::key::PublicKey;
34 use rand::{thread_rng,Rng};
36 use std::cell::RefCell;
38 use std::sync::{Arc, Mutex};
40 use std::collections::{HashSet, 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: Sha256d) -> Sha256d {
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,
67 pub struct NodeCfg<'a> {
68 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
69 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
70 pub fee_estimator: Arc<test_utils::TestFeeEstimator>,
71 pub chan_monitor: test_utils::TestChannelMonitor<'a>,
72 pub keys_manager: Arc<test_utils::TestKeysInterface>,
73 pub logger: Arc<test_utils::TestLogger>,
74 pub node_seed: [u8; 32],
77 pub struct Node<'a, 'b: 'a, 'c: 'b> {
78 pub block_notifier: chaininterface::BlockNotifierRef<'a>,
79 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
80 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
81 pub chan_monitor: &'b test_utils::TestChannelMonitor<'c>,
82 pub keys_manager: Arc<test_utils::TestKeysInterface>,
83 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster>,
85 pub node_seed: [u8; 32],
86 pub network_payment_count: Rc<RefCell<u8>>,
87 pub network_chan_count: Rc<RefCell<u32>>,
88 pub logger: Arc<test_utils::TestLogger>
91 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
93 if !::std::thread::panicking() {
94 // Check that we processed all pending events
95 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
96 assert!(self.node.get_and_clear_pending_events().is_empty());
97 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
99 // Check that if we serialize and then deserialize all our channel monitors we get the
100 // same set of outputs to watch for on chain as we have now. Note that if we write
101 // tests that fully close channels and remove the monitors at some point this may break.
102 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
103 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
104 let mut deserialized_monitors = Vec::new();
105 for (_, old_monitor) in old_monitors.iter() {
106 let mut w = test_utils::TestVecWriter(Vec::new());
107 old_monitor.write_for_disk(&mut w).unwrap();
108 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
109 &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
110 deserialized_monitors.push(deserialized_monitor);
113 // Before using all the new monitors to check the watch outpoints, use the full set of
114 // them to ensure we can write and reload our ChannelManager.
116 let mut channel_monitors = HashMap::new();
117 for monitor in deserialized_monitors.iter_mut() {
118 channel_monitors.insert(monitor.get_funding_txo().unwrap(), monitor);
121 let mut w = test_utils::TestVecWriter(Vec::new());
122 self.node.write(&mut w).unwrap();
123 <(Sha256d, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
124 default_config: UserConfig::default(),
125 keys_manager: self.keys_manager.clone(),
126 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
127 monitor: self.chan_monitor,
128 tx_broadcaster: self.tx_broadcaster.clone(),
129 logger: Arc::new(test_utils::TestLogger::new()),
130 channel_monitors: &mut channel_monitors,
134 let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
135 let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), feeest);
136 for deserialized_monitor in deserialized_monitors.drain(..) {
137 if let Err(_) = channel_monitor.add_update_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
141 if *chain_watch != *self.chain_monitor {
148 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) {
149 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
152 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) {
153 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);
154 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
155 (announcement, as_update, bs_update, channel_id, tx)
158 macro_rules! get_revoke_commit_msgs {
159 ($node: expr, $node_id: expr) => {
161 let events = $node.node.get_and_clear_pending_msg_events();
162 assert_eq!(events.len(), 2);
164 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
165 assert_eq!(*node_id, $node_id);
168 _ => panic!("Unexpected event"),
170 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
171 assert_eq!(*node_id, $node_id);
172 assert!(updates.update_add_htlcs.is_empty());
173 assert!(updates.update_fulfill_htlcs.is_empty());
174 assert!(updates.update_fail_htlcs.is_empty());
175 assert!(updates.update_fail_malformed_htlcs.is_empty());
176 assert!(updates.update_fee.is_none());
177 updates.commitment_signed.clone()
179 _ => panic!("Unexpected event"),
185 macro_rules! get_event_msg {
186 ($node: expr, $event_type: path, $node_id: expr) => {
188 let events = $node.node.get_and_clear_pending_msg_events();
189 assert_eq!(events.len(), 1);
191 $event_type { ref node_id, ref msg } => {
192 assert_eq!(*node_id, $node_id);
195 _ => panic!("Unexpected event"),
201 macro_rules! get_htlc_update_msgs {
202 ($node: expr, $node_id: expr) => {
204 let events = $node.node.get_and_clear_pending_msg_events();
205 assert_eq!(events.len(), 1);
207 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
208 assert_eq!(*node_id, $node_id);
211 _ => panic!("Unexpected event"),
217 macro_rules! get_feerate {
218 ($node: expr, $channel_id: expr) => {
220 let chan_lock = $node.node.channel_state.lock().unwrap();
221 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
227 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) {
228 let chan_id = *node.network_chan_count.borrow();
230 let events = node.node.get_and_clear_pending_events();
231 assert_eq!(events.len(), 1);
233 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
234 assert_eq!(*channel_value_satoshis, expected_chan_value);
235 assert_eq!(user_channel_id, expected_user_chan_id);
237 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
238 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
240 let funding_outpoint = OutPoint::new(tx.txid(), 0);
241 (*temporary_channel_id, tx, funding_outpoint)
243 _ => panic!("Unexpected event"),
247 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 {
248 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
249 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()));
250 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()));
252 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
255 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
256 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
257 assert_eq!(added_monitors.len(), 1);
258 assert_eq!(added_monitors[0].0, funding_output);
259 added_monitors.clear();
262 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()));
264 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
265 assert_eq!(added_monitors.len(), 1);
266 assert_eq!(added_monitors[0].0, funding_output);
267 added_monitors.clear();
270 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()));
272 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
273 assert_eq!(added_monitors.len(), 1);
274 assert_eq!(added_monitors[0].0, funding_output);
275 added_monitors.clear();
278 let events_4 = node_a.node.get_and_clear_pending_events();
279 assert_eq!(events_4.len(), 1);
281 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
282 assert_eq!(user_channel_id, 42);
283 assert_eq!(*funding_txo, funding_output);
285 _ => panic!("Unexpected event"),
291 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) {
292 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
293 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()));
296 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]) {
298 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
299 assert_eq!(events_6.len(), 2);
300 ((match events_6[0] {
301 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
302 channel_id = msg.channel_id.clone();
303 assert_eq!(*node_id, node_recv.node.get_our_node_id());
306 _ => panic!("Unexpected event"),
307 }, match events_6[1] {
308 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
309 assert_eq!(*node_id, node_recv.node.get_our_node_id());
312 _ => panic!("Unexpected event"),
316 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]) {
317 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
318 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
319 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
322 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) {
323 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
324 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
328 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) {
329 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
330 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
331 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
333 let events_7 = node_b.node.get_and_clear_pending_msg_events();
334 assert_eq!(events_7.len(), 1);
335 let (announcement, bs_update) = match events_7[0] {
336 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
339 _ => panic!("Unexpected event"),
342 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
343 let events_8 = node_a.node.get_and_clear_pending_msg_events();
344 assert_eq!(events_8.len(), 1);
345 let as_update = match events_8[0] {
346 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
347 assert!(*announcement == *msg);
348 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
349 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
352 _ => panic!("Unexpected event"),
355 *node_a.network_chan_count.borrow_mut() += 1;
357 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
360 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) {
361 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
364 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) {
365 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
367 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
368 node.router.handle_channel_update(&chan_announcement.1).unwrap();
369 node.router.handle_channel_update(&chan_announcement.2).unwrap();
371 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
374 macro_rules! check_spends {
375 ($tx: expr, $spends_tx: expr) => {
377 $tx.verify(|out_point| {
378 if out_point.txid == $spends_tx.txid() {
379 $spends_tx.output.get(out_point.vout as usize).cloned()
388 macro_rules! get_closing_signed_broadcast {
389 ($node: expr, $dest_pubkey: expr) => {
391 let events = $node.get_and_clear_pending_msg_events();
392 assert!(events.len() == 1 || events.len() == 2);
393 (match events[events.len() - 1] {
394 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
395 assert_eq!(msg.contents.flags & 2, 2);
398 _ => panic!("Unexpected event"),
399 }, if events.len() == 2 {
401 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
402 assert_eq!(*node_id, $dest_pubkey);
405 _ => panic!("Unexpected event"),
412 macro_rules! check_closed_broadcast {
413 ($node: expr, $with_error_msg: expr) => {{
414 let events = $node.node.get_and_clear_pending_msg_events();
415 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
417 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
418 assert_eq!(msg.contents.flags & 2, 2);
420 _ => panic!("Unexpected event"),
424 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
425 // TODO: Check node_id
428 _ => panic!("Unexpected event"),
434 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) {
435 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) };
436 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
439 node_a.close_channel(channel_id).unwrap();
440 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
442 let events_1 = node_b.get_and_clear_pending_msg_events();
443 assert!(events_1.len() >= 1);
444 let shutdown_b = match events_1[0] {
445 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
446 assert_eq!(node_id, &node_a.get_our_node_id());
449 _ => panic!("Unexpected event"),
452 let closing_signed_b = if !close_inbound_first {
453 assert_eq!(events_1.len(), 1);
456 Some(match events_1[1] {
457 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
458 assert_eq!(node_id, &node_a.get_our_node_id());
461 _ => panic!("Unexpected event"),
465 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
466 let (as_update, bs_update) = if close_inbound_first {
467 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
468 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
469 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
470 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
471 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
473 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
474 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
475 assert!(none_b.is_none());
476 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
477 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
478 (as_update, bs_update)
480 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
482 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
483 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
484 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
485 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
487 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
488 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
489 assert!(none_a.is_none());
490 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
491 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
492 (as_update, bs_update)
494 assert_eq!(tx_a, tx_b);
495 check_spends!(tx_a, funding_tx);
497 (as_update, bs_update, tx_a)
500 pub struct SendEvent {
501 pub node_id: PublicKey,
502 pub msgs: Vec<msgs::UpdateAddHTLC>,
503 pub commitment_msg: msgs::CommitmentSigned,
506 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
507 assert!(updates.update_fulfill_htlcs.is_empty());
508 assert!(updates.update_fail_htlcs.is_empty());
509 assert!(updates.update_fail_malformed_htlcs.is_empty());
510 assert!(updates.update_fee.is_none());
511 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
514 pub fn from_event(event: MessageSendEvent) -> SendEvent {
516 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
517 _ => panic!("Unexpected event type!"),
521 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
522 let mut events = node.node.get_and_clear_pending_msg_events();
523 assert_eq!(events.len(), 1);
524 SendEvent::from_event(events.pop().unwrap())
528 macro_rules! check_added_monitors {
529 ($node: expr, $count: expr) => {
531 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
532 assert_eq!(added_monitors.len(), $count);
533 added_monitors.clear();
538 macro_rules! commitment_signed_dance {
539 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
541 check_added_monitors!($node_a, 0);
542 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
543 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
544 check_added_monitors!($node_a, 1);
545 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
548 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
550 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
551 check_added_monitors!($node_b, 0);
552 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
553 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
554 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
555 check_added_monitors!($node_b, 1);
556 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
557 let (bs_revoke_and_ack, extra_msg_option) = {
558 let events = $node_b.node.get_and_clear_pending_msg_events();
559 assert!(events.len() <= 2);
561 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
562 assert_eq!(*node_id, $node_a.node.get_our_node_id());
565 _ => panic!("Unexpected event"),
566 }, events.get(1).map(|e| e.clone()))
568 check_added_monitors!($node_b, 1);
570 assert!($node_a.node.get_and_clear_pending_events().is_empty());
571 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
573 (extra_msg_option, bs_revoke_and_ack)
576 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
578 check_added_monitors!($node_a, 0);
579 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
580 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
581 check_added_monitors!($node_a, 1);
582 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
583 assert!(extra_msg_option.is_none());
587 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
589 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
590 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
591 check_added_monitors!($node_a, 1);
595 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
597 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
600 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
602 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
604 expect_pending_htlcs_forwardable!($node_a);
605 check_added_monitors!($node_a, 1);
607 let channel_state = $node_a.node.channel_state.lock().unwrap();
608 assert_eq!(channel_state.pending_msg_events.len(), 1);
609 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
610 assert_ne!(*node_id, $node_b.node.get_our_node_id());
611 } else { panic!("Unexpected event"); }
613 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
619 macro_rules! get_payment_preimage_hash {
622 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
623 *$node.network_payment_count.borrow_mut() += 1;
624 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
625 (payment_preimage, payment_hash)
630 macro_rules! expect_pending_htlcs_forwardable {
632 let events = $node.node.get_and_clear_pending_events();
633 assert_eq!(events.len(), 1);
635 Event::PendingHTLCsForwardable { .. } => { },
636 _ => panic!("Unexpected event"),
638 $node.node.process_pending_htlc_forwards();
642 macro_rules! expect_payment_received {
643 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
644 let events = $node.node.get_and_clear_pending_events();
645 assert_eq!(events.len(), 1);
647 Event::PaymentReceived { ref payment_hash, amt } => {
648 assert_eq!($expected_payment_hash, *payment_hash);
649 assert_eq!($expected_recv_value, amt);
651 _ => panic!("Unexpected event"),
656 macro_rules! expect_payment_sent {
657 ($node: expr, $expected_payment_preimage: expr) => {
658 let events = $node.node.get_and_clear_pending_events();
659 assert_eq!(events.len(), 1);
661 Event::PaymentSent { ref payment_preimage } => {
662 assert_eq!($expected_payment_preimage, *payment_preimage);
664 _ => panic!("Unexpected event"),
669 macro_rules! expect_payment_failed {
670 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr) => {
671 let events = $node.node.get_and_clear_pending_events();
672 assert_eq!(events.len(), 1);
674 Event::PaymentFailed { ref payment_hash, rejected_by_dest, .. } => {
675 assert_eq!(*payment_hash, $expected_payment_hash);
676 assert_eq!(rejected_by_dest, $rejected_by_dest);
678 _ => panic!("Unexpected event"),
683 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) {
684 let mut payment_event = {
685 origin_node.node.send_payment(route, our_payment_hash).unwrap();
686 check_added_monitors!(origin_node, 1);
688 let mut events = origin_node.node.get_and_clear_pending_msg_events();
689 assert_eq!(events.len(), 1);
690 SendEvent::from_event(events.remove(0))
692 let mut prev_node = origin_node;
694 for (idx, &node) in expected_route.iter().enumerate() {
695 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
697 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
698 check_added_monitors!(node, 0);
699 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
701 expect_pending_htlcs_forwardable!(node);
703 if idx == expected_route.len() - 1 {
704 let events_2 = node.node.get_and_clear_pending_events();
705 assert_eq!(events_2.len(), 1);
707 Event::PaymentReceived { ref payment_hash, amt } => {
708 assert_eq!(our_payment_hash, *payment_hash);
709 assert_eq!(amt, recv_value);
711 _ => panic!("Unexpected event"),
714 let mut events_2 = node.node.get_and_clear_pending_msg_events();
715 assert_eq!(events_2.len(), 1);
716 check_added_monitors!(node, 1);
717 payment_event = SendEvent::from_event(events_2.remove(0));
718 assert_eq!(payment_event.msgs.len(), 1);
725 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) {
726 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
727 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
728 (our_payment_preimage, our_payment_hash)
731 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) {
732 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
733 check_added_monitors!(expected_route.last().unwrap(), 1);
735 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
736 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
737 macro_rules! get_next_msgs {
740 let events = $node.node.get_and_clear_pending_msg_events();
741 assert_eq!(events.len(), 1);
743 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 } } => {
744 assert!(update_add_htlcs.is_empty());
745 assert_eq!(update_fulfill_htlcs.len(), 1);
746 assert!(update_fail_htlcs.is_empty());
747 assert!(update_fail_malformed_htlcs.is_empty());
748 assert!(update_fee.is_none());
749 expected_next_node = node_id.clone();
750 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
752 _ => panic!("Unexpected event"),
758 macro_rules! last_update_fulfill_dance {
759 ($node: expr, $prev_node: expr) => {
761 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
762 check_added_monitors!($node, 0);
763 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
764 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
768 macro_rules! mid_update_fulfill_dance {
769 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
771 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
772 check_added_monitors!($node, 1);
773 let new_next_msgs = if $new_msgs {
774 get_next_msgs!($node)
776 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
779 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
780 next_msgs = new_next_msgs;
785 let mut prev_node = expected_route.last().unwrap();
786 for (idx, node) in expected_route.iter().rev().enumerate() {
787 assert_eq!(expected_next_node, node.node.get_our_node_id());
788 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
789 if next_msgs.is_some() {
790 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
791 } else if update_next_msgs {
792 next_msgs = get_next_msgs!(node);
794 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
796 if !skip_last && idx == expected_route.len() - 1 {
797 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
804 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
805 expect_payment_sent!(origin_node, our_payment_preimage);
809 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) {
810 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
813 pub const TEST_FINAL_CLTV: u32 = 32;
815 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
816 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();
817 assert_eq!(route.hops.len(), expected_route.len());
818 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
819 assert_eq!(hop.pubkey, node.node.get_our_node_id());
822 send_along_route(origin_node, route, expected_route, recv_value)
825 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
826 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();
827 assert_eq!(route.hops.len(), expected_route.len());
828 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
829 assert_eq!(hop.pubkey, node.node.get_our_node_id());
832 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
834 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
836 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
837 _ => panic!("Unknown error variants"),
841 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
842 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
843 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
846 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) {
847 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
848 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
849 check_added_monitors!(expected_route.last().unwrap(), 1);
851 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
852 macro_rules! update_fail_dance {
853 ($node: expr, $prev_node: expr, $last_node: expr) => {
855 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
856 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
857 if skip_last && $last_node {
858 expect_pending_htlcs_forwardable!($node);
864 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
865 let mut prev_node = expected_route.last().unwrap();
866 for (idx, node) in expected_route.iter().rev().enumerate() {
867 assert_eq!(expected_next_node, node.node.get_our_node_id());
868 if next_msgs.is_some() {
869 // We may be the "last node" for the purpose of the commitment dance if we're
870 // skipping the last node (implying it is disconnected) and we're the
871 // second-to-last node!
872 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
875 let events = node.node.get_and_clear_pending_msg_events();
876 if !skip_last || idx != expected_route.len() - 1 {
877 assert_eq!(events.len(), 1);
879 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 } } => {
880 assert!(update_add_htlcs.is_empty());
881 assert!(update_fulfill_htlcs.is_empty());
882 assert_eq!(update_fail_htlcs.len(), 1);
883 assert!(update_fail_malformed_htlcs.is_empty());
884 assert!(update_fee.is_none());
885 expected_next_node = node_id.clone();
886 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
888 _ => panic!("Unexpected event"),
891 assert!(events.is_empty());
893 if !skip_last && idx == expected_route.len() - 1 {
894 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
901 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
903 let events = origin_node.node.get_and_clear_pending_events();
904 assert_eq!(events.len(), 1);
906 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
907 assert_eq!(payment_hash, our_payment_hash);
908 assert!(rejected_by_dest);
910 _ => panic!("Unexpected event"),
915 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
916 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
919 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
920 let mut chan_mon_cfgs = Vec::new();
921 for i in 0..node_count {
922 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())};
923 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster });
929 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
930 let mut nodes = Vec::new();
931 let mut rng = thread_rng();
933 for i in 0..node_count {
934 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
935 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
936 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
937 let mut seed = [0; 32];
938 rng.fill_bytes(&mut seed);
939 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>));
940 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &chanmon_cfgs[i].tx_broadcaster, logger.clone(), fee_estimator.clone());
941 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator, chan_monitor, keys_manager, node_seed: seed });
947 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>> {
948 let mut chanmgrs = Vec::new();
949 for i in 0..node_count {
950 let mut default_config = UserConfig::default();
951 default_config.channel_options.announced_channel = true;
952 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
953 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator.clone(), &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger.clone(), cfgs[i].keys_manager.clone(), if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
960 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>>) -> Vec<Node<'a, 'b, 'c>> {
961 let secp_ctx = Secp256k1::new();
962 let mut nodes = Vec::new();
963 let chan_count = Rc::new(RefCell::new(0));
964 let payment_count = Rc::new(RefCell::new(0));
966 for i in 0..node_count {
967 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
968 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
969 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
970 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>);
971 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
972 tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
973 keys_manager: cfgs[i].keys_manager.clone(), node: &chan_mgrs[i], router,
974 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
975 network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
982 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
983 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
986 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
987 /// Tests that the given node has broadcast transactions for the given Channel
989 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
990 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
991 /// broadcast and the revoked outputs were claimed.
993 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
994 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
996 /// All broadcast transactions must be accounted for in one of the above three types of we'll
998 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> {
999 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1000 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1002 let mut res = Vec::with_capacity(2);
1003 node_txn.retain(|tx| {
1004 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1005 check_spends!(tx, chan.3.clone());
1006 if commitment_tx.is_none() {
1007 res.push(tx.clone());
1012 if let Some(explicit_tx) = commitment_tx {
1013 res.push(explicit_tx.clone());
1016 assert_eq!(res.len(), 1);
1018 if has_htlc_tx != HTLCType::NONE {
1019 node_txn.retain(|tx| {
1020 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1021 check_spends!(tx, res[0].clone());
1022 if has_htlc_tx == HTLCType::TIMEOUT {
1023 assert!(tx.lock_time != 0);
1025 assert!(tx.lock_time == 0);
1027 res.push(tx.clone());
1031 assert!(res.len() == 2 || res.len() == 3);
1033 assert_eq!(res[1], res[2]);
1037 assert!(node_txn.is_empty());
1041 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1042 /// HTLC transaction.
1043 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1044 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1045 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
1046 // but sometimes not as feerate is too-low
1047 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
1048 node_txn.retain(|tx| {
1049 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1050 check_spends!(tx, revoked_tx);
1054 node_txn.retain(|tx| {
1055 check_spends!(tx, commitment_revoked_tx);
1058 assert!(node_txn.is_empty());
1061 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1062 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1064 assert!(node_txn.len() >= 1);
1065 assert_eq!(node_txn[0].input.len(), 1);
1066 let mut found_prev = false;
1068 for tx in prev_txn {
1069 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1070 check_spends!(node_txn[0], tx.clone());
1071 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1072 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1078 assert!(found_prev);
1080 let mut res = Vec::new();
1081 mem::swap(&mut *node_txn, &mut res);
1085 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1086 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1087 assert_eq!(events_1.len(), 1);
1088 let as_update = match events_1[0] {
1089 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1092 _ => panic!("Unexpected event"),
1095 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1096 assert_eq!(events_2.len(), 1);
1097 let bs_update = match events_2[0] {
1098 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1101 _ => panic!("Unexpected event"),
1105 node.router.handle_channel_update(&as_update).unwrap();
1106 node.router.handle_channel_update(&bs_update).unwrap();
1110 macro_rules! get_channel_value_stat {
1111 ($node: expr, $channel_id: expr) => {{
1112 let chan_lock = $node.node.channel_state.lock().unwrap();
1113 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1114 chan.get_value_stat()
1118 macro_rules! get_chan_reestablish_msgs {
1119 ($src_node: expr, $dst_node: expr) => {
1121 let mut res = Vec::with_capacity(1);
1122 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1123 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1124 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1125 res.push(msg.clone());
1127 panic!("Unexpected event")
1135 macro_rules! handle_chan_reestablish_msgs {
1136 ($src_node: expr, $dst_node: expr) => {
1138 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1140 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1142 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1148 let mut revoke_and_ack = None;
1149 let mut commitment_update = None;
1150 let order = if let Some(ev) = msg_events.get(idx) {
1153 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1154 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1155 revoke_and_ack = Some(msg.clone());
1156 RAACommitmentOrder::RevokeAndACKFirst
1158 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1159 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1160 commitment_update = Some(updates.clone());
1161 RAACommitmentOrder::CommitmentFirst
1163 _ => panic!("Unexpected event"),
1166 RAACommitmentOrder::CommitmentFirst
1169 if let Some(ev) = msg_events.get(idx) {
1171 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1172 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1173 assert!(revoke_and_ack.is_none());
1174 revoke_and_ack = Some(msg.clone());
1176 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1177 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1178 assert!(commitment_update.is_none());
1179 commitment_update = Some(updates.clone());
1181 _ => panic!("Unexpected event"),
1185 (funding_locked, revoke_and_ack, commitment_update, order)
1190 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1191 /// for claims/fails they are separated out.
1192 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)) {
1193 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1194 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1195 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1196 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1198 if send_funding_locked.0 {
1199 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1201 for reestablish in reestablish_1.iter() {
1202 assert_eq!(reestablish.next_remote_commitment_number, 0);
1205 if send_funding_locked.1 {
1206 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1208 for reestablish in reestablish_2.iter() {
1209 assert_eq!(reestablish.next_remote_commitment_number, 0);
1212 if send_funding_locked.0 || send_funding_locked.1 {
1213 // If we expect any funding_locked's, both sides better have set
1214 // next_local_commitment_number to 1
1215 for reestablish in reestablish_1.iter() {
1216 assert_eq!(reestablish.next_local_commitment_number, 1);
1218 for reestablish in reestablish_2.iter() {
1219 assert_eq!(reestablish.next_local_commitment_number, 1);
1223 let mut resp_1 = Vec::new();
1224 for msg in reestablish_1 {
1225 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1226 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1228 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1229 check_added_monitors!(node_b, 1);
1231 check_added_monitors!(node_b, 0);
1234 let mut resp_2 = Vec::new();
1235 for msg in reestablish_2 {
1236 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1237 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1239 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1240 check_added_monitors!(node_a, 1);
1242 check_added_monitors!(node_a, 0);
1245 // We don't yet support both needing updates, as that would require a different commitment dance:
1246 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1247 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1249 for chan_msgs in resp_1.drain(..) {
1250 if send_funding_locked.0 {
1251 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1252 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1253 if !announcement_event.is_empty() {
1254 assert_eq!(announcement_event.len(), 1);
1255 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1256 //TODO: Test announcement_sigs re-sending
1257 } else { panic!("Unexpected event!"); }
1260 assert!(chan_msgs.0.is_none());
1263 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1264 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1265 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1266 check_added_monitors!(node_a, 1);
1268 assert!(chan_msgs.1.is_none());
1270 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1271 let commitment_update = chan_msgs.2.unwrap();
1272 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1273 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1275 assert!(commitment_update.update_add_htlcs.is_empty());
1277 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1278 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1279 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1280 for update_add in commitment_update.update_add_htlcs {
1281 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1283 for update_fulfill in commitment_update.update_fulfill_htlcs {
1284 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1286 for update_fail in commitment_update.update_fail_htlcs {
1287 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1290 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1291 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1293 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1294 check_added_monitors!(node_a, 1);
1295 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1296 // No commitment_signed so get_event_msg's assert(len == 1) passes
1297 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1298 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1299 check_added_monitors!(node_b, 1);
1302 assert!(chan_msgs.2.is_none());
1306 for chan_msgs in resp_2.drain(..) {
1307 if send_funding_locked.1 {
1308 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1309 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1310 if !announcement_event.is_empty() {
1311 assert_eq!(announcement_event.len(), 1);
1312 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1313 //TODO: Test announcement_sigs re-sending
1314 } else { panic!("Unexpected event!"); }
1317 assert!(chan_msgs.0.is_none());
1320 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1321 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1322 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1323 check_added_monitors!(node_b, 1);
1325 assert!(chan_msgs.1.is_none());
1327 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1328 let commitment_update = chan_msgs.2.unwrap();
1329 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1330 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1332 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1333 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1334 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1335 for update_add in commitment_update.update_add_htlcs {
1336 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1338 for update_fulfill in commitment_update.update_fulfill_htlcs {
1339 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1341 for update_fail in commitment_update.update_fail_htlcs {
1342 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1345 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1346 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1348 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1349 check_added_monitors!(node_b, 1);
1350 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1351 // No commitment_signed so get_event_msg's assert(len == 1) passes
1352 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1353 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1354 check_added_monitors!(node_a, 1);
1357 assert!(chan_msgs.2.is_none());