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,
65 pub fee_estimator: test_utils::TestFeeEstimator,
68 pub struct NodeCfg<'a> {
69 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
70 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
71 pub fee_estimator: &'a test_utils::TestFeeEstimator,
72 pub chan_monitor: test_utils::TestChannelMonitor<'a>,
73 pub keys_manager: test_utils::TestKeysInterface,
74 pub logger: Arc<test_utils::TestLogger>,
75 pub node_seed: [u8; 32],
78 pub struct Node<'a, 'b: 'a, 'c: 'b> {
79 pub block_notifier: chaininterface::BlockNotifierRef<'a>,
80 pub chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
81 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
82 pub chan_monitor: &'b test_utils::TestChannelMonitor<'c>,
83 pub keys_manager: &'b test_utils::TestKeysInterface,
84 pub node: &'a ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator>,
86 pub node_seed: [u8; 32],
87 pub network_payment_count: Rc<RefCell<u8>>,
88 pub network_chan_count: Rc<RefCell<u32>>,
89 pub logger: Arc<test_utils::TestLogger>
92 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
94 if !::std::thread::panicking() {
95 // Check that we processed all pending events
96 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
97 assert!(self.node.get_and_clear_pending_events().is_empty());
98 assert!(self.chan_monitor.added_monitors.lock().unwrap().is_empty());
100 // Check that if we serialize and then deserialize all our channel monitors we get the
101 // same set of outputs to watch for on chain as we have now. Note that if we write
102 // tests that fully close channels and remove the monitors at some point this may break.
103 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
104 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
105 let mut deserialized_monitors = Vec::new();
106 for (_, old_monitor) in old_monitors.iter() {
107 let mut w = test_utils::TestVecWriter(Vec::new());
108 old_monitor.write_for_disk(&mut w).unwrap();
109 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
110 &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
111 deserialized_monitors.push(deserialized_monitor);
114 // Before using all the new monitors to check the watch outpoints, use the full set of
115 // them to ensure we can write and reload our ChannelManager.
117 let mut channel_monitors = HashMap::new();
118 for monitor in deserialized_monitors.iter_mut() {
119 channel_monitors.insert(monitor.get_funding_txo().unwrap(), monitor);
122 let mut w = test_utils::TestVecWriter(Vec::new());
123 self.node.write(&mut w).unwrap();
124 <(Sha256d, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
125 default_config: UserConfig::default(),
126 keys_manager: self.keys_manager,
127 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
128 monitor: self.chan_monitor,
129 tx_broadcaster: self.tx_broadcaster.clone(),
130 logger: Arc::new(test_utils::TestLogger::new()),
131 channel_monitors: &mut channel_monitors,
135 let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
136 let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), &feeest);
137 for deserialized_monitor in deserialized_monitors.drain(..) {
138 if let Err(_) = channel_monitor.add_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
142 if *chain_watch != *self.chain_monitor {
149 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) {
150 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
153 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) {
154 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);
155 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
156 (announcement, as_update, bs_update, channel_id, tx)
159 macro_rules! get_revoke_commit_msgs {
160 ($node: expr, $node_id: expr) => {
162 let events = $node.node.get_and_clear_pending_msg_events();
163 assert_eq!(events.len(), 2);
165 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
166 assert_eq!(*node_id, $node_id);
169 _ => panic!("Unexpected event"),
171 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
172 assert_eq!(*node_id, $node_id);
173 assert!(updates.update_add_htlcs.is_empty());
174 assert!(updates.update_fulfill_htlcs.is_empty());
175 assert!(updates.update_fail_htlcs.is_empty());
176 assert!(updates.update_fail_malformed_htlcs.is_empty());
177 assert!(updates.update_fee.is_none());
178 updates.commitment_signed.clone()
180 _ => panic!("Unexpected event"),
186 macro_rules! get_event_msg {
187 ($node: expr, $event_type: path, $node_id: expr) => {
189 let events = $node.node.get_and_clear_pending_msg_events();
190 assert_eq!(events.len(), 1);
192 $event_type { ref node_id, ref msg } => {
193 assert_eq!(*node_id, $node_id);
196 _ => panic!("Unexpected event"),
202 macro_rules! get_htlc_update_msgs {
203 ($node: expr, $node_id: expr) => {
205 let events = $node.node.get_and_clear_pending_msg_events();
206 assert_eq!(events.len(), 1);
208 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
209 assert_eq!(*node_id, $node_id);
212 _ => panic!("Unexpected event"),
218 macro_rules! get_feerate {
219 ($node: expr, $channel_id: expr) => {
221 let chan_lock = $node.node.channel_state.lock().unwrap();
222 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
228 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) {
229 let chan_id = *node.network_chan_count.borrow();
231 let events = node.node.get_and_clear_pending_events();
232 assert_eq!(events.len(), 1);
234 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
235 assert_eq!(*channel_value_satoshis, expected_chan_value);
236 assert_eq!(user_channel_id, expected_user_chan_id);
238 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
239 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
241 let funding_outpoint = OutPoint::new(tx.txid(), 0);
242 (*temporary_channel_id, tx, funding_outpoint)
244 _ => panic!("Unexpected event"),
248 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 {
249 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
250 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()));
251 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()));
253 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
256 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
257 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
258 assert_eq!(added_monitors.len(), 1);
259 assert_eq!(added_monitors[0].0, funding_output);
260 added_monitors.clear();
263 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()));
265 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
266 assert_eq!(added_monitors.len(), 1);
267 assert_eq!(added_monitors[0].0, funding_output);
268 added_monitors.clear();
271 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()));
273 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
274 assert_eq!(added_monitors.len(), 1);
275 assert_eq!(added_monitors[0].0, funding_output);
276 added_monitors.clear();
279 let events_4 = node_a.node.get_and_clear_pending_events();
280 assert_eq!(events_4.len(), 1);
282 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
283 assert_eq!(user_channel_id, 42);
284 assert_eq!(*funding_txo, funding_output);
286 _ => panic!("Unexpected event"),
292 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) {
293 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
294 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()));
297 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]) {
299 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
300 assert_eq!(events_6.len(), 2);
301 ((match events_6[0] {
302 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
303 channel_id = msg.channel_id.clone();
304 assert_eq!(*node_id, node_recv.node.get_our_node_id());
307 _ => panic!("Unexpected event"),
308 }, match events_6[1] {
309 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
310 assert_eq!(*node_id, node_recv.node.get_our_node_id());
313 _ => panic!("Unexpected event"),
317 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]) {
318 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
319 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
320 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
323 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) {
324 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
325 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
329 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) {
330 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
331 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
332 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
334 let events_7 = node_b.node.get_and_clear_pending_msg_events();
335 assert_eq!(events_7.len(), 1);
336 let (announcement, bs_update) = match events_7[0] {
337 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
340 _ => panic!("Unexpected event"),
343 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
344 let events_8 = node_a.node.get_and_clear_pending_msg_events();
345 assert_eq!(events_8.len(), 1);
346 let as_update = match events_8[0] {
347 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
348 assert!(*announcement == *msg);
349 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
350 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
353 _ => panic!("Unexpected event"),
356 *node_a.network_chan_count.borrow_mut() += 1;
358 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
361 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) {
362 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
365 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) {
366 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
368 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
369 node.router.handle_channel_update(&chan_announcement.1).unwrap();
370 node.router.handle_channel_update(&chan_announcement.2).unwrap();
372 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
375 macro_rules! check_spends {
376 ($tx: expr, $spends_tx: expr) => {
378 $tx.verify(|out_point| {
379 if out_point.txid == $spends_tx.txid() {
380 $spends_tx.output.get(out_point.vout as usize).cloned()
389 macro_rules! get_closing_signed_broadcast {
390 ($node: expr, $dest_pubkey: expr) => {
392 let events = $node.get_and_clear_pending_msg_events();
393 assert!(events.len() == 1 || events.len() == 2);
394 (match events[events.len() - 1] {
395 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
396 assert_eq!(msg.contents.flags & 2, 2);
399 _ => panic!("Unexpected event"),
400 }, if events.len() == 2 {
402 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
403 assert_eq!(*node_id, $dest_pubkey);
406 _ => panic!("Unexpected event"),
413 macro_rules! check_closed_broadcast {
414 ($node: expr, $with_error_msg: expr) => {{
415 let events = $node.node.get_and_clear_pending_msg_events();
416 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
418 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
419 assert_eq!(msg.contents.flags & 2, 2);
421 _ => panic!("Unexpected event"),
425 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
426 // TODO: Check node_id
429 _ => panic!("Unexpected event"),
435 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) {
436 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) };
437 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
440 node_a.close_channel(channel_id).unwrap();
441 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
443 let events_1 = node_b.get_and_clear_pending_msg_events();
444 assert!(events_1.len() >= 1);
445 let shutdown_b = match events_1[0] {
446 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
447 assert_eq!(node_id, &node_a.get_our_node_id());
450 _ => panic!("Unexpected event"),
453 let closing_signed_b = if !close_inbound_first {
454 assert_eq!(events_1.len(), 1);
457 Some(match events_1[1] {
458 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
459 assert_eq!(node_id, &node_a.get_our_node_id());
462 _ => panic!("Unexpected event"),
466 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
467 let (as_update, bs_update) = if close_inbound_first {
468 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
469 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
470 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
471 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
472 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
474 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
475 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
476 assert!(none_b.is_none());
477 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
478 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
479 (as_update, bs_update)
481 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
483 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
484 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
485 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
486 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
488 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
489 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
490 assert!(none_a.is_none());
491 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
492 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
493 (as_update, bs_update)
495 assert_eq!(tx_a, tx_b);
496 check_spends!(tx_a, funding_tx);
498 (as_update, bs_update, tx_a)
501 pub struct SendEvent {
502 pub node_id: PublicKey,
503 pub msgs: Vec<msgs::UpdateAddHTLC>,
504 pub commitment_msg: msgs::CommitmentSigned,
507 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
508 assert!(updates.update_fulfill_htlcs.is_empty());
509 assert!(updates.update_fail_htlcs.is_empty());
510 assert!(updates.update_fail_malformed_htlcs.is_empty());
511 assert!(updates.update_fee.is_none());
512 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
515 pub fn from_event(event: MessageSendEvent) -> SendEvent {
517 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
518 _ => panic!("Unexpected event type!"),
522 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
523 let mut events = node.node.get_and_clear_pending_msg_events();
524 assert_eq!(events.len(), 1);
525 SendEvent::from_event(events.pop().unwrap())
529 macro_rules! check_added_monitors {
530 ($node: expr, $count: expr) => {
532 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
533 assert_eq!(added_monitors.len(), $count);
534 added_monitors.clear();
539 macro_rules! commitment_signed_dance {
540 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
542 check_added_monitors!($node_a, 0);
543 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
544 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
545 check_added_monitors!($node_a, 1);
546 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
549 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
551 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
552 check_added_monitors!($node_b, 0);
553 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
554 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
555 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
556 check_added_monitors!($node_b, 1);
557 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
558 let (bs_revoke_and_ack, extra_msg_option) = {
559 let events = $node_b.node.get_and_clear_pending_msg_events();
560 assert!(events.len() <= 2);
562 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
563 assert_eq!(*node_id, $node_a.node.get_our_node_id());
566 _ => panic!("Unexpected event"),
567 }, events.get(1).map(|e| e.clone()))
569 check_added_monitors!($node_b, 1);
571 assert!($node_a.node.get_and_clear_pending_events().is_empty());
572 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
574 (extra_msg_option, bs_revoke_and_ack)
577 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
579 check_added_monitors!($node_a, 0);
580 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
581 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
582 check_added_monitors!($node_a, 1);
583 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
584 assert!(extra_msg_option.is_none());
588 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
590 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
591 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
592 check_added_monitors!($node_a, 1);
596 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
598 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
601 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
603 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
605 expect_pending_htlcs_forwardable!($node_a);
606 check_added_monitors!($node_a, 1);
608 let channel_state = $node_a.node.channel_state.lock().unwrap();
609 assert_eq!(channel_state.pending_msg_events.len(), 1);
610 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
611 assert_ne!(*node_id, $node_b.node.get_our_node_id());
612 } else { panic!("Unexpected event"); }
614 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
620 macro_rules! get_payment_preimage_hash {
623 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
624 *$node.network_payment_count.borrow_mut() += 1;
625 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
626 (payment_preimage, payment_hash)
631 macro_rules! expect_pending_htlcs_forwardable {
633 let events = $node.node.get_and_clear_pending_events();
634 assert_eq!(events.len(), 1);
636 Event::PendingHTLCsForwardable { .. } => { },
637 _ => panic!("Unexpected event"),
639 $node.node.process_pending_htlc_forwards();
643 macro_rules! expect_payment_received {
644 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
645 let events = $node.node.get_and_clear_pending_events();
646 assert_eq!(events.len(), 1);
648 Event::PaymentReceived { ref payment_hash, amt } => {
649 assert_eq!($expected_payment_hash, *payment_hash);
650 assert_eq!($expected_recv_value, amt);
652 _ => panic!("Unexpected event"),
657 macro_rules! expect_payment_sent {
658 ($node: expr, $expected_payment_preimage: expr) => {
659 let events = $node.node.get_and_clear_pending_events();
660 assert_eq!(events.len(), 1);
662 Event::PaymentSent { ref payment_preimage } => {
663 assert_eq!($expected_payment_preimage, *payment_preimage);
665 _ => panic!("Unexpected event"),
670 macro_rules! expect_payment_failed {
671 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr) => {
672 let events = $node.node.get_and_clear_pending_events();
673 assert_eq!(events.len(), 1);
675 Event::PaymentFailed { ref payment_hash, rejected_by_dest, .. } => {
676 assert_eq!(*payment_hash, $expected_payment_hash);
677 assert_eq!(rejected_by_dest, $rejected_by_dest);
679 _ => panic!("Unexpected event"),
684 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) {
685 let mut payment_event = {
686 origin_node.node.send_payment(route, our_payment_hash).unwrap();
687 check_added_monitors!(origin_node, 1);
689 let mut events = origin_node.node.get_and_clear_pending_msg_events();
690 assert_eq!(events.len(), 1);
691 SendEvent::from_event(events.remove(0))
693 let mut prev_node = origin_node;
695 for (idx, &node) in expected_route.iter().enumerate() {
696 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
698 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
699 check_added_monitors!(node, 0);
700 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
702 expect_pending_htlcs_forwardable!(node);
704 if idx == expected_route.len() - 1 {
705 let events_2 = node.node.get_and_clear_pending_events();
706 assert_eq!(events_2.len(), 1);
708 Event::PaymentReceived { ref payment_hash, amt } => {
709 assert_eq!(our_payment_hash, *payment_hash);
710 assert_eq!(amt, recv_value);
712 _ => panic!("Unexpected event"),
715 let mut events_2 = node.node.get_and_clear_pending_msg_events();
716 assert_eq!(events_2.len(), 1);
717 check_added_monitors!(node, 1);
718 payment_event = SendEvent::from_event(events_2.remove(0));
719 assert_eq!(payment_event.msgs.len(), 1);
726 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) {
727 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
728 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
729 (our_payment_preimage, our_payment_hash)
732 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) {
733 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
734 check_added_monitors!(expected_route.last().unwrap(), 1);
736 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
737 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
738 macro_rules! get_next_msgs {
741 let events = $node.node.get_and_clear_pending_msg_events();
742 assert_eq!(events.len(), 1);
744 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 } } => {
745 assert!(update_add_htlcs.is_empty());
746 assert_eq!(update_fulfill_htlcs.len(), 1);
747 assert!(update_fail_htlcs.is_empty());
748 assert!(update_fail_malformed_htlcs.is_empty());
749 assert!(update_fee.is_none());
750 expected_next_node = node_id.clone();
751 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
753 _ => panic!("Unexpected event"),
759 macro_rules! last_update_fulfill_dance {
760 ($node: expr, $prev_node: expr) => {
762 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
763 check_added_monitors!($node, 0);
764 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
765 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
769 macro_rules! mid_update_fulfill_dance {
770 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
772 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
773 check_added_monitors!($node, 1);
774 let new_next_msgs = if $new_msgs {
775 get_next_msgs!($node)
777 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
780 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
781 next_msgs = new_next_msgs;
786 let mut prev_node = expected_route.last().unwrap();
787 for (idx, node) in expected_route.iter().rev().enumerate() {
788 assert_eq!(expected_next_node, node.node.get_our_node_id());
789 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
790 if next_msgs.is_some() {
791 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
792 } else if update_next_msgs {
793 next_msgs = get_next_msgs!(node);
795 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
797 if !skip_last && idx == expected_route.len() - 1 {
798 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
805 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
806 expect_payment_sent!(origin_node, our_payment_preimage);
810 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) {
811 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
814 pub const TEST_FINAL_CLTV: u32 = 32;
816 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
817 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();
818 assert_eq!(route.hops.len(), expected_route.len());
819 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
820 assert_eq!(hop.pubkey, node.node.get_our_node_id());
823 send_along_route(origin_node, route, expected_route, recv_value)
826 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
827 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();
828 assert_eq!(route.hops.len(), expected_route.len());
829 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
830 assert_eq!(hop.pubkey, node.node.get_our_node_id());
833 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
835 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
837 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
838 _ => panic!("Unknown error variants"),
842 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
843 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
844 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
847 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) {
848 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
849 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
850 check_added_monitors!(expected_route.last().unwrap(), 1);
852 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
853 macro_rules! update_fail_dance {
854 ($node: expr, $prev_node: expr, $last_node: expr) => {
856 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
857 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
858 if skip_last && $last_node {
859 expect_pending_htlcs_forwardable!($node);
865 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
866 let mut prev_node = expected_route.last().unwrap();
867 for (idx, node) in expected_route.iter().rev().enumerate() {
868 assert_eq!(expected_next_node, node.node.get_our_node_id());
869 if next_msgs.is_some() {
870 // We may be the "last node" for the purpose of the commitment dance if we're
871 // skipping the last node (implying it is disconnected) and we're the
872 // second-to-last node!
873 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
876 let events = node.node.get_and_clear_pending_msg_events();
877 if !skip_last || idx != expected_route.len() - 1 {
878 assert_eq!(events.len(), 1);
880 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 } } => {
881 assert!(update_add_htlcs.is_empty());
882 assert!(update_fulfill_htlcs.is_empty());
883 assert_eq!(update_fail_htlcs.len(), 1);
884 assert!(update_fail_malformed_htlcs.is_empty());
885 assert!(update_fee.is_none());
886 expected_next_node = node_id.clone();
887 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
889 _ => panic!("Unexpected event"),
892 assert!(events.is_empty());
894 if !skip_last && idx == expected_route.len() - 1 {
895 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
902 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
904 let events = origin_node.node.get_and_clear_pending_events();
905 assert_eq!(events.len(), 1);
907 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
908 assert_eq!(payment_hash, our_payment_hash);
909 assert!(rejected_by_dest);
911 _ => panic!("Unexpected event"),
916 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
917 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
920 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
921 let mut chan_mon_cfgs = Vec::new();
922 for _ in 0..node_count {
923 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashSet::new())};
924 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
925 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator });
931 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
932 let mut nodes = Vec::new();
933 let mut rng = thread_rng();
935 for i in 0..node_count {
936 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
937 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
938 let mut seed = [0; 32];
939 rng.fill_bytes(&mut seed);
940 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>);
941 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &chanmon_cfgs[i].tx_broadcaster, logger.clone(), &chanmon_cfgs[i].fee_estimator);
942 nodes.push(NodeCfg { chain_monitor, logger, tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster, fee_estimator: &chanmon_cfgs[i].fee_estimator, chan_monitor, keys_manager, node_seed: seed });
948 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingChannelKeys, &'a TestChannelMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator>> {
949 let mut chanmgrs = Vec::new();
950 for i in 0..node_count {
951 let mut default_config = UserConfig::default();
952 default_config.channel_options.announced_channel = true;
953 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
954 let node = ChannelManager::new(Network::Testnet, cfgs[i].fee_estimator, &cfgs[i].chan_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger.clone(), &cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { default_config }, 0).unwrap();
961 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingChannelKeys, &'b TestChannelMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator>>) -> Vec<Node<'a, 'b, 'c>> {
962 let secp_ctx = Secp256k1::new();
963 let mut nodes = Vec::new();
964 let chan_count = Rc::new(RefCell::new(0));
965 let payment_count = Rc::new(RefCell::new(0));
967 for i in 0..node_count {
968 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
969 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
970 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
971 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>);
972 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
973 tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
974 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], router,
975 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
976 network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
983 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
984 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
987 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
988 /// Tests that the given node has broadcast transactions for the given Channel
990 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
991 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
992 /// broadcast and the revoked outputs were claimed.
994 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
995 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
997 /// All broadcast transactions must be accounted for in one of the above three types of we'll
999 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> {
1000 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1001 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1003 let mut res = Vec::with_capacity(2);
1004 node_txn.retain(|tx| {
1005 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1006 check_spends!(tx, chan.3.clone());
1007 if commitment_tx.is_none() {
1008 res.push(tx.clone());
1013 if let Some(explicit_tx) = commitment_tx {
1014 res.push(explicit_tx.clone());
1017 assert_eq!(res.len(), 1);
1019 if has_htlc_tx != HTLCType::NONE {
1020 node_txn.retain(|tx| {
1021 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1022 check_spends!(tx, res[0].clone());
1023 if has_htlc_tx == HTLCType::TIMEOUT {
1024 assert!(tx.lock_time != 0);
1026 assert!(tx.lock_time == 0);
1028 res.push(tx.clone());
1032 assert!(res.len() == 2 || res.len() == 3);
1034 assert_eq!(res[1], res[2]);
1038 assert!(node_txn.is_empty());
1042 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1043 /// HTLC transaction.
1044 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1045 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1046 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
1047 // but sometimes not as feerate is too-low
1048 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
1049 node_txn.retain(|tx| {
1050 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1051 check_spends!(tx, revoked_tx);
1055 node_txn.retain(|tx| {
1056 check_spends!(tx, commitment_revoked_tx);
1059 assert!(node_txn.is_empty());
1062 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1063 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1065 assert!(node_txn.len() >= 1);
1066 assert_eq!(node_txn[0].input.len(), 1);
1067 let mut found_prev = false;
1069 for tx in prev_txn {
1070 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1071 check_spends!(node_txn[0], tx.clone());
1072 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1073 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1079 assert!(found_prev);
1081 let mut res = Vec::new();
1082 mem::swap(&mut *node_txn, &mut res);
1086 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1087 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1088 assert_eq!(events_1.len(), 1);
1089 let as_update = match events_1[0] {
1090 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1093 _ => panic!("Unexpected event"),
1096 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1097 assert_eq!(events_2.len(), 1);
1098 let bs_update = match events_2[0] {
1099 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1102 _ => panic!("Unexpected event"),
1106 node.router.handle_channel_update(&as_update).unwrap();
1107 node.router.handle_channel_update(&bs_update).unwrap();
1111 macro_rules! get_channel_value_stat {
1112 ($node: expr, $channel_id: expr) => {{
1113 let chan_lock = $node.node.channel_state.lock().unwrap();
1114 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1115 chan.get_value_stat()
1119 macro_rules! get_chan_reestablish_msgs {
1120 ($src_node: expr, $dst_node: expr) => {
1122 let mut res = Vec::with_capacity(1);
1123 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1124 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1125 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1126 res.push(msg.clone());
1128 panic!("Unexpected event")
1136 macro_rules! handle_chan_reestablish_msgs {
1137 ($src_node: expr, $dst_node: expr) => {
1139 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1141 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1143 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1149 let mut revoke_and_ack = None;
1150 let mut commitment_update = None;
1151 let order = if let Some(ev) = msg_events.get(idx) {
1154 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1155 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1156 revoke_and_ack = Some(msg.clone());
1157 RAACommitmentOrder::RevokeAndACKFirst
1159 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1160 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1161 commitment_update = Some(updates.clone());
1162 RAACommitmentOrder::CommitmentFirst
1164 _ => panic!("Unexpected event"),
1167 RAACommitmentOrder::CommitmentFirst
1170 if let Some(ev) = msg_events.get(idx) {
1172 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1173 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1174 assert!(revoke_and_ack.is_none());
1175 revoke_and_ack = Some(msg.clone());
1177 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1178 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1179 assert!(commitment_update.is_none());
1180 commitment_update = Some(updates.clone());
1182 _ => panic!("Unexpected event"),
1186 (funding_locked, revoke_and_ack, commitment_update, order)
1191 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1192 /// for claims/fails they are separated out.
1193 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)) {
1194 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1195 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1196 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1197 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1199 if send_funding_locked.0 {
1200 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1202 for reestablish in reestablish_1.iter() {
1203 assert_eq!(reestablish.next_remote_commitment_number, 0);
1206 if send_funding_locked.1 {
1207 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1209 for reestablish in reestablish_2.iter() {
1210 assert_eq!(reestablish.next_remote_commitment_number, 0);
1213 if send_funding_locked.0 || send_funding_locked.1 {
1214 // If we expect any funding_locked's, both sides better have set
1215 // next_local_commitment_number to 1
1216 for reestablish in reestablish_1.iter() {
1217 assert_eq!(reestablish.next_local_commitment_number, 1);
1219 for reestablish in reestablish_2.iter() {
1220 assert_eq!(reestablish.next_local_commitment_number, 1);
1224 let mut resp_1 = Vec::new();
1225 for msg in reestablish_1 {
1226 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1227 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1229 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1230 check_added_monitors!(node_b, 1);
1232 check_added_monitors!(node_b, 0);
1235 let mut resp_2 = Vec::new();
1236 for msg in reestablish_2 {
1237 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1238 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1240 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1241 check_added_monitors!(node_a, 1);
1243 check_added_monitors!(node_a, 0);
1246 // We don't yet support both needing updates, as that would require a different commitment dance:
1247 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1248 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1250 for chan_msgs in resp_1.drain(..) {
1251 if send_funding_locked.0 {
1252 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1253 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1254 if !announcement_event.is_empty() {
1255 assert_eq!(announcement_event.len(), 1);
1256 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1257 //TODO: Test announcement_sigs re-sending
1258 } else { panic!("Unexpected event!"); }
1261 assert!(chan_msgs.0.is_none());
1264 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1265 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1266 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1267 check_added_monitors!(node_a, 1);
1269 assert!(chan_msgs.1.is_none());
1271 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1272 let commitment_update = chan_msgs.2.unwrap();
1273 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1274 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1276 assert!(commitment_update.update_add_htlcs.is_empty());
1278 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1279 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1280 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1281 for update_add in commitment_update.update_add_htlcs {
1282 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1284 for update_fulfill in commitment_update.update_fulfill_htlcs {
1285 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1287 for update_fail in commitment_update.update_fail_htlcs {
1288 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1291 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1292 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1294 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1295 check_added_monitors!(node_a, 1);
1296 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1297 // No commitment_signed so get_event_msg's assert(len == 1) passes
1298 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1299 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1300 check_added_monitors!(node_b, 1);
1303 assert!(chan_msgs.2.is_none());
1307 for chan_msgs in resp_2.drain(..) {
1308 if send_funding_locked.1 {
1309 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1310 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1311 if !announcement_event.is_empty() {
1312 assert_eq!(announcement_event.len(), 1);
1313 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1314 //TODO: Test announcement_sigs re-sending
1315 } else { panic!("Unexpected event!"); }
1318 assert!(chan_msgs.0.is_none());
1321 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1322 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1323 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1324 check_added_monitors!(node_b, 1);
1326 assert!(chan_msgs.1.is_none());
1328 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1329 let commitment_update = chan_msgs.2.unwrap();
1330 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1331 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1333 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1334 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1335 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1336 for update_add in commitment_update.update_add_htlcs {
1337 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1339 for update_fulfill in commitment_update.update_fulfill_htlcs {
1340 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1342 for update_fail in commitment_update.update_fail_htlcs {
1343 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1346 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1347 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1349 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1350 check_added_monitors!(node_b, 1);
1351 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1352 // No commitment_signed so get_event_msg's assert(len == 1) passes
1353 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1354 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1355 check_added_monitors!(node_a, 1);
1358 assert!(chan_msgs.2.is_none());