1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use chain::{BestBlock, Confirm, Listen, Watch};
14 use chain::channelmonitor::ChannelMonitor;
15 use chain::transaction::OutPoint;
16 use ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure};
18 use routing::router::{Route, get_route};
19 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
25 use util::test_utils::TestChainMonitor;
26 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
27 use util::errors::APIError;
28 use util::config::UserConfig;
29 use util::ser::{ReadableArgs, Writeable, Readable};
31 use bitcoin::blockdata::block::{Block, BlockHeader};
32 use bitcoin::blockdata::constants::genesis_block;
33 use bitcoin::blockdata::transaction::{Transaction, TxOut};
34 use bitcoin::network::constants::Network;
36 use bitcoin::hashes::sha256::Hash as Sha256;
37 use bitcoin::hashes::Hash;
38 use bitcoin::hash_types::BlockHash;
40 use bitcoin::secp256k1::key::PublicKey;
44 use core::cell::RefCell;
46 use sync::{Arc, Mutex};
49 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
51 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
52 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
53 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
54 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
55 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
57 /// Mine a signle block containing the given transaction
58 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
59 let height = node.best_block_info().1 + 1;
60 confirm_transaction_at(node, tx, height);
62 /// Mine the given transaction at the given height, mining blocks as required to build to that
64 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
65 let first_connect_height = node.best_block_info().1 + 1;
66 assert!(first_connect_height <= conf_height);
67 if conf_height > first_connect_height {
68 connect_blocks(node, conf_height - first_connect_height);
70 let mut block = Block {
71 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
74 for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
75 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
77 block.txdata.push(tx.clone());
78 connect_block(node, &block);
81 /// The possible ways we may notify a ChannelManager of a new block
82 #[derive(Clone, Copy, PartialEq)]
83 pub enum ConnectStyle {
84 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
85 /// header and height information.
87 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
88 /// make a single best_block_updated call.
89 BestBlockFirstSkippingBlocks,
90 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
91 /// header and height information.
93 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
94 /// make a single best_block_updated call.
95 TransactionsFirstSkippingBlocks,
96 /// Provides the full block via the chain::Listen interface. In the current code this is
97 /// equivalent to TransactionsFirst with some additional assertions.
101 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
102 let skip_intermediaries = match *node.connect_style.borrow() {
103 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
107 let height = node.best_block_info().1 + 1;
108 let mut block = Block {
109 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
114 do_connect_block(node, &block, skip_intermediaries);
116 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
120 connect_block(node, &block);
121 block.header.block_hash()
124 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
125 do_connect_block(node, block, false);
128 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
129 let height = node.best_block_info().1 + 1;
130 if !skip_intermediaries {
131 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
132 match *node.connect_style.borrow() {
133 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
134 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
135 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
136 node.node.best_block_updated(&block.header, height);
137 node.node.transactions_confirmed(&block.header, &txdata, height);
139 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
140 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
141 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
142 node.node.transactions_confirmed(&block.header, &txdata, height);
143 node.node.best_block_updated(&block.header, height);
145 ConnectStyle::FullBlockViaListen => {
146 node.chain_monitor.chain_monitor.block_connected(&block, height);
147 node.node.block_connected(&block, height);
151 node.node.test_process_background_events();
152 node.blocks.lock().unwrap().push((block.header, height));
155 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
157 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
158 assert!(orig_header.1 > 0); // Cannot disconnect genesis
159 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
161 match *node.connect_style.borrow() {
162 ConnectStyle::FullBlockViaListen => {
163 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
164 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
166 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
168 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
169 node.node.best_block_updated(&prev_header.0, prev_header.1);
173 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
174 node.node.best_block_updated(&prev_header.0, prev_header.1);
180 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
181 let count = node.blocks.lock().unwrap().len() as u32 - 1;
182 disconnect_blocks(node, count);
185 pub struct TestChanMonCfg {
186 pub tx_broadcaster: test_utils::TestBroadcaster,
187 pub fee_estimator: test_utils::TestFeeEstimator,
188 pub chain_source: test_utils::TestChainSource,
189 pub persister: test_utils::TestPersister,
190 pub logger: test_utils::TestLogger,
191 pub keys_manager: test_utils::TestKeysInterface,
194 pub struct NodeCfg<'a> {
195 pub chain_source: &'a test_utils::TestChainSource,
196 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
197 pub fee_estimator: &'a test_utils::TestFeeEstimator,
198 pub chain_monitor: test_utils::TestChainMonitor<'a>,
199 pub keys_manager: &'a test_utils::TestKeysInterface,
200 pub logger: &'a test_utils::TestLogger,
201 pub node_seed: [u8; 32],
202 pub features: InitFeatures,
205 pub struct Node<'a, 'b: 'a, 'c: 'b> {
206 pub chain_source: &'c test_utils::TestChainSource,
207 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
208 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
209 pub keys_manager: &'b test_utils::TestKeysInterface,
210 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
211 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
212 pub node_seed: [u8; 32],
213 pub network_payment_count: Rc<RefCell<u8>>,
214 pub network_chan_count: Rc<RefCell<u32>>,
215 pub logger: &'c test_utils::TestLogger,
216 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
217 pub connect_style: Rc<RefCell<ConnectStyle>>,
219 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
220 pub fn best_block_hash(&self) -> BlockHash {
221 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
223 pub fn best_block_info(&self) -> (BlockHash, u32) {
224 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
226 pub fn get_block_header(&self, height: u32) -> BlockHeader {
227 self.blocks.lock().unwrap()[height as usize].0
231 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
233 if !::std::thread::panicking() {
234 // Check that we processed all pending events
235 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
236 assert!(self.node.get_and_clear_pending_events().is_empty());
237 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
239 // Check that if we serialize the Router, we can deserialize it again.
241 let mut w = test_utils::TestVecWriter(Vec::new());
242 let network_graph_ser = &self.net_graph_msg_handler.network_graph;
243 network_graph_ser.write(&mut w).unwrap();
244 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
245 assert!(network_graph_deser == self.net_graph_msg_handler.network_graph);
246 let net_graph_msg_handler = NetGraphMsgHandler::new(
247 network_graph_deser, Some(self.chain_source), self.logger
249 let mut chan_progress = 0;
251 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
252 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
253 assert!(orig_announcements == deserialized_announcements);
254 chan_progress = match orig_announcements.last() {
255 Some(announcement) => announcement.0.contents.short_channel_id + 1,
259 let mut node_progress = None;
261 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
262 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
263 assert!(orig_announcements == deserialized_announcements);
264 node_progress = match orig_announcements.last() {
265 Some(announcement) => Some(announcement.contents.node_id),
271 // Check that if we serialize and then deserialize all our channel monitors we get the
272 // same set of outputs to watch for on chain as we have now. Note that if we write
273 // tests that fully close channels and remove the monitors at some point this may break.
274 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
275 let mut deserialized_monitors = Vec::new();
277 let old_monitors = self.chain_monitor.chain_monitor.monitors.read().unwrap();
278 for (_, old_monitor) in old_monitors.iter() {
279 let mut w = test_utils::TestVecWriter(Vec::new());
280 old_monitor.write(&mut w).unwrap();
281 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
282 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
283 deserialized_monitors.push(deserialized_monitor);
287 // Before using all the new monitors to check the watch outpoints, use the full set of
288 // them to ensure we can write and reload our ChannelManager.
290 let mut channel_monitors = HashMap::new();
291 for monitor in deserialized_monitors.iter_mut() {
292 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
295 let mut w = test_utils::TestVecWriter(Vec::new());
296 self.node.write(&mut w).unwrap();
297 <(BlockHash, ChannelManager<EnforcingSigner, &test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
298 default_config: *self.node.get_current_default_configuration(),
299 keys_manager: self.keys_manager,
300 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
301 chain_monitor: self.chain_monitor,
302 tx_broadcaster: &test_utils::TestBroadcaster {
303 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
304 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
306 logger: &self.logger,
311 let persister = test_utils::TestPersister::new();
312 let broadcaster = test_utils::TestBroadcaster {
313 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
314 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
316 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
317 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
318 for deserialized_monitor in deserialized_monitors.drain(..) {
319 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
323 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
324 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
329 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) {
330 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
333 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) {
334 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);
335 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
336 (announcement, as_update, bs_update, channel_id, tx)
339 macro_rules! get_revoke_commit_msgs {
340 ($node: expr, $node_id: expr) => {
342 let events = $node.node.get_and_clear_pending_msg_events();
343 assert_eq!(events.len(), 2);
345 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
346 assert_eq!(*node_id, $node_id);
349 _ => panic!("Unexpected event"),
351 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
352 assert_eq!(*node_id, $node_id);
353 assert!(updates.update_add_htlcs.is_empty());
354 assert!(updates.update_fulfill_htlcs.is_empty());
355 assert!(updates.update_fail_htlcs.is_empty());
356 assert!(updates.update_fail_malformed_htlcs.is_empty());
357 assert!(updates.update_fee.is_none());
358 updates.commitment_signed.clone()
360 _ => panic!("Unexpected event"),
366 /// Get an specific event message from the pending events queue.
368 macro_rules! get_event_msg {
369 ($node: expr, $event_type: path, $node_id: expr) => {
371 let events = $node.node.get_and_clear_pending_msg_events();
372 assert_eq!(events.len(), 1);
374 $event_type { ref node_id, ref msg } => {
375 assert_eq!(*node_id, $node_id);
378 _ => panic!("Unexpected event"),
384 /// Get a specific event from the pending events queue.
386 macro_rules! get_event {
387 ($node: expr, $event_type: path) => {
389 let mut events = $node.node.get_and_clear_pending_events();
390 assert_eq!(events.len(), 1);
391 let ev = events.pop().unwrap();
393 $event_type { .. } => {
396 _ => panic!("Unexpected event"),
403 macro_rules! get_htlc_update_msgs {
404 ($node: expr, $node_id: expr) => {
406 let events = $node.node.get_and_clear_pending_msg_events();
407 assert_eq!(events.len(), 1);
409 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
410 assert_eq!(*node_id, $node_id);
413 _ => panic!("Unexpected event"),
420 macro_rules! get_channel_ref {
421 ($node: expr, $lock: ident, $channel_id: expr) => {
423 $lock = $node.node.channel_state.lock().unwrap();
424 $lock.by_id.get_mut(&$channel_id).unwrap()
430 macro_rules! get_feerate {
431 ($node: expr, $channel_id: expr) => {
434 let chan = get_channel_ref!($node, lock, $channel_id);
440 /// Returns any local commitment transactions for the channel.
442 macro_rules! get_local_commitment_txn {
443 ($node: expr, $channel_id: expr) => {
445 let monitors = $node.chain_monitor.chain_monitor.monitors.read().unwrap();
446 let mut commitment_txn = None;
447 for (funding_txo, monitor) in monitors.iter() {
448 if funding_txo.to_channel_id() == $channel_id {
449 commitment_txn = Some(monitor.unsafe_get_latest_holder_commitment_txn(&$node.logger));
453 commitment_txn.unwrap()
458 /// Check the error from attempting a payment.
460 macro_rules! unwrap_send_err {
461 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
463 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
464 assert_eq!(fails.len(), 1);
470 &Err(PaymentSendFailure::PartialFailure(ref fails)) if !$all_failed => {
471 assert_eq!(fails.len(), 1);
473 Err($type) => { $check },
482 /// Check whether N channel monitor(s) have been added.
484 macro_rules! check_added_monitors {
485 ($node: expr, $count: expr) => {
487 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
488 assert_eq!(added_monitors.len(), $count);
489 added_monitors.clear();
494 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) {
495 let chan_id = *node.network_chan_count.borrow();
497 let events = node.node.get_and_clear_pending_events();
498 assert_eq!(events.len(), 1);
500 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
501 assert_eq!(*channel_value_satoshis, expected_chan_value);
502 assert_eq!(user_channel_id, expected_user_chan_id);
504 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
505 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
507 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
508 (*temporary_channel_id, tx, funding_outpoint)
510 _ => panic!("Unexpected event"),
514 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 {
515 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
516 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()));
517 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()));
519 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
520 assert_eq!(temporary_channel_id, create_chan_id);
522 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
523 check_added_monitors!(node_a, 0);
525 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()));
527 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
528 assert_eq!(added_monitors.len(), 1);
529 assert_eq!(added_monitors[0].0, funding_output);
530 added_monitors.clear();
533 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()));
535 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
536 assert_eq!(added_monitors.len(), 1);
537 assert_eq!(added_monitors[0].0, funding_output);
538 added_monitors.clear();
541 let events_4 = node_a.node.get_and_clear_pending_events();
542 assert_eq!(events_4.len(), 0);
544 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
545 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
546 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
551 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, conf_height: u32) {
552 confirm_transaction_at(node_conf, tx, conf_height);
553 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
554 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()));
557 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]) {
559 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
560 assert_eq!(events_6.len(), 2);
561 ((match events_6[0] {
562 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
563 channel_id = msg.channel_id.clone();
564 assert_eq!(*node_id, node_recv.node.get_our_node_id());
567 _ => panic!("Unexpected event"),
568 }, match events_6[1] {
569 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
570 assert_eq!(*node_id, node_recv.node.get_our_node_id());
573 _ => panic!("Unexpected event"),
577 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]) {
578 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
579 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
580 confirm_transaction_at(node_a, tx, conf_height);
581 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
582 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
585 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) {
586 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
587 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
591 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) {
592 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
593 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
594 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
596 let events_7 = node_b.node.get_and_clear_pending_msg_events();
597 assert_eq!(events_7.len(), 1);
598 let (announcement, bs_update) = match events_7[0] {
599 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
602 _ => panic!("Unexpected event"),
605 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
606 let events_8 = node_a.node.get_and_clear_pending_msg_events();
607 assert_eq!(events_8.len(), 1);
608 let as_update = match events_8[0] {
609 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
610 assert!(*announcement == *msg);
611 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
612 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
615 _ => panic!("Unexpected event"),
618 *node_a.network_chan_count.borrow_mut() += 1;
620 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
623 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) {
624 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
627 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) {
628 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
629 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
630 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
633 pub fn update_nodes_with_chan_announce<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, ann: &msgs::ChannelAnnouncement, upd_1: &msgs::ChannelUpdate, upd_2: &msgs::ChannelUpdate) {
634 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
635 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
636 assert!(a_events.len() >= 2);
638 // ann should be re-generated by broadcast_node_announcement - check that we have it.
639 let mut found_ann_1 = false;
640 for event in a_events.iter() {
642 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
643 if msg == ann { found_ann_1 = true; }
645 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
646 _ => panic!("Unexpected event {:?}", event),
649 assert!(found_ann_1);
651 let a_node_announcement = match a_events.last().unwrap() {
652 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
655 _ => panic!("Unexpected event"),
658 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
659 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
660 assert!(b_events.len() >= 2);
662 // ann should be re-generated by broadcast_node_announcement - check that we have it.
663 let mut found_ann_2 = false;
664 for event in b_events.iter() {
666 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
667 if msg == ann { found_ann_2 = true; }
669 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
670 _ => panic!("Unexpected event"),
673 assert!(found_ann_2);
675 let b_node_announcement = match b_events.last().unwrap() {
676 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
679 _ => panic!("Unexpected event"),
683 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
684 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
685 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
686 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
687 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
691 macro_rules! check_spends {
692 ($tx: expr, $($spends_txn: expr),*) => {
694 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
696 if out_point.txid == $spends_txn.txid() {
697 return $spends_txn.output.get(out_point.vout as usize).cloned()
702 let mut total_value_in = 0;
703 for input in $tx.input.iter() {
704 total_value_in += get_output(&input.previous_output).unwrap().value;
706 let mut total_value_out = 0;
707 for output in $tx.output.iter() {
708 total_value_out += output.value;
710 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
711 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
712 assert!(total_value_out + min_fee <= total_value_in);
713 $tx.verify(get_output).unwrap();
718 macro_rules! get_closing_signed_broadcast {
719 ($node: expr, $dest_pubkey: expr) => {
721 let events = $node.get_and_clear_pending_msg_events();
722 assert!(events.len() == 1 || events.len() == 2);
723 (match events[events.len() - 1] {
724 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
725 assert_eq!(msg.contents.flags & 2, 2);
728 _ => panic!("Unexpected event"),
729 }, if events.len() == 2 {
731 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
732 assert_eq!(*node_id, $dest_pubkey);
735 _ => panic!("Unexpected event"),
742 /// Check that a channel's closing channel update has been broadcasted, and optionally
743 /// check whether an error message event has occurred.
745 macro_rules! check_closed_broadcast {
746 ($node: expr, $with_error_msg: expr) => {{
747 let msg_events = $node.node.get_and_clear_pending_msg_events();
748 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
749 match msg_events[0] {
750 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
751 assert_eq!(msg.contents.flags & 2, 2);
753 _ => panic!("Unexpected event"),
756 match msg_events[1] {
757 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
758 // TODO: Check node_id
761 _ => panic!("Unexpected event"),
767 /// Check that a channel's closing channel events has been issued
769 macro_rules! check_closed_event {
770 ($node: expr, $events: expr, $reason: expr) => {
771 check_closed_event!($node, $events, $reason, false);
773 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
774 let events = $node.node.get_and_clear_pending_events();
775 assert_eq!(events.len(), $events);
776 let expected_reason = $reason;
777 let mut issues_discard_funding = false;
778 for event in events {
780 Event::ChannelClosed { ref reason, .. } => {
781 assert_eq!(*reason, expected_reason);
783 Event::DiscardFunding { .. } => {
784 issues_discard_funding = true;
786 _ => panic!("Unexpected event"),
789 assert_eq!($is_check_discard_funding, issues_discard_funding);
793 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) {
794 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) };
795 let (node_b, broadcaster_b, struct_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) } else { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) };
798 node_a.close_channel(channel_id).unwrap();
799 node_b.handle_shutdown(&node_a.get_our_node_id(), &InitFeatures::known(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
801 let events_1 = node_b.get_and_clear_pending_msg_events();
802 assert!(events_1.len() >= 1);
803 let shutdown_b = match events_1[0] {
804 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
805 assert_eq!(node_id, &node_a.get_our_node_id());
808 _ => panic!("Unexpected event"),
811 let closing_signed_b = if !close_inbound_first {
812 assert_eq!(events_1.len(), 1);
815 Some(match events_1[1] {
816 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
817 assert_eq!(node_id, &node_a.get_our_node_id());
820 _ => panic!("Unexpected event"),
824 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
825 let (as_update, bs_update) = if close_inbound_first {
826 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
827 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
829 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
830 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
831 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
832 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
834 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
835 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
836 assert!(none_a.is_none());
837 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
838 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
839 (as_update, bs_update)
841 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
843 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
844 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
846 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
847 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
848 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
850 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
851 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
852 assert!(none_b.is_none());
853 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
854 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
855 (as_update, bs_update)
857 assert_eq!(tx_a, tx_b);
858 check_spends!(tx_a, funding_tx);
860 (as_update, bs_update, tx_a)
863 pub struct SendEvent {
864 pub node_id: PublicKey,
865 pub msgs: Vec<msgs::UpdateAddHTLC>,
866 pub commitment_msg: msgs::CommitmentSigned,
869 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
870 assert!(updates.update_fulfill_htlcs.is_empty());
871 assert!(updates.update_fail_htlcs.is_empty());
872 assert!(updates.update_fail_malformed_htlcs.is_empty());
873 assert!(updates.update_fee.is_none());
874 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
877 pub fn from_event(event: MessageSendEvent) -> SendEvent {
879 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
880 _ => panic!("Unexpected event type!"),
884 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
885 let mut events = node.node.get_and_clear_pending_msg_events();
886 assert_eq!(events.len(), 1);
887 SendEvent::from_event(events.pop().unwrap())
891 macro_rules! commitment_signed_dance {
892 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
894 check_added_monitors!($node_a, 0);
895 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
896 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
897 check_added_monitors!($node_a, 1);
898 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
901 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
903 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
904 check_added_monitors!($node_b, 0);
905 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
906 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
907 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
908 check_added_monitors!($node_b, 1);
909 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
910 let (bs_revoke_and_ack, extra_msg_option) = {
911 let events = $node_b.node.get_and_clear_pending_msg_events();
912 assert!(events.len() <= 2);
914 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
915 assert_eq!(*node_id, $node_a.node.get_our_node_id());
918 _ => panic!("Unexpected event"),
919 }, events.get(1).map(|e| e.clone()))
921 check_added_monitors!($node_b, 1);
923 assert!($node_a.node.get_and_clear_pending_events().is_empty());
924 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
926 (extra_msg_option, bs_revoke_and_ack)
929 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
931 check_added_monitors!($node_a, 0);
932 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
933 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
934 check_added_monitors!($node_a, 1);
935 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
936 assert!(extra_msg_option.is_none());
940 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
942 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
943 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
944 check_added_monitors!($node_a, 1);
948 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
950 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
953 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
955 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
957 expect_pending_htlcs_forwardable!($node_a);
958 check_added_monitors!($node_a, 1);
960 let channel_state = $node_a.node.channel_state.lock().unwrap();
961 assert_eq!(channel_state.pending_msg_events.len(), 1);
962 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
963 assert_ne!(*node_id, $node_b.node.get_our_node_id());
964 } else { panic!("Unexpected event"); }
966 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
972 /// Get a payment preimage and hash.
974 macro_rules! get_payment_preimage_hash {
975 ($dest_node: expr) => {
977 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
978 let payment_preimage = PaymentPreimage([*payment_count; 32]);
980 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
981 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, None, 7200, 0).unwrap();
982 (payment_preimage, payment_hash, payment_secret)
988 macro_rules! get_route_and_payment_hash {
989 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
990 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node);
991 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
992 let route = get_route(&$send_node.node.get_our_node_id(),
993 &net_graph_msg_handler.network_graph,
994 &$recv_node.node.get_our_node_id(), None,
995 Some(&$send_node.node.list_usable_channels().iter().map(|a| a).collect::<Vec<_>>()),
996 &Vec::new(), $recv_value, TEST_FINAL_CLTV, $send_node.logger).unwrap();
997 (route, payment_hash, payment_preimage, payment_secret)
1001 macro_rules! expect_pending_htlcs_forwardable_ignore {
1003 let events = $node.node.get_and_clear_pending_events();
1004 assert_eq!(events.len(), 1);
1006 Event::PendingHTLCsForwardable { .. } => { },
1007 _ => panic!("Unexpected event"),
1012 macro_rules! expect_pending_htlcs_forwardable {
1014 expect_pending_htlcs_forwardable_ignore!($node);
1015 $node.node.process_pending_htlc_forwards();
1020 macro_rules! expect_pending_htlcs_forwardable_from_events {
1021 ($node: expr, $events: expr, $ignore: expr) => {{
1022 assert_eq!($events.len(), 1);
1024 Event::PendingHTLCsForwardable { .. } => { },
1025 _ => panic!("Unexpected event"),
1028 $node.node.process_pending_htlc_forwards();
1033 #[cfg(any(test, feature = "unstable"))]
1034 macro_rules! expect_payment_received {
1035 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1036 let events = $node.node.get_and_clear_pending_events();
1037 assert_eq!(events.len(), 1);
1039 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1040 assert_eq!($expected_payment_hash, *payment_hash);
1041 assert_eq!($expected_recv_value, amt);
1043 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1044 assert!(payment_preimage.is_none());
1045 assert_eq!($expected_payment_secret, *payment_secret);
1050 _ => panic!("Unexpected event"),
1055 macro_rules! expect_payment_sent {
1056 ($node: expr, $expected_payment_preimage: expr) => {
1057 let events = $node.node.get_and_clear_pending_events();
1058 let expected_payment_hash = PaymentHash(Sha256::hash(&$expected_payment_preimage.0).into_inner());
1059 assert_eq!(events.len(), 1);
1061 Event::PaymentSent { ref payment_preimage, ref payment_hash } => {
1062 assert_eq!($expected_payment_preimage, *payment_preimage);
1063 assert_eq!(expected_payment_hash, *payment_hash);
1065 _ => panic!("Unexpected event"),
1070 macro_rules! expect_payment_forwarded {
1071 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1072 let events = $node.node.get_and_clear_pending_events();
1073 assert_eq!(events.len(), 1);
1075 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1076 assert_eq!(fee_earned_msat, $expected_fee);
1077 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1079 _ => panic!("Unexpected event"),
1085 macro_rules! expect_payment_failed_with_update {
1086 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1087 let events = $node.node.get_and_clear_pending_events();
1088 assert_eq!(events.len(), 1);
1090 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, .. } => {
1091 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1092 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1093 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1094 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1095 match network_update {
1096 &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1097 assert_eq!(msg.contents.short_channel_id, $scid);
1098 assert_eq!(msg.contents.flags & 2, 0);
1100 &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1101 assert_eq!(short_channel_id, $scid);
1102 assert!(is_permanent);
1104 Some(_) => panic!("Unexpected update type"),
1105 None => panic!("Expected update"),
1108 _ => panic!("Unexpected event"),
1114 macro_rules! expect_payment_failed {
1115 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1116 let events = $node.node.get_and_clear_pending_events();
1117 assert_eq!(events.len(), 1);
1119 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, .. } => {
1120 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1121 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1122 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1123 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1125 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1126 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1129 _ => panic!("Unexpected event"),
1134 pub fn send_along_route_with_secret<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, route: Route, expected_paths: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) {
1135 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1136 check_added_monitors!(origin_node, expected_paths.len());
1137 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1140 pub fn pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: Option<PaymentSecret>, ev: MessageSendEvent, payment_received_expected: bool, expected_preimage: Option<PaymentPreimage>) {
1141 let mut payment_event = SendEvent::from_event(ev);
1142 let mut prev_node = origin_node;
1144 for (idx, &node) in expected_path.iter().enumerate() {
1145 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1147 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1148 check_added_monitors!(node, 0);
1149 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1151 expect_pending_htlcs_forwardable!(node);
1153 if idx == expected_path.len() - 1 {
1154 let events_2 = node.node.get_and_clear_pending_events();
1155 if payment_received_expected {
1156 assert_eq!(events_2.len(), 1);
1158 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1159 assert_eq!(our_payment_hash, *payment_hash);
1161 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1162 assert_eq!(expected_preimage, *payment_preimage);
1163 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1165 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1166 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1167 assert!(our_payment_secret.is_none());
1170 assert_eq!(amt, recv_value);
1172 _ => panic!("Unexpected event"),
1175 assert!(events_2.is_empty());
1178 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1179 assert_eq!(events_2.len(), 1);
1180 check_added_monitors!(node, 1);
1181 payment_event = SendEvent::from_event(events_2.remove(0));
1182 assert_eq!(payment_event.msgs.len(), 1);
1189 pub fn pass_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: PaymentSecret) {
1190 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1191 assert_eq!(events.len(), expected_route.len());
1192 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1193 // Once we've gotten through all the HTLCs, the last one should result in a
1194 // PaymentReceived (but each previous one should not!), .
1195 let expect_payment = path_idx == expected_route.len() - 1;
1196 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1200 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, PaymentSecret) {
1201 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1202 send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1203 (our_payment_preimage, our_payment_hash, our_payment_secret)
1206 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) {
1207 for path in expected_paths.iter() {
1208 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1210 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1211 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1213 macro_rules! msgs_from_ev {
1216 &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 } } => {
1217 assert!(update_add_htlcs.is_empty());
1218 assert_eq!(update_fulfill_htlcs.len(), 1);
1219 assert!(update_fail_htlcs.is_empty());
1220 assert!(update_fail_malformed_htlcs.is_empty());
1221 assert!(update_fee.is_none());
1222 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1224 _ => panic!("Unexpected event"),
1228 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1229 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1230 assert_eq!(events.len(), expected_paths.len());
1231 for ev in events.iter() {
1232 per_path_msgs.push(msgs_from_ev!(ev));
1235 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1236 let mut next_msgs = Some(path_msgs);
1237 let mut expected_next_node = next_hop;
1239 macro_rules! last_update_fulfill_dance {
1240 ($node: expr, $prev_node: expr) => {
1242 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1243 check_added_monitors!($node, 0);
1244 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1245 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1249 macro_rules! mid_update_fulfill_dance {
1250 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1252 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1253 let fee = $node.node.channel_state.lock().unwrap().by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap().config.forwarding_fee_base_msat;
1254 expect_payment_forwarded!($node, Some(fee as u64), false);
1255 check_added_monitors!($node, 1);
1256 let new_next_msgs = if $new_msgs {
1257 let events = $node.node.get_and_clear_pending_msg_events();
1258 assert_eq!(events.len(), 1);
1259 let (res, nexthop) = msgs_from_ev!(&events[0]);
1260 expected_next_node = nexthop;
1263 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1266 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1267 next_msgs = new_next_msgs;
1272 let mut prev_node = expected_route.last().unwrap();
1273 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1274 assert_eq!(expected_next_node, node.node.get_our_node_id());
1275 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1276 if next_msgs.is_some() {
1277 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1279 assert!(!update_next_msgs);
1280 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1282 if !skip_last && idx == expected_route.len() - 1 {
1283 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1290 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1294 expect_payment_sent!(origin_node, our_payment_preimage);
1298 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1299 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1302 pub const TEST_FINAL_CLTV: u32 = 70;
1304 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1305 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1306 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph,
1307 &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()),
1308 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()), &[],
1309 recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
1310 assert_eq!(route.paths.len(), 1);
1311 assert_eq!(route.paths[0].len(), expected_route.len());
1312 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1313 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1316 send_along_route(origin_node, route, expected_route, recv_value)
1319 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1320 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1321 let route = get_route(&origin_node.node.get_our_node_id(), &net_graph_msg_handler.network_graph, &expected_route.last().unwrap().node.get_our_node_id(), Some(InvoiceFeatures::known()), None, &Vec::new(), recv_value, TEST_FINAL_CLTV, origin_node.logger).unwrap();
1322 assert_eq!(route.paths.len(), 1);
1323 assert_eq!(route.paths[0].len(), expected_route.len());
1324 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1325 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1328 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1329 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1330 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1333 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1334 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1335 claim_payment(&origin, expected_route, our_payment_preimage);
1338 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1339 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1340 for path in expected_paths.iter() {
1341 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1343 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1344 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1345 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1347 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1348 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1349 assert_eq!(events.len(), expected_paths.len());
1350 for ev in events.iter() {
1351 let (update_fail, commitment_signed, node_id) = match ev {
1352 &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 } } => {
1353 assert!(update_add_htlcs.is_empty());
1354 assert!(update_fulfill_htlcs.is_empty());
1355 assert_eq!(update_fail_htlcs.len(), 1);
1356 assert!(update_fail_malformed_htlcs.is_empty());
1357 assert!(update_fee.is_none());
1358 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1360 _ => panic!("Unexpected event"),
1362 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1364 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1365 expected_paths.sort_unstable_by(|path_a, path_b| path_a[path_a.len() - 2].node.get_our_node_id().cmp(&path_b[path_b.len() - 2].node.get_our_node_id()));
1367 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1368 let mut next_msgs = Some(path_msgs);
1369 let mut expected_next_node = next_hop;
1370 let mut prev_node = expected_route.last().unwrap();
1372 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1373 assert_eq!(expected_next_node, node.node.get_our_node_id());
1374 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1375 if next_msgs.is_some() {
1376 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1377 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1378 if !update_next_node {
1379 expect_pending_htlcs_forwardable!(node);
1382 let events = node.node.get_and_clear_pending_msg_events();
1383 if update_next_node {
1384 assert_eq!(events.len(), 1);
1386 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 } } => {
1387 assert!(update_add_htlcs.is_empty());
1388 assert!(update_fulfill_htlcs.is_empty());
1389 assert_eq!(update_fail_htlcs.len(), 1);
1390 assert!(update_fail_malformed_htlcs.is_empty());
1391 assert!(update_fee.is_none());
1392 expected_next_node = node_id.clone();
1393 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1395 _ => panic!("Unexpected event"),
1398 assert!(events.is_empty());
1400 if !skip_last && idx == expected_route.len() - 1 {
1401 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1408 let prev_node = expected_route.first().unwrap();
1409 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1410 check_added_monitors!(origin_node, 0);
1411 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1412 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1413 let events = origin_node.node.get_and_clear_pending_events();
1414 assert_eq!(events.len(), 1);
1416 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1417 assert_eq!(payment_hash, our_payment_hash);
1418 assert!(rejected_by_dest);
1419 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1420 for (idx, hop) in expected_route.iter().enumerate() {
1421 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1424 _ => panic!("Unexpected event"),
1430 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1431 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1434 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1435 let mut chan_mon_cfgs = Vec::new();
1436 for i in 0..node_count {
1437 let tx_broadcaster = test_utils::TestBroadcaster {
1438 txn_broadcasted: Mutex::new(Vec::new()),
1439 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1441 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1442 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1443 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1444 let persister = test_utils::TestPersister::new();
1445 let seed = [i as u8; 32];
1446 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1448 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1454 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1455 let mut nodes = Vec::new();
1457 for i in 0..node_count {
1458 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
1459 let seed = [i as u8; 32];
1460 nodes.push(NodeCfg {
1461 chain_source: &chanmon_cfgs[i].chain_source,
1462 logger: &chanmon_cfgs[i].logger,
1463 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1464 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1466 keys_manager: &chanmon_cfgs[i].keys_manager,
1468 features: InitFeatures::known(),
1475 pub fn test_default_channel_config() -> UserConfig {
1476 let mut default_config = UserConfig::default();
1477 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1478 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1479 default_config.channel_options.cltv_expiry_delta = 6*6;
1480 default_config.channel_options.announced_channel = true;
1481 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1482 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1483 // It now defaults to 1, so we simply set it to the expected value here.
1484 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1485 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1486 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1487 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1491 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<EnforcingSigner, &'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'b test_utils::TestLogger>> {
1492 let mut chanmgrs = Vec::new();
1493 for i in 0..node_count {
1494 let network = Network::Testnet;
1495 let params = ChainParameters {
1497 best_block: BestBlock::from_genesis(network),
1499 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1500 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1501 chanmgrs.push(node);
1507 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
1508 let mut nodes = Vec::new();
1509 let chan_count = Rc::new(RefCell::new(0));
1510 let payment_count = Rc::new(RefCell::new(0));
1511 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1513 for i in 0..node_count {
1514 let network_graph = NetworkGraph::new(cfgs[i].chain_source.genesis_hash);
1515 let net_graph_msg_handler = NetGraphMsgHandler::new(network_graph, None, cfgs[i].logger);
1516 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1517 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1518 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1519 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1520 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1521 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1522 connect_style: Rc::clone(&connect_style),
1526 for i in 0..node_count {
1527 for j in (i+1)..node_count {
1528 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1529 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1536 // Note that the following only works for CLTV values up to 128
1537 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1538 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1540 #[derive(PartialEq)]
1541 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1542 /// Tests that the given node has broadcast transactions for the given Channel
1544 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1545 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1546 /// broadcast and the revoked outputs were claimed.
1548 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1549 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1551 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1553 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> {
1554 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1555 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1557 let mut res = Vec::with_capacity(2);
1558 node_txn.retain(|tx| {
1559 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1560 check_spends!(tx, chan.3);
1561 if commitment_tx.is_none() {
1562 res.push(tx.clone());
1567 if let Some(explicit_tx) = commitment_tx {
1568 res.push(explicit_tx.clone());
1571 assert_eq!(res.len(), 1);
1573 if has_htlc_tx != HTLCType::NONE {
1574 node_txn.retain(|tx| {
1575 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1576 check_spends!(tx, res[0]);
1577 if has_htlc_tx == HTLCType::TIMEOUT {
1578 assert!(tx.lock_time != 0);
1580 assert!(tx.lock_time == 0);
1582 res.push(tx.clone());
1586 assert!(res.len() == 2 || res.len() == 3);
1588 assert_eq!(res[1], res[2]);
1592 assert!(node_txn.is_empty());
1596 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1597 /// HTLC transaction.
1598 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1599 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1600 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1601 // for revoked htlc outputs
1602 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1603 node_txn.retain(|tx| {
1604 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1605 check_spends!(tx, revoked_tx);
1609 node_txn.retain(|tx| {
1610 check_spends!(tx, commitment_revoked_tx);
1613 assert!(node_txn.is_empty());
1616 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1617 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1619 assert!(node_txn.len() >= 1);
1620 assert_eq!(node_txn[0].input.len(), 1);
1621 let mut found_prev = false;
1623 for tx in prev_txn {
1624 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1625 check_spends!(node_txn[0], tx);
1626 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1627 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1633 assert!(found_prev);
1635 let mut res = Vec::new();
1636 mem::swap(&mut *node_txn, &mut res);
1640 pub fn handle_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize, needs_err_handle: bool, expected_error: &str) {
1641 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1642 assert_eq!(events_1.len(), 2);
1643 let as_update = match events_1[0] {
1644 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1647 _ => panic!("Unexpected event"),
1650 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1651 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1652 assert_eq!(msg.data, expected_error);
1653 if needs_err_handle {
1654 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1657 _ => panic!("Unexpected event"),
1660 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1661 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1662 let bs_update = match events_2[0] {
1663 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1666 _ => panic!("Unexpected event"),
1668 if !needs_err_handle {
1670 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1671 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1672 assert_eq!(msg.data, expected_error);
1674 _ => panic!("Unexpected event"),
1679 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1680 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1684 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1685 handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1689 macro_rules! get_channel_value_stat {
1690 ($node: expr, $channel_id: expr) => {{
1691 let chan_lock = $node.node.channel_state.lock().unwrap();
1692 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1693 chan.get_value_stat()
1697 macro_rules! get_chan_reestablish_msgs {
1698 ($src_node: expr, $dst_node: expr) => {
1700 let mut res = Vec::with_capacity(1);
1701 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1702 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1703 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1704 res.push(msg.clone());
1706 panic!("Unexpected event")
1714 macro_rules! handle_chan_reestablish_msgs {
1715 ($src_node: expr, $dst_node: expr) => {
1717 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1719 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1721 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1727 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1729 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1732 let mut revoke_and_ack = None;
1733 let mut commitment_update = None;
1734 let order = if let Some(ev) = msg_events.get(idx) {
1736 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1737 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1738 revoke_and_ack = Some(msg.clone());
1740 RAACommitmentOrder::RevokeAndACKFirst
1742 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1743 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1744 commitment_update = Some(updates.clone());
1746 RAACommitmentOrder::CommitmentFirst
1748 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1749 _ => panic!("Unexpected event"),
1752 RAACommitmentOrder::CommitmentFirst
1755 if let Some(ev) = msg_events.get(idx) {
1757 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1758 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1759 assert!(revoke_and_ack.is_none());
1760 revoke_and_ack = Some(msg.clone());
1763 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1764 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1765 assert!(commitment_update.is_none());
1766 commitment_update = Some(updates.clone());
1769 &MessageSendEvent::SendChannelUpdate { .. } => {},
1770 _ => panic!("Unexpected event"),
1774 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1775 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1776 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1779 (funding_locked, revoke_and_ack, commitment_update, order)
1784 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1785 /// for claims/fails they are separated out.
1786 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_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
1787 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1788 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1789 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1790 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1792 if send_funding_locked.0 {
1793 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1795 for reestablish in reestablish_1.iter() {
1796 assert_eq!(reestablish.next_remote_commitment_number, 0);
1799 if send_funding_locked.1 {
1800 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1802 for reestablish in reestablish_2.iter() {
1803 assert_eq!(reestablish.next_remote_commitment_number, 0);
1806 if send_funding_locked.0 || send_funding_locked.1 {
1807 // If we expect any funding_locked's, both sides better have set
1808 // next_holder_commitment_number to 1
1809 for reestablish in reestablish_1.iter() {
1810 assert_eq!(reestablish.next_local_commitment_number, 1);
1812 for reestablish in reestablish_2.iter() {
1813 assert_eq!(reestablish.next_local_commitment_number, 1);
1817 let mut resp_1 = Vec::new();
1818 for msg in reestablish_1 {
1819 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1820 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1822 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1823 check_added_monitors!(node_b, 1);
1825 check_added_monitors!(node_b, 0);
1828 let mut resp_2 = Vec::new();
1829 for msg in reestablish_2 {
1830 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1831 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1833 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1834 check_added_monitors!(node_a, 1);
1836 check_added_monitors!(node_a, 0);
1839 // We don't yet support both needing updates, as that would require a different commitment dance:
1840 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1841 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1842 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1843 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1845 for chan_msgs in resp_1.drain(..) {
1846 if send_funding_locked.0 {
1847 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1848 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1849 if !announcement_event.is_empty() {
1850 assert_eq!(announcement_event.len(), 1);
1851 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1852 //TODO: Test announcement_sigs re-sending
1853 } else { panic!("Unexpected event!"); }
1856 assert!(chan_msgs.0.is_none());
1859 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1860 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1861 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1862 check_added_monitors!(node_a, 1);
1864 assert!(chan_msgs.1.is_none());
1866 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1867 let commitment_update = chan_msgs.2.unwrap();
1868 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1869 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1871 assert!(commitment_update.update_add_htlcs.is_empty());
1873 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1874 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1875 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1876 for update_add in commitment_update.update_add_htlcs {
1877 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1879 for update_fulfill in commitment_update.update_fulfill_htlcs {
1880 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1882 for update_fail in commitment_update.update_fail_htlcs {
1883 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1886 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1887 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1889 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1890 check_added_monitors!(node_a, 1);
1891 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1892 // No commitment_signed so get_event_msg's assert(len == 1) passes
1893 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1894 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1895 check_added_monitors!(node_b, 1);
1898 assert!(chan_msgs.2.is_none());
1902 for chan_msgs in resp_2.drain(..) {
1903 if send_funding_locked.1 {
1904 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1905 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1906 if !announcement_event.is_empty() {
1907 assert_eq!(announcement_event.len(), 1);
1908 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1909 //TODO: Test announcement_sigs re-sending
1910 } else { panic!("Unexpected event!"); }
1913 assert!(chan_msgs.0.is_none());
1916 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1917 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1918 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1919 check_added_monitors!(node_b, 1);
1921 assert!(chan_msgs.1.is_none());
1923 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1924 let commitment_update = chan_msgs.2.unwrap();
1925 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1926 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1928 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
1929 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
1930 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1931 for update_add in commitment_update.update_add_htlcs {
1932 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1934 for update_fulfill in commitment_update.update_fulfill_htlcs {
1935 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1937 for update_fail in commitment_update.update_fail_htlcs {
1938 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1941 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1942 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1944 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
1945 check_added_monitors!(node_b, 1);
1946 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
1947 // No commitment_signed so get_event_msg's assert(len == 1) passes
1948 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1949 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1950 check_added_monitors!(node_a, 1);
1953 assert!(chan_msgs.2.is_none());