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, PaymentId};
18 use routing::network_graph::{NetGraphMsgHandler, NetworkGraph};
19 use routing::router::{Payee, Route, get_route};
20 use routing::scorer::Scorer;
21 use ln::features::{InitFeatures, InvoiceFeatures};
23 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
24 use util::enforcing_trait_impls::EnforcingSigner;
26 use util::test_utils::TestChainMonitor;
27 use util::events::{Event, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
28 use util::errors::APIError;
29 use util::config::UserConfig;
30 use util::ser::{ReadableArgs, Writeable, Readable};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::constants::genesis_block;
34 use bitcoin::blockdata::transaction::{Transaction, TxOut};
35 use bitcoin::network::constants::Network;
37 use bitcoin::hashes::sha256::Hash as Sha256;
38 use bitcoin::hashes::Hash;
39 use bitcoin::hash_types::BlockHash;
41 use bitcoin::secp256k1::key::PublicKey;
45 use core::cell::RefCell;
47 use sync::{Arc, Mutex};
50 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
52 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
53 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
54 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
55 confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
56 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
58 /// Mine a signle block containing the given transaction
59 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
60 let height = node.best_block_info().1 + 1;
61 confirm_transaction_at(node, tx, height);
63 /// Mine the given transaction at the given height, mining blocks as required to build to that
65 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) {
66 let first_connect_height = node.best_block_info().1 + 1;
67 assert!(first_connect_height <= conf_height);
68 if conf_height > first_connect_height {
69 connect_blocks(node, conf_height - first_connect_height);
71 let mut block = Block {
72 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: conf_height, bits: 42, nonce: 42 },
75 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
76 block.txdata.push(Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() });
78 block.txdata.push(tx.clone());
79 connect_block(node, &block);
82 /// The possible ways we may notify a ChannelManager of a new block
83 #[derive(Clone, Copy, PartialEq)]
84 pub enum ConnectStyle {
85 /// Calls best_block_updated first, detecting transactions in the block only after receiving the
86 /// header and height information.
88 /// The same as BestBlockFirst, however when we have multiple blocks to connect, we only
89 /// make a single best_block_updated call.
90 BestBlockFirstSkippingBlocks,
91 /// Calls transactions_confirmed first, detecting transactions in the block before updating the
92 /// header and height information.
94 /// The same as TransactionsFirst, however when we have multiple blocks to connect, we only
95 /// make a single best_block_updated call.
96 TransactionsFirstSkippingBlocks,
97 /// Provides the full block via the chain::Listen interface. In the current code this is
98 /// equivalent to TransactionsFirst with some additional assertions.
102 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
103 let skip_intermediaries = match *node.connect_style.borrow() {
104 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => true,
108 let height = node.best_block_info().1 + 1;
109 let mut block = Block {
110 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: Default::default(), time: height, bits: 42, nonce: 42 },
115 do_connect_block(node, &block, skip_intermediaries);
117 header: BlockHeader { version: 0x20000000, prev_blockhash: block.header.block_hash(), merkle_root: Default::default(), time: height + i, bits: 42, nonce: 42 },
121 connect_block(node, &block);
122 block.header.block_hash()
125 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
126 do_connect_block(node, block, false);
129 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block, skip_intermediaries: bool) {
130 let height = node.best_block_info().1 + 1;
131 if !skip_intermediaries {
132 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
133 match *node.connect_style.borrow() {
134 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks => {
135 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
136 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
137 node.node.best_block_updated(&block.header, height);
138 node.node.transactions_confirmed(&block.header, &txdata, height);
140 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks => {
141 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
142 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
143 node.node.transactions_confirmed(&block.header, &txdata, height);
144 node.node.best_block_updated(&block.header, height);
146 ConnectStyle::FullBlockViaListen => {
147 node.chain_monitor.chain_monitor.block_connected(&block, height);
148 node.node.block_connected(&block, height);
152 node.node.test_process_background_events();
153 node.blocks.lock().unwrap().push((block.header, height));
156 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
158 let orig_header = node.blocks.lock().unwrap().pop().unwrap();
159 assert!(orig_header.1 > 0); // Cannot disconnect genesis
160 let prev_header = node.blocks.lock().unwrap().last().unwrap().clone();
162 match *node.connect_style.borrow() {
163 ConnectStyle::FullBlockViaListen => {
164 node.chain_monitor.chain_monitor.block_disconnected(&orig_header.0, orig_header.1);
165 Listen::block_disconnected(node.node, &orig_header.0, orig_header.1);
167 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
169 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
170 node.node.best_block_updated(&prev_header.0, prev_header.1);
174 node.chain_monitor.chain_monitor.best_block_updated(&prev_header.0, prev_header.1);
175 node.node.best_block_updated(&prev_header.0, prev_header.1);
181 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
182 let count = node.blocks.lock().unwrap().len() as u32 - 1;
183 disconnect_blocks(node, count);
186 pub struct TestChanMonCfg {
187 pub tx_broadcaster: test_utils::TestBroadcaster,
188 pub fee_estimator: test_utils::TestFeeEstimator,
189 pub chain_source: test_utils::TestChainSource,
190 pub persister: test_utils::TestPersister,
191 pub logger: test_utils::TestLogger,
192 pub keys_manager: test_utils::TestKeysInterface,
195 pub struct NodeCfg<'a> {
196 pub chain_source: &'a test_utils::TestChainSource,
197 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
198 pub fee_estimator: &'a test_utils::TestFeeEstimator,
199 pub chain_monitor: test_utils::TestChainMonitor<'a>,
200 pub keys_manager: &'a test_utils::TestKeysInterface,
201 pub logger: &'a test_utils::TestLogger,
202 pub node_seed: [u8; 32],
203 pub features: InitFeatures,
206 pub struct Node<'a, 'b: 'a, 'c: 'b> {
207 pub chain_source: &'c test_utils::TestChainSource,
208 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
209 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
210 pub keys_manager: &'b test_utils::TestKeysInterface,
211 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
212 pub net_graph_msg_handler: NetGraphMsgHandler<&'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
213 pub node_seed: [u8; 32],
214 pub network_payment_count: Rc<RefCell<u8>>,
215 pub network_chan_count: Rc<RefCell<u32>>,
216 pub logger: &'c test_utils::TestLogger,
217 pub blocks: Arc<Mutex<Vec<(BlockHeader, u32)>>>,
218 pub connect_style: Rc<RefCell<ConnectStyle>>,
220 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
221 pub fn best_block_hash(&self) -> BlockHash {
222 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
224 pub fn best_block_info(&self) -> (BlockHash, u32) {
225 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
227 pub fn get_block_header(&self, height: u32) -> BlockHeader {
228 self.blocks.lock().unwrap()[height as usize].0
232 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
234 if !::std::thread::panicking() {
235 // Check that we processed all pending events
236 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
237 assert!(self.node.get_and_clear_pending_events().is_empty());
238 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
240 // Check that if we serialize the Router, we can deserialize it again.
242 let mut w = test_utils::TestVecWriter(Vec::new());
243 let network_graph_ser = &self.net_graph_msg_handler.network_graph;
244 network_graph_ser.write(&mut w).unwrap();
245 let network_graph_deser = <NetworkGraph>::read(&mut io::Cursor::new(&w.0)).unwrap();
246 assert!(network_graph_deser == self.net_graph_msg_handler.network_graph);
247 let net_graph_msg_handler = NetGraphMsgHandler::new(
248 network_graph_deser, Some(self.chain_source), self.logger
250 let mut chan_progress = 0;
252 let orig_announcements = self.net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
253 let deserialized_announcements = net_graph_msg_handler.get_next_channel_announcements(chan_progress, 255);
254 assert!(orig_announcements == deserialized_announcements);
255 chan_progress = match orig_announcements.last() {
256 Some(announcement) => announcement.0.contents.short_channel_id + 1,
260 let mut node_progress = None;
262 let orig_announcements = self.net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
263 let deserialized_announcements = net_graph_msg_handler.get_next_node_announcements(node_progress.as_ref(), 255);
264 assert!(orig_announcements == deserialized_announcements);
265 node_progress = match orig_announcements.last() {
266 Some(announcement) => Some(announcement.contents.node_id),
272 // Check that if we serialize and then deserialize all our channel monitors we get the
273 // same set of outputs to watch for on chain as we have now. Note that if we write
274 // tests that fully close channels and remove the monitors at some point this may break.
275 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
276 let mut deserialized_monitors = Vec::new();
278 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
279 let mut w = test_utils::TestVecWriter(Vec::new());
280 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().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 a channel monitor given a channel id, making some naive assumptions
442 macro_rules! get_monitor {
443 ($node: expr, $channel_id: expr) => {
445 use bitcoin::hashes::Hash;
446 let mut monitor = None;
447 // Assume funding vout is either 0 or 1 blindly
449 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
450 $crate::chain::transaction::OutPoint {
451 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
463 /// Returns any local commitment transactions for the channel.
465 macro_rules! get_local_commitment_txn {
466 ($node: expr, $channel_id: expr) => {
468 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
473 /// Check the error from attempting a payment.
475 macro_rules! unwrap_send_err {
476 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
478 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
479 assert_eq!(fails.len(), 1);
485 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
486 assert_eq!(results.len(), 1);
488 Err($type) => { $check },
497 /// Check whether N channel monitor(s) have been added.
499 macro_rules! check_added_monitors {
500 ($node: expr, $count: expr) => {
502 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
503 assert_eq!(added_monitors.len(), $count);
504 added_monitors.clear();
509 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) {
510 let chan_id = *node.network_chan_count.borrow();
512 let events = node.node.get_and_clear_pending_events();
513 assert_eq!(events.len(), 1);
515 Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
516 assert_eq!(*channel_value_satoshis, expected_chan_value);
517 assert_eq!(user_channel_id, expected_user_chan_id);
519 let tx = Transaction { version: chan_id as i32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
520 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
522 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
523 (*temporary_channel_id, tx, funding_outpoint)
525 _ => panic!("Unexpected event"),
529 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 {
530 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
531 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()));
532 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()));
534 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, channel_value, 42);
535 assert_eq!(temporary_channel_id, create_chan_id);
537 node_a.node.funding_transaction_generated(&temporary_channel_id, tx.clone()).unwrap();
538 check_added_monitors!(node_a, 0);
540 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()));
542 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
543 assert_eq!(added_monitors.len(), 1);
544 assert_eq!(added_monitors[0].0, funding_output);
545 added_monitors.clear();
548 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()));
550 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
551 assert_eq!(added_monitors.len(), 1);
552 assert_eq!(added_monitors[0].0, funding_output);
553 added_monitors.clear();
556 let events_4 = node_a.node.get_and_clear_pending_events();
557 assert_eq!(events_4.len(), 0);
559 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
560 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
561 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
566 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) {
567 confirm_transaction_at(node_conf, tx, conf_height);
568 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
569 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()));
572 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]) {
574 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
575 assert_eq!(events_6.len(), 2);
576 ((match events_6[0] {
577 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
578 channel_id = msg.channel_id.clone();
579 assert_eq!(*node_id, node_recv.node.get_our_node_id());
582 _ => panic!("Unexpected event"),
583 }, match events_6[1] {
584 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
585 assert_eq!(*node_id, node_recv.node.get_our_node_id());
588 _ => panic!("Unexpected event"),
592 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]) {
593 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
594 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
595 confirm_transaction_at(node_a, tx, conf_height);
596 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
597 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
600 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) {
601 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
602 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
606 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) {
607 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
608 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
609 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
611 let events_7 = node_b.node.get_and_clear_pending_msg_events();
612 assert_eq!(events_7.len(), 1);
613 let (announcement, bs_update) = match events_7[0] {
614 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
617 _ => panic!("Unexpected event"),
620 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
621 let events_8 = node_a.node.get_and_clear_pending_msg_events();
622 assert_eq!(events_8.len(), 1);
623 let as_update = match events_8[0] {
624 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
625 assert!(*announcement == *msg);
626 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
627 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
630 _ => panic!("Unexpected event"),
633 *node_a.network_chan_count.borrow_mut() += 1;
635 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
638 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) {
639 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
642 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) {
643 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
644 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
645 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
648 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) {
649 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
650 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
651 assert!(a_events.len() >= 2);
653 // ann should be re-generated by broadcast_node_announcement - check that we have it.
654 let mut found_ann_1 = false;
655 for event in a_events.iter() {
657 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
658 if msg == ann { found_ann_1 = true; }
660 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
661 _ => panic!("Unexpected event {:?}", event),
664 assert!(found_ann_1);
666 let a_node_announcement = match a_events.last().unwrap() {
667 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
670 _ => panic!("Unexpected event"),
673 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
674 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
675 assert!(b_events.len() >= 2);
677 // ann should be re-generated by broadcast_node_announcement - check that we have it.
678 let mut found_ann_2 = false;
679 for event in b_events.iter() {
681 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
682 if msg == ann { found_ann_2 = true; }
684 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
685 _ => panic!("Unexpected event"),
688 assert!(found_ann_2);
690 let b_node_announcement = match b_events.last().unwrap() {
691 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
694 _ => panic!("Unexpected event"),
698 assert!(node.net_graph_msg_handler.handle_channel_announcement(ann).unwrap());
699 node.net_graph_msg_handler.handle_channel_update(upd_1).unwrap();
700 node.net_graph_msg_handler.handle_channel_update(upd_2).unwrap();
701 node.net_graph_msg_handler.handle_node_announcement(&a_node_announcement).unwrap();
702 node.net_graph_msg_handler.handle_node_announcement(&b_node_announcement).unwrap();
706 macro_rules! check_spends {
707 ($tx: expr, $($spends_txn: expr),*) => {
709 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
711 if out_point.txid == $spends_txn.txid() {
712 return $spends_txn.output.get(out_point.vout as usize).cloned()
717 let mut total_value_in = 0;
718 for input in $tx.input.iter() {
719 total_value_in += get_output(&input.previous_output).unwrap().value;
721 let mut total_value_out = 0;
722 for output in $tx.output.iter() {
723 total_value_out += output.value;
725 let min_fee = ($tx.get_weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
726 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
727 assert!(total_value_out + min_fee <= total_value_in);
728 $tx.verify(get_output).unwrap();
733 macro_rules! get_closing_signed_broadcast {
734 ($node: expr, $dest_pubkey: expr) => {
736 let events = $node.get_and_clear_pending_msg_events();
737 assert!(events.len() == 1 || events.len() == 2);
738 (match events[events.len() - 1] {
739 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
740 assert_eq!(msg.contents.flags & 2, 2);
743 _ => panic!("Unexpected event"),
744 }, if events.len() == 2 {
746 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
747 assert_eq!(*node_id, $dest_pubkey);
750 _ => panic!("Unexpected event"),
757 /// Check that a channel's closing channel update has been broadcasted, and optionally
758 /// check whether an error message event has occurred.
760 macro_rules! check_closed_broadcast {
761 ($node: expr, $with_error_msg: expr) => {{
762 let msg_events = $node.node.get_and_clear_pending_msg_events();
763 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
764 match msg_events[0] {
765 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
766 assert_eq!(msg.contents.flags & 2, 2);
768 _ => panic!("Unexpected event"),
771 match msg_events[1] {
772 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
773 // TODO: Check node_id
776 _ => panic!("Unexpected event"),
782 /// Check that a channel's closing channel events has been issued
784 macro_rules! check_closed_event {
785 ($node: expr, $events: expr, $reason: expr) => {
786 check_closed_event!($node, $events, $reason, false);
788 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
789 let events = $node.node.get_and_clear_pending_events();
790 assert_eq!(events.len(), $events);
791 let expected_reason = $reason;
792 let mut issues_discard_funding = false;
793 for event in events {
795 Event::ChannelClosed { ref reason, .. } => {
796 assert_eq!(*reason, expected_reason);
798 Event::DiscardFunding { .. } => {
799 issues_discard_funding = true;
801 _ => panic!("Unexpected event"),
804 assert_eq!($is_check_discard_funding, issues_discard_funding);
808 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) {
809 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) };
810 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) };
813 node_a.close_channel(channel_id).unwrap();
814 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()));
816 let events_1 = node_b.get_and_clear_pending_msg_events();
817 assert!(events_1.len() >= 1);
818 let shutdown_b = match events_1[0] {
819 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
820 assert_eq!(node_id, &node_a.get_our_node_id());
823 _ => panic!("Unexpected event"),
826 let closing_signed_b = if !close_inbound_first {
827 assert_eq!(events_1.len(), 1);
830 Some(match events_1[1] {
831 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
832 assert_eq!(node_id, &node_a.get_our_node_id());
835 _ => panic!("Unexpected event"),
839 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
840 let (as_update, bs_update) = if close_inbound_first {
841 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
842 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
844 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
845 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
846 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
847 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
849 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
850 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
851 assert!(none_a.is_none());
852 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
853 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
854 (as_update, bs_update)
856 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
858 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
859 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
861 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
862 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
863 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
865 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
866 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
867 assert!(none_b.is_none());
868 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
869 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
870 (as_update, bs_update)
872 assert_eq!(tx_a, tx_b);
873 check_spends!(tx_a, funding_tx);
875 (as_update, bs_update, tx_a)
878 pub struct SendEvent {
879 pub node_id: PublicKey,
880 pub msgs: Vec<msgs::UpdateAddHTLC>,
881 pub commitment_msg: msgs::CommitmentSigned,
884 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
885 assert!(updates.update_fulfill_htlcs.is_empty());
886 assert!(updates.update_fail_htlcs.is_empty());
887 assert!(updates.update_fail_malformed_htlcs.is_empty());
888 assert!(updates.update_fee.is_none());
889 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
892 pub fn from_event(event: MessageSendEvent) -> SendEvent {
894 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
895 _ => panic!("Unexpected event type!"),
899 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
900 let mut events = node.node.get_and_clear_pending_msg_events();
901 assert_eq!(events.len(), 1);
902 SendEvent::from_event(events.pop().unwrap())
906 macro_rules! commitment_signed_dance {
907 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
909 check_added_monitors!($node_a, 0);
910 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
911 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
912 check_added_monitors!($node_a, 1);
913 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
916 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
918 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
919 check_added_monitors!($node_b, 0);
920 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
921 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
922 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
923 check_added_monitors!($node_b, 1);
924 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
925 let (bs_revoke_and_ack, extra_msg_option) = {
926 let events = $node_b.node.get_and_clear_pending_msg_events();
927 assert!(events.len() <= 2);
929 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
930 assert_eq!(*node_id, $node_a.node.get_our_node_id());
933 _ => panic!("Unexpected event"),
934 }, events.get(1).map(|e| e.clone()))
936 check_added_monitors!($node_b, 1);
938 assert!($node_a.node.get_and_clear_pending_events().is_empty());
939 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
941 (extra_msg_option, bs_revoke_and_ack)
944 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
946 check_added_monitors!($node_a, 0);
947 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
948 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
949 check_added_monitors!($node_a, 1);
950 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
951 assert!(extra_msg_option.is_none());
955 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
957 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
958 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
959 check_added_monitors!($node_a, 1);
963 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
965 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
968 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
970 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
972 expect_pending_htlcs_forwardable!($node_a);
973 check_added_monitors!($node_a, 1);
975 let channel_state = $node_a.node.channel_state.lock().unwrap();
976 assert_eq!(channel_state.pending_msg_events.len(), 1);
977 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
978 assert_ne!(*node_id, $node_b.node.get_our_node_id());
979 } else { panic!("Unexpected event"); }
981 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
987 /// Get a payment preimage and hash.
989 macro_rules! get_payment_preimage_hash {
990 ($dest_node: expr) => {
992 get_payment_preimage_hash!($dest_node, None)
995 ($dest_node: expr, $min_value_msat: expr) => {
997 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
998 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1000 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1001 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200, 0).unwrap();
1002 (payment_preimage, payment_hash, payment_secret)
1008 macro_rules! get_route_and_payment_hash {
1009 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1010 get_route_and_payment_hash!($send_node, $recv_node, vec![], $recv_value, TEST_FINAL_CLTV)
1012 ($send_node: expr, $recv_node: expr, $last_hops: expr, $recv_value: expr, $cltv: expr) => {{
1013 let (payment_preimage, payment_hash, payment_secret) = get_payment_preimage_hash!($recv_node, Some($recv_value));
1014 let payee = $crate::routing::router::Payee::new($recv_node.node.get_our_node_id())
1015 .with_features($crate::ln::features::InvoiceFeatures::known())
1016 .with_route_hints($last_hops);
1017 let net_graph_msg_handler = &$send_node.net_graph_msg_handler;
1018 let scorer = ::routing::scorer::Scorer::with_fixed_penalty(0);
1019 let route = ::routing::router::get_route(
1020 &$send_node.node.get_our_node_id(), &payee, &net_graph_msg_handler.network_graph,
1021 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1022 $recv_value, $cltv, $send_node.logger, &scorer
1024 (route, payment_hash, payment_preimage, payment_secret)
1028 macro_rules! expect_pending_htlcs_forwardable_ignore {
1030 let events = $node.node.get_and_clear_pending_events();
1031 assert_eq!(events.len(), 1);
1033 Event::PendingHTLCsForwardable { .. } => { },
1034 _ => panic!("Unexpected event"),
1039 macro_rules! expect_pending_htlcs_forwardable {
1041 expect_pending_htlcs_forwardable_ignore!($node);
1042 $node.node.process_pending_htlc_forwards();
1047 macro_rules! expect_pending_htlcs_forwardable_from_events {
1048 ($node: expr, $events: expr, $ignore: expr) => {{
1049 assert_eq!($events.len(), 1);
1051 Event::PendingHTLCsForwardable { .. } => { },
1052 _ => panic!("Unexpected event"),
1055 $node.node.process_pending_htlc_forwards();
1060 #[cfg(any(test, feature = "unstable"))]
1061 macro_rules! expect_payment_received {
1062 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1063 let events = $node.node.get_and_clear_pending_events();
1064 assert_eq!(events.len(), 1);
1066 Event::PaymentReceived { ref payment_hash, ref purpose, amt } => {
1067 assert_eq!($expected_payment_hash, *payment_hash);
1068 assert_eq!($expected_recv_value, amt);
1070 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1071 assert!(payment_preimage.is_none());
1072 assert_eq!($expected_payment_secret, *payment_secret);
1077 _ => panic!("Unexpected event"),
1082 macro_rules! expect_payment_sent {
1083 ($node: expr, $expected_payment_preimage: expr) => {
1084 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>);
1086 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1087 let events = $node.node.get_and_clear_pending_events();
1088 let expected_payment_hash = PaymentHash(Sha256::hash(&$expected_payment_preimage.0).into_inner());
1089 assert_eq!(events.len(), 1);
1091 Event::PaymentSent { payment_id: _, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1092 assert_eq!($expected_payment_preimage, *payment_preimage);
1093 assert_eq!(expected_payment_hash, *payment_hash);
1094 assert!(fee_paid_msat.is_some());
1095 if $expected_fee_msat_opt.is_some() {
1096 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1099 _ => panic!("Unexpected event"),
1104 macro_rules! expect_payment_forwarded {
1105 ($node: expr, $expected_fee: expr, $upstream_force_closed: expr) => {
1106 let events = $node.node.get_and_clear_pending_events();
1107 assert_eq!(events.len(), 1);
1109 Event::PaymentForwarded { fee_earned_msat, claim_from_onchain_tx } => {
1110 assert_eq!(fee_earned_msat, $expected_fee);
1111 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1113 _ => panic!("Unexpected event"),
1119 macro_rules! expect_payment_failed_with_update {
1120 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1121 let events = $node.node.get_and_clear_pending_events();
1122 assert_eq!(events.len(), 1);
1124 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, ref network_update, ref error_code, ref error_data, ref path, ref retry, .. } => {
1125 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1126 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1127 assert!(retry.is_some(), "expected retry.is_some()");
1128 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1129 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1130 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1131 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1132 match network_update {
1133 &Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !$chan_closed => {
1134 assert_eq!(msg.contents.short_channel_id, $scid);
1135 assert_eq!(msg.contents.flags & 2, 0);
1137 &Some(NetworkUpdate::ChannelClosed { short_channel_id, is_permanent }) if $chan_closed => {
1138 assert_eq!(short_channel_id, $scid);
1139 assert!(is_permanent);
1141 Some(_) => panic!("Unexpected update type"),
1142 None => panic!("Expected update"),
1145 _ => panic!("Unexpected event"),
1151 macro_rules! expect_payment_failed {
1152 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1153 let events = $node.node.get_and_clear_pending_events();
1154 assert_eq!(events.len(), 1);
1156 Event::PaymentPathFailed { ref payment_hash, rejected_by_dest, network_update: _, ref error_code, ref error_data, ref path, ref retry, .. } => {
1157 assert_eq!(*payment_hash, $expected_payment_hash, "unexpected payment_hash");
1158 assert_eq!(rejected_by_dest, $rejected_by_dest, "unexpected rejected_by_dest value");
1159 assert!(retry.is_some(), "expected retry.is_some()");
1160 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1161 assert_eq!(retry.as_ref().unwrap().payee.pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1162 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1163 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1165 assert_eq!(error_code.unwrap(), $expected_error_code, "unexpected error code");
1166 assert_eq!(&error_data.as_ref().unwrap()[..], $expected_error_data, "unexpected error data");
1169 _ => panic!("Unexpected event"),
1174 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) -> PaymentId {
1175 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1176 check_added_monitors!(origin_node, expected_paths.len());
1177 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1181 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>) {
1182 let mut payment_event = SendEvent::from_event(ev);
1183 let mut prev_node = origin_node;
1185 for (idx, &node) in expected_path.iter().enumerate() {
1186 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1188 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1189 check_added_monitors!(node, 0);
1190 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1192 expect_pending_htlcs_forwardable!(node);
1194 if idx == expected_path.len() - 1 {
1195 let events_2 = node.node.get_and_clear_pending_events();
1196 if payment_received_expected {
1197 assert_eq!(events_2.len(), 1);
1199 Event::PaymentReceived { ref payment_hash, ref purpose, amt} => {
1200 assert_eq!(our_payment_hash, *payment_hash);
1202 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1203 assert_eq!(expected_preimage, *payment_preimage);
1204 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1206 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1207 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1208 assert!(our_payment_secret.is_none());
1211 assert_eq!(amt, recv_value);
1213 _ => panic!("Unexpected event"),
1216 assert!(events_2.is_empty());
1219 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1220 assert_eq!(events_2.len(), 1);
1221 check_added_monitors!(node, 1);
1222 payment_event = SendEvent::from_event(events_2.remove(0));
1223 assert_eq!(payment_event.msgs.len(), 1);
1230 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) {
1231 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1232 assert_eq!(events.len(), expected_route.len());
1233 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1234 // Once we've gotten through all the HTLCs, the last one should result in a
1235 // PaymentReceived (but each previous one should not!), .
1236 let expect_payment = path_idx == expected_route.len() - 1;
1237 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1241 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, PaymentId) {
1242 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1243 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1244 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1247 pub fn do_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) -> u64 {
1248 for path in expected_paths.iter() {
1249 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1251 assert!(expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage));
1252 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1254 let mut expected_total_fee_msat = 0;
1256 macro_rules! msgs_from_ev {
1259 &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 } } => {
1260 assert!(update_add_htlcs.is_empty());
1261 assert_eq!(update_fulfill_htlcs.len(), 1);
1262 assert!(update_fail_htlcs.is_empty());
1263 assert!(update_fail_malformed_htlcs.is_empty());
1264 assert!(update_fee.is_none());
1265 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1267 _ => panic!("Unexpected event"),
1271 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1272 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1273 assert_eq!(events.len(), expected_paths.len());
1274 for ev in events.iter() {
1275 per_path_msgs.push(msgs_from_ev!(ev));
1278 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1279 let mut next_msgs = Some(path_msgs);
1280 let mut expected_next_node = next_hop;
1282 macro_rules! last_update_fulfill_dance {
1283 ($node: expr, $prev_node: expr) => {
1285 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1286 check_added_monitors!($node, 0);
1287 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1288 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1292 macro_rules! mid_update_fulfill_dance {
1293 ($node: expr, $prev_node: expr, $new_msgs: expr) => {
1295 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1296 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;
1297 expect_payment_forwarded!($node, Some(fee as u64), false);
1298 expected_total_fee_msat += fee as u64;
1299 check_added_monitors!($node, 1);
1300 let new_next_msgs = if $new_msgs {
1301 let events = $node.node.get_and_clear_pending_msg_events();
1302 assert_eq!(events.len(), 1);
1303 let (res, nexthop) = msgs_from_ev!(&events[0]);
1304 expected_next_node = nexthop;
1307 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1310 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1311 next_msgs = new_next_msgs;
1316 let mut prev_node = expected_route.last().unwrap();
1317 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1318 assert_eq!(expected_next_node, node.node.get_our_node_id());
1319 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1320 if next_msgs.is_some() {
1321 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
1323 assert!(!update_next_msgs);
1324 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1326 if !skip_last && idx == expected_route.len() - 1 {
1327 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1334 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1337 expected_total_fee_msat
1339 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) {
1340 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1342 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1346 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1347 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1350 pub const TEST_FINAL_CLTV: u32 = 70;
1352 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) {
1353 let payee = Payee::new(expected_route.last().unwrap().node.get_our_node_id())
1354 .with_features(InvoiceFeatures::known());
1355 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1356 let scorer = Scorer::with_fixed_penalty(0);
1357 let route = get_route(
1358 &origin_node.node.get_our_node_id(), &payee, &net_graph_msg_handler.network_graph,
1359 Some(&origin_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1360 recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1361 assert_eq!(route.paths.len(), 1);
1362 assert_eq!(route.paths[0].len(), expected_route.len());
1363 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1364 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1367 let res = send_along_route(origin_node, route, expected_route, recv_value);
1368 (res.0, res.1, res.2)
1371 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1372 let payee = Payee::new(expected_route.last().unwrap().node.get_our_node_id())
1373 .with_features(InvoiceFeatures::known());
1374 let net_graph_msg_handler = &origin_node.net_graph_msg_handler;
1375 let scorer = Scorer::with_fixed_penalty(0);
1376 let route = get_route(&origin_node.node.get_our_node_id(), &payee, &net_graph_msg_handler.network_graph, None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer).unwrap();
1377 assert_eq!(route.paths.len(), 1);
1378 assert_eq!(route.paths[0].len(), expected_route.len());
1379 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1380 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1383 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1384 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1385 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1388 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1389 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1390 claim_payment(&origin, expected_route, our_payment_preimage);
1393 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) {
1394 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1395 for path in expected_paths.iter() {
1396 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1398 assert!(expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
1399 expect_pending_htlcs_forwardable!(expected_paths[0].last().unwrap());
1400 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1402 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1403 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1404 assert_eq!(events.len(), expected_paths.len());
1405 for ev in events.iter() {
1406 let (update_fail, commitment_signed, node_id) = match ev {
1407 &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 } } => {
1408 assert!(update_add_htlcs.is_empty());
1409 assert!(update_fulfill_htlcs.is_empty());
1410 assert_eq!(update_fail_htlcs.len(), 1);
1411 assert!(update_fail_malformed_htlcs.is_empty());
1412 assert!(update_fee.is_none());
1413 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1415 _ => panic!("Unexpected event"),
1417 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1419 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1420 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()));
1422 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1423 let mut next_msgs = Some(path_msgs);
1424 let mut expected_next_node = next_hop;
1425 let mut prev_node = expected_route.last().unwrap();
1427 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1428 assert_eq!(expected_next_node, node.node.get_our_node_id());
1429 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1430 if next_msgs.is_some() {
1431 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1432 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1433 if !update_next_node {
1434 expect_pending_htlcs_forwardable!(node);
1437 let events = node.node.get_and_clear_pending_msg_events();
1438 if update_next_node {
1439 assert_eq!(events.len(), 1);
1441 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 } } => {
1442 assert!(update_add_htlcs.is_empty());
1443 assert!(update_fulfill_htlcs.is_empty());
1444 assert_eq!(update_fail_htlcs.len(), 1);
1445 assert!(update_fail_malformed_htlcs.is_empty());
1446 assert!(update_fee.is_none());
1447 expected_next_node = node_id.clone();
1448 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1450 _ => panic!("Unexpected event"),
1453 assert!(events.is_empty());
1455 if !skip_last && idx == expected_route.len() - 1 {
1456 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1463 let prev_node = expected_route.first().unwrap();
1464 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1465 check_added_monitors!(origin_node, 0);
1466 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1467 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1468 let events = origin_node.node.get_and_clear_pending_events();
1469 assert_eq!(events.len(), 1);
1471 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, .. } => {
1472 assert_eq!(payment_hash, our_payment_hash);
1473 assert!(rejected_by_dest);
1474 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1475 for (idx, hop) in expected_route.iter().enumerate() {
1476 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1479 _ => panic!("Unexpected event"),
1485 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1486 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1489 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1490 let mut chan_mon_cfgs = Vec::new();
1491 for i in 0..node_count {
1492 let tx_broadcaster = test_utils::TestBroadcaster {
1493 txn_broadcasted: Mutex::new(Vec::new()),
1494 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet).header, 0)])),
1496 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1497 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1498 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1499 let persister = test_utils::TestPersister::new();
1500 let seed = [i as u8; 32];
1501 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1503 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
1509 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
1510 let mut nodes = Vec::new();
1512 for i in 0..node_count {
1513 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);
1514 let seed = [i as u8; 32];
1515 nodes.push(NodeCfg {
1516 chain_source: &chanmon_cfgs[i].chain_source,
1517 logger: &chanmon_cfgs[i].logger,
1518 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
1519 fee_estimator: &chanmon_cfgs[i].fee_estimator,
1521 keys_manager: &chanmon_cfgs[i].keys_manager,
1523 features: InitFeatures::known(),
1530 pub fn test_default_channel_config() -> UserConfig {
1531 let mut default_config = UserConfig::default();
1532 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
1533 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
1534 default_config.channel_options.cltv_expiry_delta = 6*6;
1535 default_config.channel_options.announced_channel = true;
1536 default_config.peer_channel_config_limits.force_announced_channel_preference = false;
1537 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
1538 // It now defaults to 1, so we simply set it to the expected value here.
1539 default_config.own_channel_config.our_htlc_minimum_msat = 1000;
1540 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
1541 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
1542 default_config.channel_options.max_dust_htlc_exposure_msat = 50_000_000;
1546 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>> {
1547 let mut chanmgrs = Vec::new();
1548 for i in 0..node_count {
1549 let network = Network::Testnet;
1550 let params = ChainParameters {
1552 best_block: BestBlock::from_genesis(network),
1554 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
1555 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
1556 chanmgrs.push(node);
1562 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>> {
1563 let mut nodes = Vec::new();
1564 let chan_count = Rc::new(RefCell::new(0));
1565 let payment_count = Rc::new(RefCell::new(0));
1566 let connect_style = Rc::new(RefCell::new(ConnectStyle::FullBlockViaListen));
1568 for i in 0..node_count {
1569 let network_graph = NetworkGraph::new(cfgs[i].chain_source.genesis_hash);
1570 let net_graph_msg_handler = NetGraphMsgHandler::new(network_graph, None, cfgs[i].logger);
1571 nodes.push(Node{ chain_source: cfgs[i].chain_source,
1572 tx_broadcaster: cfgs[i].tx_broadcaster, chain_monitor: &cfgs[i].chain_monitor,
1573 keys_manager: &cfgs[i].keys_manager, node: &chan_mgrs[i], net_graph_msg_handler,
1574 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
1575 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
1576 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
1577 connect_style: Rc::clone(&connect_style),
1581 for i in 0..node_count {
1582 for j in (i+1)..node_count {
1583 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone() });
1584 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone() });
1591 // Note that the following only works for CLTV values up to 128
1592 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
1593 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
1595 #[derive(PartialEq)]
1596 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
1597 /// Tests that the given node has broadcast transactions for the given Channel
1599 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
1600 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
1601 /// broadcast and the revoked outputs were claimed.
1603 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
1604 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
1606 /// All broadcast transactions must be accounted for in one of the above three types of we'll
1608 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> {
1609 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1610 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
1612 let mut res = Vec::with_capacity(2);
1613 node_txn.retain(|tx| {
1614 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
1615 check_spends!(tx, chan.3);
1616 if commitment_tx.is_none() {
1617 res.push(tx.clone());
1622 if let Some(explicit_tx) = commitment_tx {
1623 res.push(explicit_tx.clone());
1626 assert_eq!(res.len(), 1);
1628 if has_htlc_tx != HTLCType::NONE {
1629 node_txn.retain(|tx| {
1630 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
1631 check_spends!(tx, res[0]);
1632 if has_htlc_tx == HTLCType::TIMEOUT {
1633 assert!(tx.lock_time != 0);
1635 assert!(tx.lock_time == 0);
1637 res.push(tx.clone());
1641 assert!(res.len() == 2 || res.len() == 3);
1643 assert_eq!(res[1], res[2]);
1647 assert!(node_txn.is_empty());
1651 /// Tests that the given node has broadcast a claim transaction against the provided revoked
1652 /// HTLC transaction.
1653 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
1654 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1655 // We may issue multiple claiming transaction on revoked outputs due to block rescan
1656 // for revoked htlc outputs
1657 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
1658 node_txn.retain(|tx| {
1659 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
1660 check_spends!(tx, revoked_tx);
1664 node_txn.retain(|tx| {
1665 check_spends!(tx, commitment_revoked_tx);
1668 assert!(node_txn.is_empty());
1671 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
1672 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
1674 assert!(node_txn.len() >= 1);
1675 assert_eq!(node_txn[0].input.len(), 1);
1676 let mut found_prev = false;
1678 for tx in prev_txn {
1679 if node_txn[0].input[0].previous_output.txid == tx.txid() {
1680 check_spends!(node_txn[0], tx);
1681 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
1682 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
1688 assert!(found_prev);
1690 let mut res = Vec::new();
1691 mem::swap(&mut *node_txn, &mut res);
1695 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) {
1696 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
1697 assert_eq!(events_1.len(), 2);
1698 let as_update = match events_1[0] {
1699 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1702 _ => panic!("Unexpected event"),
1705 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1706 assert_eq!(node_id, nodes[b].node.get_our_node_id());
1707 assert_eq!(msg.data, expected_error);
1708 if needs_err_handle {
1709 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
1712 _ => panic!("Unexpected event"),
1715 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
1716 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
1717 let bs_update = match events_2[0] {
1718 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1721 _ => panic!("Unexpected event"),
1723 if !needs_err_handle {
1725 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
1726 assert_eq!(node_id, nodes[a].node.get_our_node_id());
1727 assert_eq!(msg.data, expected_error);
1729 _ => panic!("Unexpected event"),
1734 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
1735 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
1739 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
1740 handle_announce_close_broadcast_events(nodes, a, b, false, "Commitment or closing transaction was confirmed on chain.");
1744 macro_rules! get_channel_value_stat {
1745 ($node: expr, $channel_id: expr) => {{
1746 let chan_lock = $node.node.channel_state.lock().unwrap();
1747 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
1748 chan.get_value_stat()
1752 macro_rules! get_chan_reestablish_msgs {
1753 ($src_node: expr, $dst_node: expr) => {
1755 let mut res = Vec::with_capacity(1);
1756 for msg in $src_node.node.get_and_clear_pending_msg_events() {
1757 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
1758 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1759 res.push(msg.clone());
1761 panic!("Unexpected event")
1769 macro_rules! handle_chan_reestablish_msgs {
1770 ($src_node: expr, $dst_node: expr) => {
1772 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
1774 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
1776 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1782 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
1784 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1787 let mut revoke_and_ack = None;
1788 let mut commitment_update = None;
1789 let order = if let Some(ev) = msg_events.get(idx) {
1791 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1792 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1793 revoke_and_ack = Some(msg.clone());
1795 RAACommitmentOrder::RevokeAndACKFirst
1797 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1798 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1799 commitment_update = Some(updates.clone());
1801 RAACommitmentOrder::CommitmentFirst
1803 &MessageSendEvent::SendChannelUpdate { .. } => RAACommitmentOrder::CommitmentFirst,
1804 _ => panic!("Unexpected event"),
1807 RAACommitmentOrder::CommitmentFirst
1810 if let Some(ev) = msg_events.get(idx) {
1812 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1813 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1814 assert!(revoke_and_ack.is_none());
1815 revoke_and_ack = Some(msg.clone());
1818 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
1819 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1820 assert!(commitment_update.is_none());
1821 commitment_update = Some(updates.clone());
1824 &MessageSendEvent::SendChannelUpdate { .. } => {},
1825 _ => panic!("Unexpected event"),
1829 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
1830 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
1831 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
1834 (funding_locked, revoke_and_ack, commitment_update, order)
1839 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
1840 /// for claims/fails they are separated out.
1841 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)) {
1842 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1843 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
1844 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1845 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
1847 if send_funding_locked.0 {
1848 // If a expects a funding_locked, it better not think it has received a revoke_and_ack
1850 for reestablish in reestablish_1.iter() {
1851 assert_eq!(reestablish.next_remote_commitment_number, 0);
1854 if send_funding_locked.1 {
1855 // If b expects a funding_locked, it better not think it has received a revoke_and_ack
1857 for reestablish in reestablish_2.iter() {
1858 assert_eq!(reestablish.next_remote_commitment_number, 0);
1861 if send_funding_locked.0 || send_funding_locked.1 {
1862 // If we expect any funding_locked's, both sides better have set
1863 // next_holder_commitment_number to 1
1864 for reestablish in reestablish_1.iter() {
1865 assert_eq!(reestablish.next_local_commitment_number, 1);
1867 for reestablish in reestablish_2.iter() {
1868 assert_eq!(reestablish.next_local_commitment_number, 1);
1872 let mut resp_1 = Vec::new();
1873 for msg in reestablish_1 {
1874 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
1875 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
1877 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
1878 check_added_monitors!(node_b, 1);
1880 check_added_monitors!(node_b, 0);
1883 let mut resp_2 = Vec::new();
1884 for msg in reestablish_2 {
1885 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
1886 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
1888 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
1889 check_added_monitors!(node_a, 1);
1891 check_added_monitors!(node_a, 0);
1894 // We don't yet support both needing updates, as that would require a different commitment dance:
1895 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
1896 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
1897 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
1898 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
1900 for chan_msgs in resp_1.drain(..) {
1901 if send_funding_locked.0 {
1902 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
1903 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
1904 if !announcement_event.is_empty() {
1905 assert_eq!(announcement_event.len(), 1);
1906 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1907 //TODO: Test announcement_sigs re-sending
1908 } else { panic!("Unexpected event!"); }
1911 assert!(chan_msgs.0.is_none());
1914 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1915 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
1916 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1917 check_added_monitors!(node_a, 1);
1919 assert!(chan_msgs.1.is_none());
1921 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 {
1922 let commitment_update = chan_msgs.2.unwrap();
1923 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1924 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
1926 assert!(commitment_update.update_add_htlcs.is_empty());
1928 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
1929 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
1930 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1931 for update_add in commitment_update.update_add_htlcs {
1932 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
1934 for update_fulfill in commitment_update.update_fulfill_htlcs {
1935 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
1937 for update_fail in commitment_update.update_fail_htlcs {
1938 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
1941 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
1942 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
1944 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
1945 check_added_monitors!(node_a, 1);
1946 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
1947 // No commitment_signed so get_event_msg's assert(len == 1) passes
1948 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1949 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1950 check_added_monitors!(node_b, 1);
1953 assert!(chan_msgs.2.is_none());
1957 for chan_msgs in resp_2.drain(..) {
1958 if send_funding_locked.1 {
1959 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
1960 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
1961 if !announcement_event.is_empty() {
1962 assert_eq!(announcement_event.len(), 1);
1963 if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
1964 //TODO: Test announcement_sigs re-sending
1965 } else { panic!("Unexpected event!"); }
1968 assert!(chan_msgs.0.is_none());
1971 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
1972 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
1973 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1974 check_added_monitors!(node_b, 1);
1976 assert!(chan_msgs.1.is_none());
1978 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 {
1979 let commitment_update = chan_msgs.2.unwrap();
1980 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1981 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
1983 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
1984 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
1985 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
1986 for update_add in commitment_update.update_add_htlcs {
1987 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
1989 for update_fulfill in commitment_update.update_fulfill_htlcs {
1990 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
1992 for update_fail in commitment_update.update_fail_htlcs {
1993 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
1996 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
1997 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
1999 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2000 check_added_monitors!(node_b, 1);
2001 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2002 // No commitment_signed so get_event_msg's assert(len == 1) passes
2003 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2004 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2005 check_added_monitors!(node_a, 1);
2008 assert!(chan_msgs.2.is_none());