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, RouterReadArgs};
10 use ln::features::InitFeatures;
12 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
13 use util::enforcing_trait_impls::EnforcingChannelKeys;
15 use util::test_utils::TestChannelMonitor;
16 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
17 use util::errors::APIError;
18 use util::logger::Logger;
19 use util::config::UserConfig;
20 use util::ser::{ReadableArgs, Writeable};
22 use bitcoin::util::hash::BitcoinHash;
23 use bitcoin::blockdata::block::BlockHeader;
24 use bitcoin::blockdata::transaction::{Transaction, TxOut};
25 use bitcoin::network::constants::Network;
27 use bitcoin_hashes::sha256::Hash as Sha256;
28 use bitcoin_hashes::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::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 the Router, we can deserialize it again.
102 let mut w = test_utils::TestVecWriter(Vec::new());
103 self.router.write(&mut w).unwrap();
104 let deserialized_router = Router::read(&mut ::std::io::Cursor::new(&w.0), RouterReadArgs {
105 chain_monitor: Arc::clone(&self.chain_monitor) as Arc<chaininterface::ChainWatchInterface>,
106 logger: Arc::clone(&self.logger) as Arc<Logger>
108 let mut chan_progress = 0;
110 let orig_announcements = self.router.get_next_channel_announcements(chan_progress, 255);
111 let deserialized_announcements = deserialized_router.get_next_channel_announcements(chan_progress, 255);
112 assert!(orig_announcements == deserialized_announcements);
113 chan_progress = match orig_announcements.last() {
114 Some(announcement) => announcement.0.contents.short_channel_id + 1,
118 let mut node_progress = None;
120 let orig_announcements = self.router.get_next_node_announcements(node_progress.as_ref(), 255);
121 let deserialized_announcements = deserialized_router.get_next_node_announcements(node_progress.as_ref(), 255);
122 assert!(orig_announcements == deserialized_announcements);
123 node_progress = match orig_announcements.last() {
124 Some(announcement) => Some(announcement.contents.node_id),
130 // Check that if we serialize and then deserialize all our channel monitors we get the
131 // same set of outputs to watch for on chain as we have now. Note that if we write
132 // tests that fully close channels and remove the monitors at some point this may break.
133 let feeest = test_utils::TestFeeEstimator { sat_per_kw: 253 };
134 let old_monitors = self.chan_monitor.simple_monitor.monitors.lock().unwrap();
135 let mut deserialized_monitors = Vec::new();
136 for (_, old_monitor) in old_monitors.iter() {
137 let mut w = test_utils::TestVecWriter(Vec::new());
138 old_monitor.write_for_disk(&mut w).unwrap();
139 let (_, deserialized_monitor) = <(Sha256d, ChannelMonitor<EnforcingChannelKeys>)>::read(
140 &mut ::std::io::Cursor::new(&w.0), Arc::clone(&self.logger) as Arc<Logger>).unwrap();
141 deserialized_monitors.push(deserialized_monitor);
144 // Before using all the new monitors to check the watch outpoints, use the full set of
145 // them to ensure we can write and reload our ChannelManager.
147 let mut channel_monitors = HashMap::new();
148 for monitor in deserialized_monitors.iter_mut() {
149 channel_monitors.insert(monitor.get_funding_txo().unwrap(), monitor);
152 let mut w = test_utils::TestVecWriter(Vec::new());
153 self.node.write(&mut w).unwrap();
154 <(Sha256d, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(w.0), ChannelManagerReadArgs {
155 default_config: UserConfig::default(),
156 keys_manager: self.keys_manager,
157 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: 253 },
158 monitor: self.chan_monitor,
159 tx_broadcaster: self.tx_broadcaster.clone(),
160 logger: Arc::new(test_utils::TestLogger::new()),
161 channel_monitors: &mut channel_monitors,
165 let chain_watch = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&self.logger) as Arc<Logger>));
166 let channel_monitor = test_utils::TestChannelMonitor::new(chain_watch.clone(), self.tx_broadcaster.clone(), self.logger.clone(), &feeest);
167 for deserialized_monitor in deserialized_monitors.drain(..) {
168 if let Err(_) = channel_monitor.add_monitor(deserialized_monitor.get_funding_txo().unwrap(), deserialized_monitor) {
172 if *chain_watch != *self.chain_monitor {
179 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) {
180 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
183 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) {
184 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);
185 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
186 (announcement, as_update, bs_update, channel_id, tx)
189 macro_rules! get_revoke_commit_msgs {
190 ($node: expr, $node_id: expr) => {
192 let events = $node.node.get_and_clear_pending_msg_events();
193 assert_eq!(events.len(), 2);
195 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
196 assert_eq!(*node_id, $node_id);
199 _ => panic!("Unexpected event"),
201 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
202 assert_eq!(*node_id, $node_id);
203 assert!(updates.update_add_htlcs.is_empty());
204 assert!(updates.update_fulfill_htlcs.is_empty());
205 assert!(updates.update_fail_htlcs.is_empty());
206 assert!(updates.update_fail_malformed_htlcs.is_empty());
207 assert!(updates.update_fee.is_none());
208 updates.commitment_signed.clone()
210 _ => panic!("Unexpected event"),
216 macro_rules! get_event_msg {
217 ($node: expr, $event_type: path, $node_id: expr) => {
219 let events = $node.node.get_and_clear_pending_msg_events();
220 assert_eq!(events.len(), 1);
222 $event_type { ref node_id, ref msg } => {
223 assert_eq!(*node_id, $node_id);
226 _ => panic!("Unexpected event"),
232 macro_rules! get_htlc_update_msgs {
233 ($node: expr, $node_id: expr) => {
235 let events = $node.node.get_and_clear_pending_msg_events();
236 assert_eq!(events.len(), 1);
238 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
239 assert_eq!(*node_id, $node_id);
242 _ => panic!("Unexpected event"),
248 macro_rules! get_feerate {
249 ($node: expr, $channel_id: expr) => {
251 let chan_lock = $node.node.channel_state.lock().unwrap();
252 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
258 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) {
259 let chan_id = *node.network_chan_count.borrow();
261 let events = node.node.get_and_clear_pending_events();
262 assert_eq!(events.len(), 1);
264 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
265 assert_eq!(*channel_value_satoshis, expected_chan_value);
266 assert_eq!(user_channel_id, expected_user_chan_id);
268 let tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
269 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
271 let funding_outpoint = OutPoint::new(tx.txid(), 0);
272 (*temporary_channel_id, tx, funding_outpoint)
274 _ => panic!("Unexpected event"),
278 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 {
279 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
280 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()));
281 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()));
283 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
286 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
287 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
288 assert_eq!(added_monitors.len(), 1);
289 assert_eq!(added_monitors[0].0, funding_output);
290 added_monitors.clear();
293 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()));
295 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
296 assert_eq!(added_monitors.len(), 1);
297 assert_eq!(added_monitors[0].0, funding_output);
298 added_monitors.clear();
301 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()));
303 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
304 assert_eq!(added_monitors.len(), 1);
305 assert_eq!(added_monitors[0].0, funding_output);
306 added_monitors.clear();
309 let events_4 = node_a.node.get_and_clear_pending_events();
310 assert_eq!(events_4.len(), 1);
312 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
313 assert_eq!(user_channel_id, 42);
314 assert_eq!(*funding_txo, funding_output);
316 _ => panic!("Unexpected event"),
322 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) {
323 confirm_transaction(&node_conf.block_notifier, &node_conf.chain_monitor, &tx, tx.version);
324 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()));
327 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]) {
329 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
330 assert_eq!(events_6.len(), 2);
331 ((match events_6[0] {
332 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
333 channel_id = msg.channel_id.clone();
334 assert_eq!(*node_id, node_recv.node.get_our_node_id());
337 _ => panic!("Unexpected event"),
338 }, match events_6[1] {
339 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
340 assert_eq!(*node_id, node_recv.node.get_our_node_id());
343 _ => panic!("Unexpected event"),
347 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]) {
348 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx);
349 confirm_transaction(&node_a.block_notifier, &node_a.chain_monitor, &tx, tx.version);
350 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
353 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) {
354 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
355 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
359 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) {
360 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
361 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
362 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
364 let events_7 = node_b.node.get_and_clear_pending_msg_events();
365 assert_eq!(events_7.len(), 1);
366 let (announcement, bs_update) = match events_7[0] {
367 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
370 _ => panic!("Unexpected event"),
373 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
374 let events_8 = node_a.node.get_and_clear_pending_msg_events();
375 assert_eq!(events_8.len(), 1);
376 let as_update = match events_8[0] {
377 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
378 assert!(*announcement == *msg);
379 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
380 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
383 _ => panic!("Unexpected event"),
386 *node_a.network_chan_count.borrow_mut() += 1;
388 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
391 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) {
392 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
395 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) {
396 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
398 assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
399 node.router.handle_channel_update(&chan_announcement.1).unwrap();
400 node.router.handle_channel_update(&chan_announcement.2).unwrap();
402 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
405 macro_rules! check_spends {
406 ($tx: expr, $($spends_txn: expr),*) => {
408 $tx.verify(|out_point| {
410 if out_point.txid == $spends_txn.txid() {
411 return $spends_txn.output.get(out_point.vout as usize).cloned()
420 macro_rules! get_closing_signed_broadcast {
421 ($node: expr, $dest_pubkey: expr) => {
423 let events = $node.get_and_clear_pending_msg_events();
424 assert!(events.len() == 1 || events.len() == 2);
425 (match events[events.len() - 1] {
426 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
427 assert_eq!(msg.contents.flags & 2, 2);
430 _ => panic!("Unexpected event"),
431 }, if events.len() == 2 {
433 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
434 assert_eq!(*node_id, $dest_pubkey);
437 _ => panic!("Unexpected event"),
444 macro_rules! check_closed_broadcast {
445 ($node: expr, $with_error_msg: expr) => {{
446 let events = $node.node.get_and_clear_pending_msg_events();
447 assert_eq!(events.len(), if $with_error_msg { 2 } else { 1 });
449 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
450 assert_eq!(msg.contents.flags & 2, 2);
452 _ => panic!("Unexpected event"),
456 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
457 // TODO: Check node_id
460 _ => panic!("Unexpected event"),
466 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) {
467 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) };
468 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
471 node_a.close_channel(channel_id).unwrap();
472 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
474 let events_1 = node_b.get_and_clear_pending_msg_events();
475 assert!(events_1.len() >= 1);
476 let shutdown_b = match events_1[0] {
477 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
478 assert_eq!(node_id, &node_a.get_our_node_id());
481 _ => panic!("Unexpected event"),
484 let closing_signed_b = if !close_inbound_first {
485 assert_eq!(events_1.len(), 1);
488 Some(match events_1[1] {
489 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
490 assert_eq!(node_id, &node_a.get_our_node_id());
493 _ => panic!("Unexpected event"),
497 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
498 let (as_update, bs_update) = if close_inbound_first {
499 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
500 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
501 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
502 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
503 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
505 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
506 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
507 assert!(none_b.is_none());
508 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
509 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
510 (as_update, bs_update)
512 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
514 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
515 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
516 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
517 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
519 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
520 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
521 assert!(none_a.is_none());
522 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
523 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
524 (as_update, bs_update)
526 assert_eq!(tx_a, tx_b);
527 check_spends!(tx_a, funding_tx);
529 (as_update, bs_update, tx_a)
532 pub struct SendEvent {
533 pub node_id: PublicKey,
534 pub msgs: Vec<msgs::UpdateAddHTLC>,
535 pub commitment_msg: msgs::CommitmentSigned,
538 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
539 assert!(updates.update_fulfill_htlcs.is_empty());
540 assert!(updates.update_fail_htlcs.is_empty());
541 assert!(updates.update_fail_malformed_htlcs.is_empty());
542 assert!(updates.update_fee.is_none());
543 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
546 pub fn from_event(event: MessageSendEvent) -> SendEvent {
548 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
549 _ => panic!("Unexpected event type!"),
553 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
554 let mut events = node.node.get_and_clear_pending_msg_events();
555 assert_eq!(events.len(), 1);
556 SendEvent::from_event(events.pop().unwrap())
560 macro_rules! check_added_monitors {
561 ($node: expr, $count: expr) => {
563 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
564 assert_eq!(added_monitors.len(), $count);
565 added_monitors.clear();
570 macro_rules! commitment_signed_dance {
571 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
573 check_added_monitors!($node_a, 0);
574 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
575 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
576 check_added_monitors!($node_a, 1);
577 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
580 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
582 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
583 check_added_monitors!($node_b, 0);
584 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
585 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
586 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
587 check_added_monitors!($node_b, 1);
588 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
589 let (bs_revoke_and_ack, extra_msg_option) = {
590 let events = $node_b.node.get_and_clear_pending_msg_events();
591 assert!(events.len() <= 2);
593 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
594 assert_eq!(*node_id, $node_a.node.get_our_node_id());
597 _ => panic!("Unexpected event"),
598 }, events.get(1).map(|e| e.clone()))
600 check_added_monitors!($node_b, 1);
602 assert!($node_a.node.get_and_clear_pending_events().is_empty());
603 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
605 (extra_msg_option, bs_revoke_and_ack)
608 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
610 check_added_monitors!($node_a, 0);
611 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
612 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
613 check_added_monitors!($node_a, 1);
614 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
615 assert!(extra_msg_option.is_none());
619 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
621 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
622 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
623 check_added_monitors!($node_a, 1);
627 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
629 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
632 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
634 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
636 expect_pending_htlcs_forwardable!($node_a);
637 check_added_monitors!($node_a, 1);
639 let channel_state = $node_a.node.channel_state.lock().unwrap();
640 assert_eq!(channel_state.pending_msg_events.len(), 1);
641 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
642 assert_ne!(*node_id, $node_b.node.get_our_node_id());
643 } else { panic!("Unexpected event"); }
645 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
651 macro_rules! get_payment_preimage_hash {
654 let payment_preimage = PaymentPreimage([*$node.network_payment_count.borrow(); 32]);
655 *$node.network_payment_count.borrow_mut() += 1;
656 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
657 (payment_preimage, payment_hash)
662 macro_rules! expect_pending_htlcs_forwardable {
664 let events = $node.node.get_and_clear_pending_events();
665 assert_eq!(events.len(), 1);
667 Event::PendingHTLCsForwardable { .. } => { },
668 _ => panic!("Unexpected event"),
670 $node.node.process_pending_htlc_forwards();
674 macro_rules! expect_payment_received {
675 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
676 let events = $node.node.get_and_clear_pending_events();
677 assert_eq!(events.len(), 1);
679 Event::PaymentReceived { ref payment_hash, amt } => {
680 assert_eq!($expected_payment_hash, *payment_hash);
681 assert_eq!($expected_recv_value, amt);
683 _ => panic!("Unexpected event"),
688 macro_rules! expect_payment_sent {
689 ($node: expr, $expected_payment_preimage: expr) => {
690 let events = $node.node.get_and_clear_pending_events();
691 assert_eq!(events.len(), 1);
693 Event::PaymentSent { ref payment_preimage } => {
694 assert_eq!($expected_payment_preimage, *payment_preimage);
696 _ => panic!("Unexpected event"),
701 macro_rules! expect_payment_failed {
702 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr) => {
703 let events = $node.node.get_and_clear_pending_events();
704 assert_eq!(events.len(), 1);
706 Event::PaymentFailed { ref payment_hash, rejected_by_dest, .. } => {
707 assert_eq!(*payment_hash, $expected_payment_hash);
708 assert_eq!(rejected_by_dest, $rejected_by_dest);
710 _ => panic!("Unexpected event"),
715 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) {
716 let mut payment_event = {
717 origin_node.node.send_payment(route, our_payment_hash).unwrap();
718 check_added_monitors!(origin_node, 1);
720 let mut events = origin_node.node.get_and_clear_pending_msg_events();
721 assert_eq!(events.len(), 1);
722 SendEvent::from_event(events.remove(0))
724 let mut prev_node = origin_node;
726 for (idx, &node) in expected_route.iter().enumerate() {
727 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
729 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
730 check_added_monitors!(node, 0);
731 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
733 expect_pending_htlcs_forwardable!(node);
735 if idx == expected_route.len() - 1 {
736 let events_2 = node.node.get_and_clear_pending_events();
737 assert_eq!(events_2.len(), 1);
739 Event::PaymentReceived { ref payment_hash, amt } => {
740 assert_eq!(our_payment_hash, *payment_hash);
741 assert_eq!(amt, recv_value);
743 _ => panic!("Unexpected event"),
746 let mut events_2 = node.node.get_and_clear_pending_msg_events();
747 assert_eq!(events_2.len(), 1);
748 check_added_monitors!(node, 1);
749 payment_event = SendEvent::from_event(events_2.remove(0));
750 assert_eq!(payment_event.msgs.len(), 1);
757 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) {
758 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
759 send_along_route_with_hash(origin_node, route, expected_route, recv_value, our_payment_hash);
760 (our_payment_preimage, our_payment_hash)
763 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) {
764 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage, expected_amount));
765 check_added_monitors!(expected_route.last().unwrap(), 1);
767 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
768 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
769 macro_rules! get_next_msgs {
772 let events = $node.node.get_and_clear_pending_msg_events();
773 assert_eq!(events.len(), 1);
775 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 } } => {
776 assert!(update_add_htlcs.is_empty());
777 assert_eq!(update_fulfill_htlcs.len(), 1);
778 assert!(update_fail_htlcs.is_empty());
779 assert!(update_fail_malformed_htlcs.is_empty());
780 assert!(update_fee.is_none());
781 expected_next_node = node_id.clone();
782 Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
784 _ => panic!("Unexpected event"),
790 macro_rules! last_update_fulfill_dance {
791 ($node: expr, $prev_node: expr) => {
793 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
794 check_added_monitors!($node, 0);
795 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
796 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
800 macro_rules! mid_update_fulfill_dance {
801 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
803 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
804 check_added_monitors!($node, 1);
805 let new_next_msgs = if $new_msgs {
806 get_next_msgs!($node)
808 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
811 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
812 next_msgs = new_next_msgs;
817 let mut prev_node = expected_route.last().unwrap();
818 for (idx, node) in expected_route.iter().rev().enumerate() {
819 assert_eq!(expected_next_node, node.node.get_our_node_id());
820 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
821 if next_msgs.is_some() {
822 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
823 } else if update_next_msgs {
824 next_msgs = get_next_msgs!(node);
826 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
828 if !skip_last && idx == expected_route.len() - 1 {
829 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
836 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
837 expect_payment_sent!(origin_node, our_payment_preimage);
841 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) {
842 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage, expected_amount);
845 pub const TEST_FINAL_CLTV: u32 = 32;
847 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash) {
848 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();
849 assert_eq!(route.hops.len(), expected_route.len());
850 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
851 assert_eq!(hop.pubkey, node.node.get_our_node_id());
854 send_along_route(origin_node, route, expected_route, recv_value)
857 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
858 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();
859 assert_eq!(route.hops.len(), expected_route.len());
860 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
861 assert_eq!(hop.pubkey, node.node.get_our_node_id());
864 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
866 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
868 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
869 _ => panic!("Unknown error variants"),
873 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64, expected_value: u64) {
874 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
875 claim_payment(&origin, expected_route, our_payment_preimage, expected_value);
878 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) {
879 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
880 expect_pending_htlcs_forwardable!(expected_route.last().unwrap());
881 check_added_monitors!(expected_route.last().unwrap(), 1);
883 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
884 macro_rules! update_fail_dance {
885 ($node: expr, $prev_node: expr, $last_node: expr) => {
887 $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
888 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
889 if skip_last && $last_node {
890 expect_pending_htlcs_forwardable!($node);
896 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
897 let mut prev_node = expected_route.last().unwrap();
898 for (idx, node) in expected_route.iter().rev().enumerate() {
899 assert_eq!(expected_next_node, node.node.get_our_node_id());
900 if next_msgs.is_some() {
901 // We may be the "last node" for the purpose of the commitment dance if we're
902 // skipping the last node (implying it is disconnected) and we're the
903 // second-to-last node!
904 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
907 let events = node.node.get_and_clear_pending_msg_events();
908 if !skip_last || idx != expected_route.len() - 1 {
909 assert_eq!(events.len(), 1);
911 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 } } => {
912 assert!(update_add_htlcs.is_empty());
913 assert!(update_fulfill_htlcs.is_empty());
914 assert_eq!(update_fail_htlcs.len(), 1);
915 assert!(update_fail_malformed_htlcs.is_empty());
916 assert!(update_fee.is_none());
917 expected_next_node = node_id.clone();
918 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
920 _ => panic!("Unexpected event"),
923 assert!(events.is_empty());
925 if !skip_last && idx == expected_route.len() - 1 {
926 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
933 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
935 let events = origin_node.node.get_and_clear_pending_events();
936 assert_eq!(events.len(), 1);
938 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
939 assert_eq!(payment_hash, our_payment_hash);
940 assert!(rejected_by_dest);
942 _ => panic!("Unexpected event"),
947 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
948 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
951 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
952 let mut chan_mon_cfgs = Vec::new();
953 for _ in 0..node_count {
954 let tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
955 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
956 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator });
962 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
963 let mut nodes = Vec::new();
964 let mut rng = thread_rng();
966 for i in 0..node_count {
967 let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", i)));
968 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
969 let mut seed = [0; 32];
970 rng.fill_bytes(&mut seed);
971 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet, logger.clone() as Arc<Logger>);
972 let chan_monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &chanmon_cfgs[i].tx_broadcaster, logger.clone(), &chanmon_cfgs[i].fee_estimator);
973 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 });
979 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>> {
980 let mut chanmgrs = Vec::new();
981 for i in 0..node_count {
982 let mut default_config = UserConfig::default();
983 default_config.channel_options.announced_channel = true;
984 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
985 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();
992 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>> {
993 let secp_ctx = Secp256k1::new();
994 let mut nodes = Vec::new();
995 let chan_count = Rc::new(RefCell::new(0));
996 let payment_count = Rc::new(RefCell::new(0));
998 for i in 0..node_count {
999 let block_notifier = chaininterface::BlockNotifier::new(cfgs[i].chain_monitor.clone());
1000 block_notifier.register_listener(&cfgs[i].chan_monitor.simple_monitor as &chaininterface::ChainListener);
1001 block_notifier.register_listener(&chan_mgrs[i] as &chaininterface::ChainListener);
1002 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>);
1003 nodes.push(Node{ chain_monitor: cfgs[i].chain_monitor.clone(), block_notifier,
1004 tx_broadcaster: cfgs[i].tx_broadcaster, chan_monitor: &cfgs[i].chan_monitor,
1005 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], router,
1006 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1007 network_payment_count: payment_count.clone(), logger: cfgs[i].logger.clone(),
1014 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 138; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1015 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1017 #[derive(PartialEq)]
1018 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1019 /// Tests that the given node has broadcast transactions for the given Channel
1021 /// First checks that the latest local commitment tx has been broadcast, unless an explicit
1022 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1023 /// broadcast and the revoked outputs were claimed.
1025 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1026 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1028 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1030 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> {
1031 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1032 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1034 let mut res = Vec::with_capacity(2);
1035 node_txn.retain(|tx| {
1036 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1037 check_spends!(tx, chan.3);
1038 if commitment_tx.is_none() {
1039 res.push(tx.clone());
1044 if let Some(explicit_tx) = commitment_tx {
1045 res.push(explicit_tx.clone());
1048 assert_eq!(res.len(), 1);
1050 if has_htlc_tx != HTLCType::NONE {
1051 node_txn.retain(|tx| {
1052 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1053 check_spends!(tx, res[0]);
1054 if has_htlc_tx == HTLCType::TIMEOUT {
1055 assert!(tx.lock_time != 0);
1057 assert!(tx.lock_time == 0);
1059 res.push(tx.clone());
1063 assert!(res.len() == 2 || res.len() == 3);
1065 assert_eq!(res[1], res[2]);
1069 assert!(node_txn.is_empty());
1073 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1074 /// HTLC transaction.
1075 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1076 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1077 // We should issue a 2nd transaction if one htlc is dropped from initial claiming tx
1078 // but sometimes not as feerate is too-low
1079 if node_txn.len() != 1 && node_txn.len() != 2 { assert!(false); }
1080 node_txn.retain(|tx| {
1081 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1082 check_spends!(tx, revoked_tx);
1086 node_txn.retain(|tx| {
1087 check_spends!(tx, commitment_revoked_tx);
1090 assert!(node_txn.is_empty());
1093 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1094 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1096 assert!(node_txn.len() >= 1);
1097 assert_eq!(node_txn[0].input.len(), 1);
1098 let mut found_prev = false;
1100 for tx in prev_txn {
1101 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1102 check_spends!(node_txn[0], tx);
1103 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1104 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1110 assert!(found_prev);
1112 let mut res = Vec::new();
1113 mem::swap(&mut *node_txn, &mut res);
1117 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1118 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1119 assert_eq!(events_1.len(), 1);
1120 let as_update = match events_1[0] {
1121 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1124 _ => panic!("Unexpected event"),
1127 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1128 assert_eq!(events_2.len(), 1);
1129 let bs_update = match events_2[0] {
1130 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1133 _ => panic!("Unexpected event"),
1137 node.router.handle_channel_update(&as_update).unwrap();
1138 node.router.handle_channel_update(&bs_update).unwrap();
1142 macro_rules! get_channel_value_stat {
1143 ($node: expr, $channel_id: expr) => {{
1144 let chan_lock = $node.node.channel_state.lock().unwrap();
1145 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1146 chan.get_value_stat()
1150 macro_rules! get_chan_reestablish_msgs {
1151 ($src_node: expr, $dst_node: expr) => {
1153 let mut res = Vec::with_capacity(1);
1154 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1155 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1156 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1157 res.push(msg.clone());
1159 panic!("Unexpected event")
1167 macro_rules! handle_chan_reestablish_msgs {
1168 ($src_node: expr, $dst_node: expr) => {
1170 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1172 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1174 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1180 let mut revoke_and_ack = None;
1181 let mut commitment_update = None;
1182 let order = if let Some(ev) = msg_events.get(idx) {
1185 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1186 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1187 revoke_and_ack = Some(msg.clone());
1188 RAACommitmentOrder::RevokeAndACKFirst
1190 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1191 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1192 commitment_update = Some(updates.clone());
1193 RAACommitmentOrder::CommitmentFirst
1195 _ => panic!("Unexpected event"),
1198 RAACommitmentOrder::CommitmentFirst
1201 if let Some(ev) = msg_events.get(idx) {
1203 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1204 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1205 assert!(revoke_and_ack.is_none());
1206 revoke_and_ack = Some(msg.clone());
1208 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1209 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1210 assert!(commitment_update.is_none());
1211 commitment_update = Some(updates.clone());
1213 _ => panic!("Unexpected event"),
1217 (funding_locked, revoke_and_ack, commitment_update, order)
1222 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1223 /// for claims/fails they are separated out.
1224 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)) {
1225 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1226 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1227 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1228 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1230 if send_funding_locked.0 {
1231 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1233 for reestablish in reestablish_1.iter() {
1234 assert_eq!(reestablish.next_remote_commitment_number, 0);
1237 if send_funding_locked.1 {
1238 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1240 for reestablish in reestablish_2.iter() {
1241 assert_eq!(reestablish.next_remote_commitment_number, 0);
1244 if send_funding_locked.0 || send_funding_locked.1 {
1245 // If we expect any funding_locked's, both sides better have set
1246 // next_local_commitment_number to 1
1247 for reestablish in reestablish_1.iter() {
1248 assert_eq!(reestablish.next_local_commitment_number, 1);
1250 for reestablish in reestablish_2.iter() {
1251 assert_eq!(reestablish.next_local_commitment_number, 1);
1255 let mut resp_1 = Vec::new();
1256 for msg in reestablish_1 {
1257 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1258 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1260 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1261 check_added_monitors!(node_b, 1);
1263 check_added_monitors!(node_b, 0);
1266 let mut resp_2 = Vec::new();
1267 for msg in reestablish_2 {
1268 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1269 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1271 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1272 check_added_monitors!(node_a, 1);
1274 check_added_monitors!(node_a, 0);
1277 // We don't yet support both needing updates, as that would require a different commitment dance:
1278 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1279 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1281 for chan_msgs in resp_1.drain(..) {
1282 if send_funding_locked.0 {
1283 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1284 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1285 if !announcement_event.is_empty() {
1286 assert_eq!(announcement_event.len(), 1);
1287 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1288 //TODO: Test announcement_sigs re-sending
1289 } else { panic!("Unexpected event!"); }
1292 assert!(chan_msgs.0.is_none());
1295 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1296 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1297 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1298 check_added_monitors!(node_a, 1);
1300 assert!(chan_msgs.1.is_none());
1302 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1303 let commitment_update = chan_msgs.2.unwrap();
1304 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1305 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1307 assert!(commitment_update.update_add_htlcs.is_empty());
1309 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1310 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1311 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1312 for update_add in commitment_update.update_add_htlcs {
1313 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1315 for update_fulfill in commitment_update.update_fulfill_htlcs {
1316 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1318 for update_fail in commitment_update.update_fail_htlcs {
1319 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1322 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1323 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1325 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1326 check_added_monitors!(node_a, 1);
1327 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1328 // No commitment_signed so get_event_msg's assert(len == 1) passes
1329 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1330 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1331 check_added_monitors!(node_b, 1);
1334 assert!(chan_msgs.2.is_none());
1338 for chan_msgs in resp_2.drain(..) {
1339 if send_funding_locked.1 {
1340 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1341 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1342 if !announcement_event.is_empty() {
1343 assert_eq!(announcement_event.len(), 1);
1344 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1345 //TODO: Test announcement_sigs re-sending
1346 } else { panic!("Unexpected event!"); }
1349 assert!(chan_msgs.0.is_none());
1352 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1353 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1354 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1355 check_added_monitors!(node_b, 1);
1357 assert!(chan_msgs.1.is_none());
1359 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1360 let commitment_update = chan_msgs.2.unwrap();
1361 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1362 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1364 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1365 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
1366 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1367 for update_add in commitment_update.update_add_htlcs {
1368 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1370 for update_fulfill in commitment_update.update_fulfill_htlcs {
1371 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1373 for update_fail in commitment_update.update_fail_htlcs {
1374 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1377 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1378 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1380 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1381 check_added_monitors!(node_b, 1);
1382 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1383 // No commitment_signed so get_event_msg's assert(len == 1) passes
1384 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1385 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1386 check_added_monitors!(node_a, 1);
1389 assert!(chan_msgs.2.is_none());