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());
64 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
65 pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
66 pub fee_estimator: Arc<test_utils::TestFeeEstimator>,
67 pub chan_monitor: test_utils::TestChannelMonitor,
68 pub keys_manager: Arc<test_utils::TestKeysInterface>,
69 pub logger: Arc<test_utils::TestLogger>,
70 pub node_seed: [u8; 32],
73 pub struct Node<'a, 'b: 'a> {
74 pub block_notifier: chaininterface::BlockNotifierRef<'b>,
75 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
76 pub tx_broadcaster: Arc<test_utils::TestBroadcaster>,
77 pub chan_monitor: &'b test_utils::TestChannelMonitor,
78 pub keys_manager: Arc<test_utils::TestKeysInterface>,
79 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor>,
81 pub node_seed: [u8; 32],
82 pub network_payment_count: Rc<RefCell<u8>>,
83 pub network_chan_count: Rc<RefCell<u32>>,
84 pub logger: Arc<test_utils::TestLogger>
87 impl<'a, 'b> Drop for Node<'a, 'b> {
89 if !::std::thread::panicking() {
90 // Check that we processed all pending events
91 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
92 assert!(self.node.get_and_clear_pending_events().is_empty());
93 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
95 // Check that if we serialize and then deserialize all our channel monitors we get the
96 // same set of outputs to watch for on chain as we have now. Note that if we write
97 // tests that fully close channels and remove the monitors at some point this may break.
98 let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
99 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
100 let mut deserialized_monitors = Vec::new();
101 for (_, old_monitor) in old_monitors.iter() {
102 let mut w = test_utils::TestVecWriter(Vec::new());
103 old_monitor.write_for_disk(&mut w).unwrap();
104 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
105 &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
106 deserialized_monitors.push(deserialized_monitor);
109 // Before using all the new monitors to check the watch outpoints, use the full set of
110 // them to ensure we can write and reload our ChannelManager.
112 let mut channel_monitors = HashMap::new();
113 for monitor in deserialized_monitors.iter_mut() {
114 channel_monitors.insert(monitor.get_funding_txo().unwrap(), monitor);
117 let mut w = test_utils::TestVecWriter(Vec::new());
118 self.node.write(&mut w).unwrap();
119 <(Sha256d, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
120 default_config: UserConfig::default(),
121 keys_manager: self.keys_manager.clone(),
122 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
123 monitor: self.chan_monitor,
124 tx_broadcaster: self.tx_broadcaster.clone(),
125 logger: Arc::new(test_utils::TestLogger::new()),
126 channel_monitors: &mut channel_monitors,
130 let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
131 let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), feeest);
132 for deserialized_monitor in deserialized_monitors.drain(..) {
133 if let Err(_) = channel_monitor.add_update_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
137 if *chain_watch != *self.chain_monitor {
144 pub fn create_chan_between_nodes<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
145 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
148 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
149 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);
150 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
151 (announcement, as_update, bs_update, channel_id, tx)
154 macro_rules! get_revoke_commit_msgs {
155 ($node: expr, $node_id: expr) => {
157 let events = $node.node.get_and_clear_pending_msg_events();
158 assert_eq!(events.len(), 2);
160 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
161 assert_eq!(*node_id, $node_id);
164 _ => panic!("Unexpected event"),
166 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
167 assert_eq!(*node_id, $node_id);
168 assert!(updates.update_add_htlcs.is_empty());
169 assert!(updates.update_fulfill_htlcs.is_empty());
170 assert!(updates.update_fail_htlcs.is_empty());
171 assert!(updates.update_fail_malformed_htlcs.is_empty());
172 assert!(updates.update_fee.is_none());
173 updates.commitment_signed.clone()
175 _ => panic!("Unexpected event"),
181 macro_rules! get_event_msg {
182 ($node: expr, $event_type: path, $node_id: expr) => {
184 let events = $node.node.get_and_clear_pending_msg_events();
185 assert_eq!(events.len(), 1);
187 $event_type { ref node_id, ref msg } => {
188 assert_eq!(*node_id, $node_id);
191 _ => panic!("Unexpected event"),
197 macro_rules! get_htlc_update_msgs {
198 ($node: expr, $node_id: expr) => {
200 let events = $node.node.get_and_clear_pending_msg_events();
201 assert_eq!(events.len(), 1);
203 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
204 assert_eq!(*node_id, $node_id);
207 _ => panic!("Unexpected event"),
213 macro_rules! get_feerate {
214 ($node: expr, $channel_id: expr) => {
216 let chan_lock = $node.node.channel_state.lock().unwrap();
217 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
223 pub fn create_funding_transaction<'a, 'b>(node: &Node<'a, 'b>, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
224 let chan_id = *node.network_chan_count.borrow();
226 let events = node.node.get_and_clear_pending_events();
227 assert_eq!(events.len(), 1);
229 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
230 assert_eq!(*channel_value_satoshis, expected_chan_value);
231 assert_eq!(user_channel_id, expected_user_chan_id);
233 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
234 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
236 let funding_outpoint = OutPoint::new(tx.txid(), 0);
237 (*temporary_channel_id, tx, funding_outpoint)
239 _ => panic!("Unexpected event"),
243 pub fn create_chan_between_nodes_with_value_init<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> Transaction {
244 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
245 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()));
246 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()));
248 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
251 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
252 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
253 assert_eq!(added_monitors.len(), 1);
254 assert_eq!(added_monitors[0].0, funding_output);
255 added_monitors.clear();
258 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()));
260 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
261 assert_eq!(added_monitors.len(), 1);
262 assert_eq!(added_monitors[0].0, funding_output);
263 added_monitors.clear();
266 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()));
268 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
269 assert_eq!(added_monitors.len(), 1);
270 assert_eq!(added_monitors[0].0, funding_output);
271 added_monitors.clear();
274 let events_4 = node_a.node.get_and_clear_pending_events();
275 assert_eq!(events_4.len(), 1);
277 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
278 assert_eq!(user_channel_id, 42);
279 assert_eq!(*funding_txo, funding_output);
281 _ => panic!("Unexpected event"),
287 pub fn create_chan_between_nodes_with_value_confirm_first<'a, 'b, 'c>(node_recv: &'a Node<'a, 'b>, node_conf: &'a Node<'a, 'b>, tx: &Transaction) {
288 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
289 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()));
292 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b>(node_recv: &Node<'a, 'b>, node_conf: &Node<'a, 'b>) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
294 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
295 assert_eq!(events_6.len(), 2);
296 ((match events_6[0] {
297 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
298 channel_id = msg.channel_id.clone();
299 assert_eq!(*node_id, node_recv.node.get_our_node_id());
302 _ => panic!("Unexpected event"),
303 }, match events_6[1] {
304 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
305 assert_eq!(*node_id, node_recv.node.get_our_node_id());
308 _ => panic!("Unexpected event"),
312 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
313 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
314 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
315 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
318 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c>(node_a: &'a Node<'b, 'c>, node_b: &'a Node<'b, 'c>, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
319 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
320 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
324 pub fn create_chan_between_nodes_with_value_b<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
325 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
326 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
327 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
329 let events_7 = node_b.node.get_and_clear_pending_msg_events();
330 assert_eq!(events_7.len(), 1);
331 let (announcement, bs_update) = match events_7[0] {
332 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
335 _ => panic!("Unexpected event"),
338 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
339 let events_8 = node_a.node.get_and_clear_pending_msg_events();
340 assert_eq!(events_8.len(), 1);
341 let as_update = match events_8[0] {
342 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
343 assert!(*announcement == *msg);
344 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
345 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
348 _ => panic!("Unexpected event"),
351 *node_a.network_chan_count.borrow_mut() += 1;
353 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
356 pub fn create_announced_chan_between_nodes<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
357 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
360 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c>(nodes: &'a Vec<Node<'b, 'c>>, a: usize, b: usize, channel_value: u64, push_msat: u64, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
361 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
363 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
364 node.router.handle_channel_update(&chan_announcement.1).unwrap();
365 node.router.handle_channel_update(&chan_announcement.2).unwrap();
367 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
370 macro_rules! check_spends {
371 ($tx: expr, $spends_tx: expr) => {
373 $tx.verify(|out_point| {
374 if out_point.txid == $spends_tx.txid() {
375 $spends_tx.output.get(out_point.vout as usize).cloned()
384 macro_rules! get_closing_signed_broadcast {
385 ($node: expr, $dest_pubkey: expr) => {
387 let events = $node.get_and_clear_pending_msg_events();
388 assert!(events.len() == 1 || events.len() == 2);
389 (match events[events.len() - 1] {
390 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
391 assert_eq!(msg.contents.flags & 2, 2);
394 _ => panic!("Unexpected event"),
395 }, if events.len() == 2 {
397 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
398 assert_eq!(*node_id, $dest_pubkey);
401 _ => panic!("Unexpected event"),
408 macro_rules! check_closed_broadcast {
409 ($node: expr, $with_error_msg: expr) => {{
410 let events = $node.node.get_and_clear_pending_msg_events();
411 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
413 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
414 assert_eq!(msg.contents.flags & 2, 2);
416 _ => panic!("Unexpected event"),
420 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
421 // TODO: Check node_id
424 _ => panic!("Unexpected event"),
430 pub fn close_channel<'a, 'b>(outbound_node: &Node<'a, 'b>, inbound_node: &Node<'a, 'b>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
431 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) };
432 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
435 node_a.close_channel(channel_id).unwrap();
436 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
438 let events_1 = node_b.get_and_clear_pending_msg_events();
439 assert!(events_1.len() >= 1);
440 let shutdown_b = match events_1[0] {
441 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
442 assert_eq!(node_id, &node_a.get_our_node_id());
445 _ => panic!("Unexpected event"),
448 let closing_signed_b = if !close_inbound_first {
449 assert_eq!(events_1.len(), 1);
452 Some(match events_1[1] {
453 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
454 assert_eq!(node_id, &node_a.get_our_node_id());
457 _ => panic!("Unexpected event"),
461 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
462 let (as_update, bs_update) = if close_inbound_first {
463 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
464 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
465 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
466 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
467 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
469 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
470 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
471 assert!(none_b.is_none());
472 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
473 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
474 (as_update, bs_update)
476 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
478 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
479 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
480 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
481 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
483 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
484 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
485 assert!(none_a.is_none());
486 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
487 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
488 (as_update, bs_update)
490 assert_eq!(tx_a, tx_b);
491 check_spends!(tx_a, funding_tx);
493 (as_update, bs_update, tx_a)
496 pub struct SendEvent {
497 pub node_id: PublicKey,
498 pub msgs: Vec<msgs::UpdateAddHTLC>,
499 pub commitment_msg: msgs::CommitmentSigned,
502 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
503 assert!(updates.update_fulfill_htlcs.is_empty());
504 assert!(updates.update_fail_htlcs.is_empty());
505 assert!(updates.update_fail_malformed_htlcs.is_empty());
506 assert!(updates.update_fee.is_none());
507 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
510 pub fn from_event(event: MessageSendEvent) -> SendEvent {
512 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
513 _ => panic!("Unexpected event type!"),
517 pub fn from_node<'a, 'b>(node: &Node<'a, 'b>) -> SendEvent {
518 let mut events = node.node.get_and_clear_pending_msg_events();
519 assert_eq!(events.len(), 1);
520 SendEvent::from_event(events.pop().unwrap())
524 macro_rules! check_added_monitors {
525 ($node: expr, $count: expr) => {
527 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
528 assert_eq!(added_monitors.len(), $count);
529 added_monitors.clear();
534 macro_rules! commitment_signed_dance {
535 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
537 check_added_monitors!($node_a, 0);
538 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
539 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
540 check_added_monitors!($node_a, 1);
541 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
544 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
546 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
547 check_added_monitors!($node_b, 0);
548 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
549 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
550 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
551 check_added_monitors!($node_b, 1);
552 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
553 let (bs_revoke_and_ack, extra_msg_option) = {
554 let events = $node_b.node.get_and_clear_pending_msg_events();
555 assert!(events.len() <= 2);
557 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
558 assert_eq!(*node_id, $node_a.node.get_our_node_id());
561 _ => panic!("Unexpected event"),
562 }, events.get(1).map(|e| e.clone()))
564 check_added_monitors!($node_b, 1);
566 assert!($node_a.node.get_and_clear_pending_events().is_empty());
567 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
569 (extra_msg_option, bs_revoke_and_ack)
572 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
574 check_added_monitors!($node_a, 0);
575 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
576 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
577 check_added_monitors!($node_a, 1);
578 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
579 assert!(extra_msg_option.is_none());
583 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
585 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
586 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
587 check_added_monitors!($node_a, 1);
591 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
593 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
596 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
598 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
600 expect_pending_htlcs_forwardable!($node_a);
601 check_added_monitors!($node_a, 1);
603 let channel_state = $node_a.node.channel_state.lock().unwrap();
604 assert_eq!(channel_state.pending_msg_events.len(), 1);
605 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
606 assert_ne!(*node_id, $node_b.node.get_our_node_id());
607 } else { panic!("Unexpected event"); }
609 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
615 macro_rules! get_payment_preimage_hash {
618 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
619 *$node.network_payment_count.borrow_mut() += 1;
620 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
621 (payment_preimage, payment_hash)
626 macro_rules! expect_pending_htlcs_forwardable {
628 let events = $node.node.get_and_clear_pending_events();
629 assert_eq!(events.len(), 1);
631 Event::PendingHTLCsForwardable { .. } => { },
632 _ => panic!("Unexpected event"),
634 $node.node.process_pending_htlc_forwards();
638 macro_rules! expect_payment_received {
639 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
640 let events = $node.node.get_and_clear_pending_events();
641 assert_eq!(events.len(), 1);
643 Event::PaymentReceived { ref payment_hash, amt } => {
644 assert_eq!($expected_payment_hash, *payment_hash);
645 assert_eq!($expected_recv_value, amt);
647 _ => panic!("Unexpected event"),
652 macro_rules! expect_payment_sent {
653 ($node: expr, $expected_payment_preimage: expr) => {
654 let events = $node.node.get_and_clear_pending_events();
655 assert_eq!(events.len(), 1);
657 Event::PaymentSent { ref payment_preimage } => {
658 assert_eq!($expected_payment_preimage, *payment_preimage);
660 _ => panic!("Unexpected event"),
665 pub fn send_along_route_with_hash<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64, our_payment_hash: PaymentHash) {
666 let mut payment_event = {
667 origin_node.node.send_payment(route, our_payment_hash).unwrap();
668 check_added_monitors!(origin_node, 1);
670 let mut events = origin_node.node.get_and_clear_pending_msg_events();
671 assert_eq!(events.len(), 1);
672 SendEvent::from_event(events.remove(0))
674 let mut prev_node = origin_node;
676 for (idx, &node) in expected_route.iter().enumerate() {
677 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
679 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
680 check_added_monitors!(node, 0);
681 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
683 expect_pending_htlcs_forwardable!(node);
685 if idx == expected_route.len() - 1 {
686 let events_2 = node.node.get_and_clear_pending_events();
687 assert_eq!(events_2.len(), 1);
689 Event::PaymentReceived { ref payment_hash, amt } => {
690 assert_eq!(our_payment_hash, *payment_hash);
691 assert_eq!(amt, recv_value);
693 _ => panic!("Unexpected event"),
696 let mut events_2 = node.node.get_and_clear_pending_msg_events();
697 assert_eq!(events_2.len(), 1);
698 check_added_monitors!(node, 1);
699 payment_event = SendEvent::from_event(events_2.remove(0));
700 assert_eq!(payment_event.msgs.len(), 1);
707 pub fn send_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, route: Route, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
708 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
709 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
710 (our_payment_preimage, our_payment_hash)
713 pub fn claim_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_preimage: PaymentPreimage, expected_amount: u64) {
714 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
715 check_added_monitors!(expected_route.last().unwrap(), 1);
717 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
718 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
719 macro_rules! get_next_msgs {
722 let events = $node.node.get_and_clear_pending_msg_events();
723 assert_eq!(events.len(), 1);
725 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 } } => {
726 assert!(update_add_htlcs.is_empty());
727 assert_eq!(update_fulfill_htlcs.len(), 1);
728 assert!(update_fail_htlcs.is_empty());
729 assert!(update_fail_malformed_htlcs.is_empty());
730 assert!(update_fee.is_none());
731 expected_next_node = node_id.clone();
732 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
734 _ => panic!("Unexpected event"),
740 macro_rules! last_update_fulfill_dance {
741 ($node: expr, $prev_node: expr) => {
743 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
744 check_added_monitors!($node, 0);
745 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
746 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
750 macro_rules! mid_update_fulfill_dance {
751 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
753 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
754 check_added_monitors!($node, 1);
755 let new_next_msgs = if $new_msgs {
756 get_next_msgs!($node)
758 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
761 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
762 next_msgs = new_next_msgs;
767 let mut prev_node = expected_route.last().unwrap();
768 for (idx, node) in expected_route.iter().rev().enumerate() {
769 assert_eq!(expected_next_node, node.node.get_our_node_id());
770 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
771 if next_msgs.is_some() {
772 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
773 } else if update_next_msgs {
774 next_msgs = get_next_msgs!(node);
776 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
778 if !skip_last && idx == expected_route.len() - 1 {
779 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
786 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
787 expect_payment_sent!(origin_node, our_payment_preimage);
791 pub fn claim_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_preimage: PaymentPreimage, expected_amount: u64) {
792 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
795 pub const TEST_FINAL_CLTV: u32 = 32;
797 pub fn route_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
798 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();
799 assert_eq!(route.hops.len(), expected_route.len());
800 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
801 assert_eq!(hop.pubkey, node.node.get_our_node_id());
804 send_along_route(origin_node, route, expected_route, recv_value)
807 pub fn route_over_limit<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64) {
808 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();
809 assert_eq!(route.hops.len(), expected_route.len());
810 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
811 assert_eq!(hop.pubkey, node.node.get_our_node_id());
814 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
816 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
818 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
819 _ => panic!("Unknown error variants"),
823 pub fn send_payment<'a, 'b>(origin: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], recv_value: u64, expected_value: u64) {
824 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
825 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
828 pub fn fail_payment_along_route<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], skip_last: bool, our_payment_hash: PaymentHash) {
829 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
830 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
831 check_added_monitors!(expected_route.last().unwrap(), 1);
833 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
834 macro_rules! update_fail_dance {
835 ($node: expr, $prev_node: expr, $last_node: expr) => {
837 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
838 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
839 if skip_last && $last_node {
840 expect_pending_htlcs_forwardable!($node);
846 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
847 let mut prev_node = expected_route.last().unwrap();
848 for (idx, node) in expected_route.iter().rev().enumerate() {
849 assert_eq!(expected_next_node, node.node.get_our_node_id());
850 if next_msgs.is_some() {
851 // We may be the "last node" for the purpose of the commitment dance if we're
852 // skipping the last node (implying it is disconnected) and we're the
853 // second-to-last node!
854 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
857 let events = node.node.get_and_clear_pending_msg_events();
858 if !skip_last || idx != expected_route.len() - 1 {
859 assert_eq!(events.len(), 1);
861 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 } } => {
862 assert!(update_add_htlcs.is_empty());
863 assert!(update_fulfill_htlcs.is_empty());
864 assert_eq!(update_fail_htlcs.len(), 1);
865 assert!(update_fail_malformed_htlcs.is_empty());
866 assert!(update_fee.is_none());
867 expected_next_node = node_id.clone();
868 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
870 _ => panic!("Unexpected event"),
873 assert!(events.is_empty());
875 if !skip_last && idx == expected_route.len() - 1 {
876 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
883 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
885 let events = origin_node.node.get_and_clear_pending_events();
886 assert_eq!(events.len(), 1);
888 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
889 assert_eq!(payment_hash, our_payment_hash);
890 assert!(rejected_by_dest);
892 _ => panic!("Unexpected event"),
897 pub fn fail_payment<'a, 'b>(origin_node: &Node<'a, 'b>, expected_route: &[&Node<'a, 'b>], our_payment_hash: PaymentHash) {
898 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
901 pub fn create_node_cfgs(node_count: usize) -> Vec<NodeCfg> {
902 let mut nodes = Vec::new();
903 let mut rng = thread_rng();
905 for i in 0..node_count {
906 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
907 let fee_estimator = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
908 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
909 let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())});
910 let mut seed = [0; 32];
911 rng.fill_bytes(&mut seed);
912 let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>));
913 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), fee_estimator.clone());
914 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster, fee_estimator, chan_monitor, keys_manager, node_seed: seed });
920 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>> {
921 let mut chanmgrs = Vec::new();
922 for i in 0..node_count {
923 let mut default_config = UserConfig::default();
924 default_config.channel_options.announced_channel = true;
925 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
926 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator.clone(), &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster.clone(), 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();
933 pub fn create_network<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg>, chan_mgrs: &'b Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor>>) -> Vec<Node<'a, 'b>> {
934 let secp_ctx = Secp256k1::new();
935 let mut nodes = Vec::new();
936 let chan_count = Rc::new(RefCell::new(0));
937 let payment_count = Rc::new(RefCell::new(0));
939 for i in 0..node_count {
940 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
941 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
942 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
943 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>);
944 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
945 tx_broadcaster: cfgs[i].tx_broadcaster.clone(), chan_monitor: &cfgs[i].chan_monitor,
946 keys_manager: cfgs[i].keys_manager.clone(), node: &chan_mgrs[i], router,
947 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
948 network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
955 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
956 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
959 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
960 /// Tests that the given node has broadcast transactions for the given Channel
962 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
963 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
964 /// broadcast and the revoked outputs were claimed.
966 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
967 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
969 /// All broadcast transactions must be accounted for in one of the above three types of we'll
971 pub fn test_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
972 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
973 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
975 let mut res = Vec::with_capacity(2);
976 node_txn.retain(|tx| {
977 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
978 check_spends!(tx, chan.3.clone());
979 if commitment_tx.is_none() {
980 res.push(tx.clone());
985 if let Some(explicit_tx) = commitment_tx {
986 res.push(explicit_tx.clone());
989 assert_eq!(res.len(), 1);
991 if has_htlc_tx != HTLCType::NONE {
992 node_txn.retain(|tx| {
993 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
994 check_spends!(tx, res[0].clone());
995 if has_htlc_tx == HTLCType::TIMEOUT {
996 assert!(tx.lock_time != 0);
998 assert!(tx.lock_time == 0);
1000 res.push(tx.clone());
1004 assert!(res.len() == 2 || res.len() == 3);
1006 assert_eq!(res[1], res[2]);
1010 assert!(node_txn.is_empty());
1014 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1015 /// HTLC transaction.
1016 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b>(node: &Node<'a, 'b>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1017 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1018 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
1019 // but sometimes not as feerate is too-low
1020 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
1021 node_txn.retain(|tx| {
1022 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1023 check_spends!(tx, revoked_tx);
1027 node_txn.retain(|tx| {
1028 check_spends!(tx, commitment_revoked_tx);
1031 assert!(node_txn.is_empty());
1034 pub fn check_preimage_claim<'a, 'b>(node: &Node<'a, 'b>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1035 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1037 assert!(node_txn.len() >= 1);
1038 assert_eq!(node_txn[0].input.len(), 1);
1039 let mut found_prev = false;
1041 for tx in prev_txn {
1042 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1043 check_spends!(node_txn[0], tx.clone());
1044 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1045 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1051 assert!(found_prev);
1053 let mut res = Vec::new();
1054 mem::swap(&mut *node_txn, &mut res);
1058 pub fn get_announce_close_broadcast_events<'a, 'b>(nodes: &Vec<Node<'a, 'b>>, a: usize, b: usize) {
1059 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1060 assert_eq!(events_1.len(), 1);
1061 let as_update = match events_1[0] {
1062 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1065 _ => panic!("Unexpected event"),
1068 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1069 assert_eq!(events_2.len(), 1);
1070 let bs_update = match events_2[0] {
1071 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1074 _ => panic!("Unexpected event"),
1078 node.router.handle_channel_update(&as_update).unwrap();
1079 node.router.handle_channel_update(&bs_update).unwrap();
1083 macro_rules! get_channel_value_stat {
1084 ($node: expr, $channel_id: expr) => {{
1085 let chan_lock = $node.node.channel_state.lock().unwrap();
1086 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1087 chan.get_value_stat()
1091 macro_rules! get_chan_reestablish_msgs {
1092 ($src_node: expr, $dst_node: expr) => {
1094 let mut res = Vec::with_capacity(1);
1095 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1096 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1097 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1098 res.push(msg.clone());
1100 panic!("Unexpected event")
1108 macro_rules! handle_chan_reestablish_msgs {
1109 ($src_node: expr, $dst_node: expr) => {
1111 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1113 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1115 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1121 let mut revoke_and_ack = None;
1122 let mut commitment_update = None;
1123 let order = if let Some(ev) = msg_events.get(idx) {
1126 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1127 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1128 revoke_and_ack = Some(msg.clone());
1129 RAACommitmentOrder::RevokeAndACKFirst
1131 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1132 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1133 commitment_update = Some(updates.clone());
1134 RAACommitmentOrder::CommitmentFirst
1136 _ => panic!("Unexpected event"),
1139 RAACommitmentOrder::CommitmentFirst
1142 if let Some(ev) = msg_events.get(idx) {
1144 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1145 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1146 assert!(revoke_and_ack.is_none());
1147 revoke_and_ack = Some(msg.clone());
1149 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1150 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1151 assert!(commitment_update.is_none());
1152 commitment_update = Some(updates.clone());
1154 _ => panic!("Unexpected event"),
1158 (funding_locked, revoke_and_ack, commitment_update, order)
1163 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1164 /// for claims/fails they are separated out.
1165 pub fn reconnect_nodes<'a, 'b>(node_a: &Node<'a, 'b>, node_b: &Node<'a, 'b>, 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)) {
1166 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1167 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1168 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1169 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1171 if send_funding_locked.0 {
1172 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1174 for reestablish in reestablish_1.iter() {
1175 assert_eq!(reestablish.next_remote_commitment_number, 0);
1178 if send_funding_locked.1 {
1179 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1181 for reestablish in reestablish_2.iter() {
1182 assert_eq!(reestablish.next_remote_commitment_number, 0);
1185 if send_funding_locked.0 || send_funding_locked.1 {
1186 // If we expect any funding_locked's, both sides better have set
1187 // next_local_commitment_number to 1
1188 for reestablish in reestablish_1.iter() {
1189 assert_eq!(reestablish.next_local_commitment_number, 1);
1191 for reestablish in reestablish_2.iter() {
1192 assert_eq!(reestablish.next_local_commitment_number, 1);
1196 let mut resp_1 = Vec::new();
1197 for msg in reestablish_1 {
1198 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1199 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1201 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1202 check_added_monitors!(node_b, 1);
1204 check_added_monitors!(node_b, 0);
1207 let mut resp_2 = Vec::new();
1208 for msg in reestablish_2 {
1209 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1210 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1212 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1213 check_added_monitors!(node_a, 1);
1215 check_added_monitors!(node_a, 0);
1218 // We don't yet support both needing updates, as that would require a different commitment dance:
1219 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1220 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1222 for chan_msgs in resp_1.drain(..) {
1223 if send_funding_locked.0 {
1224 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1225 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1226 if !announcement_event.is_empty() {
1227 assert_eq!(announcement_event.len(), 1);
1228 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1229 //TODO: Test announcement_sigs re-sending
1230 } else { panic!("Unexpected event!"); }
1233 assert!(chan_msgs.0.is_none());
1236 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1237 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1238 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1239 check_added_monitors!(node_a, 1);
1241 assert!(chan_msgs.1.is_none());
1243 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1244 let commitment_update = chan_msgs.2.unwrap();
1245 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1246 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1248 assert!(commitment_update.update_add_htlcs.is_empty());
1250 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1251 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1252 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1253 for update_add in commitment_update.update_add_htlcs {
1254 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1256 for update_fulfill in commitment_update.update_fulfill_htlcs {
1257 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1259 for update_fail in commitment_update.update_fail_htlcs {
1260 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1263 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1264 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1266 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1267 check_added_monitors!(node_a, 1);
1268 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1269 // No commitment_signed so get_event_msg's assert(len == 1) passes
1270 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1271 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1272 check_added_monitors!(node_b, 1);
1275 assert!(chan_msgs.2.is_none());
1279 for chan_msgs in resp_2.drain(..) {
1280 if send_funding_locked.1 {
1281 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1282 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1283 if !announcement_event.is_empty() {
1284 assert_eq!(announcement_event.len(), 1);
1285 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1286 //TODO: Test announcement_sigs re-sending
1287 } else { panic!("Unexpected event!"); }
1290 assert!(chan_msgs.0.is_none());
1293 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1294 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1295 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1296 check_added_monitors!(node_b, 1);
1298 assert!(chan_msgs.1.is_none());
1300 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1301 let commitment_update = chan_msgs.2.unwrap();
1302 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1303 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1305 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1306 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1307 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1308 for update_add in commitment_update.update_add_htlcs {
1309 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1311 for update_fulfill in commitment_update.update_fulfill_htlcs {
1312 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1314 for update_fail in commitment_update.update_fail_htlcs {
1315 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1318 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1319 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1321 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1322 check_added_monitors!(node_b, 1);
1323 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1324 // No commitment_signed so get_event_msg's assert(len == 1) passes
1325 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1326 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1327 check_added_monitors!(node_a, 1);
1330 assert!(chan_msgs.2.is_none());