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, keysinterface::KeysInterface};
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, MIN_CLTV_EXPIRY_DELTA};
18 use routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
19 use routing::router::{PaymentParameters, Route, get_route};
20 use ln::features::{InitFeatures, InvoiceFeatures};
22 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use util::enforcing_trait_impls::EnforcingSigner;
26 use util::test_utils::{panicking, TestChainMonitor};
27 use util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
28 use util::errors::APIError;
29 use util::config::UserConfig;
30 use util::ser::{ReadableArgs, Writeable};
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::hash_types::BlockHash;
38 use bitcoin::hashes::sha256::Hash as Sha256;
39 use bitcoin::hashes::Hash as _;
41 use bitcoin::secp256k1::PublicKey;
45 use core::cell::RefCell;
47 use sync::{Arc, Mutex};
49 use core::iter::repeat;
50 use bitcoin::{PackedLockTime, TxMerkleNode};
52 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
54 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
55 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
57 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
58 /// output is the 1st output in the transaction.
59 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
60 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
61 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
64 /// Mine a signle block containing the given transaction
65 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
66 let height = node.best_block_info().1 + 1;
67 confirm_transaction_at(node, tx, height);
69 /// Mine the given transaction at the given height, mining blocks as required to build to that
72 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
73 /// output is the 1st output in the transaction.
74 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
75 let first_connect_height = node.best_block_info().1 + 1;
76 assert!(first_connect_height <= conf_height);
77 if conf_height > first_connect_height {
78 connect_blocks(node, conf_height - first_connect_height);
80 let mut block = Block {
81 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
84 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
85 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
87 block.txdata.push(tx.clone());
88 connect_block(node, &block);
89 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
92 /// The possible ways we may notify a ChannelManager of a new block
93 #[derive(Clone, Copy, Debug, PartialEq)]
94 pub enum ConnectStyle {
95 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
96 /// the header and height information.
98 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
99 /// make a single `best_block_updated` call.
100 BestBlockFirstSkippingBlocks,
101 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
102 /// `transaction_unconfirmed` is called.
103 BestBlockFirstReorgsOnlyTip,
104 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
105 /// the header and height information.
107 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
108 /// make a single `best_block_updated` call.
109 TransactionsFirstSkippingBlocks,
110 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
111 /// `transaction_unconfirmed` is called.
112 TransactionsFirstReorgsOnlyTip,
113 /// Provides the full block via the `chain::Listen` interface. In the current code this is
114 /// equivalent to `TransactionsFirst` with some additional assertions.
119 fn random_style() -> ConnectStyle {
120 #[cfg(feature = "std")] {
121 use core::hash::{BuildHasher, Hasher};
122 // Get a random value using the only std API to do so - the DefaultHasher
123 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
124 let res = match rand_val % 7 {
125 0 => ConnectStyle::BestBlockFirst,
126 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
127 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
128 3 => ConnectStyle::TransactionsFirst,
129 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
130 5 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
131 6 => ConnectStyle::FullBlockViaListen,
134 eprintln!("Using Block Connection Style: {:?}", res);
137 #[cfg(not(feature = "std"))] {
138 ConnectStyle::FullBlockViaListen
143 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
144 let skip_intermediaries = match *node.connect_style.borrow() {
145 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
146 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
150 let height = node.best_block_info().1 + 1;
151 let mut block = Block {
152 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
157 let prev_blockhash = block.header.block_hash();
158 do_connect_block(node, block, skip_intermediaries);
160 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
164 let hash = block.header.block_hash();
165 do_connect_block(node, block, false);
169 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
170 do_connect_block(node, block.clone(), false);
173 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
174 // Ensure `get_claimable_balances`' self-tests never panic
175 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
176 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
180 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
181 call_claimable_balances(node);
182 let height = node.best_block_info().1 + 1;
183 #[cfg(feature = "std")] {
184 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
186 if !skip_intermediaries {
187 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
188 match *node.connect_style.borrow() {
189 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
190 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
191 call_claimable_balances(node);
192 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
193 node.node.best_block_updated(&block.header, height);
194 node.node.transactions_confirmed(&block.header, &txdata, height);
196 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
197 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
198 call_claimable_balances(node);
199 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
200 node.node.transactions_confirmed(&block.header, &txdata, height);
201 node.node.best_block_updated(&block.header, height);
203 ConnectStyle::FullBlockViaListen => {
204 node.chain_monitor.chain_monitor.block_connected(&block, height);
205 node.node.block_connected(&block, height);
209 call_claimable_balances(node);
210 node.node.test_process_background_events();
211 node.blocks.lock().unwrap().push((block, height));
214 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
215 call_claimable_balances(node);
216 #[cfg(feature = "std")] {
217 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
220 let orig = node.blocks.lock().unwrap().pop().unwrap();
221 assert!(orig.1 > 0); // Cannot disconnect genesis
222 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
224 match *node.connect_style.borrow() {
225 ConnectStyle::FullBlockViaListen => {
226 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
227 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
229 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks => {
231 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
232 node.node.best_block_updated(&prev.0.header, prev.1);
235 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
236 for tx in orig.0.txdata {
237 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
238 node.node.transaction_unconfirmed(&tx.txid());
242 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
243 node.node.best_block_updated(&prev.0.header, prev.1);
246 call_claimable_balances(node);
250 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
251 let count = node.blocks.lock().unwrap().len() as u32 - 1;
252 disconnect_blocks(node, count);
255 pub struct TestChanMonCfg {
256 pub tx_broadcaster: test_utils::TestBroadcaster,
257 pub fee_estimator: test_utils::TestFeeEstimator,
258 pub chain_source: test_utils::TestChainSource,
259 pub persister: test_utils::TestPersister,
260 pub logger: test_utils::TestLogger,
261 pub keys_manager: test_utils::TestKeysInterface,
264 pub struct NodeCfg<'a> {
265 pub chain_source: &'a test_utils::TestChainSource,
266 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
267 pub fee_estimator: &'a test_utils::TestFeeEstimator,
268 pub chain_monitor: test_utils::TestChainMonitor<'a>,
269 pub keys_manager: &'a test_utils::TestKeysInterface,
270 pub logger: &'a test_utils::TestLogger,
271 pub network_graph: NetworkGraph<&'a test_utils::TestLogger>,
272 pub node_seed: [u8; 32],
273 pub features: InitFeatures,
276 pub struct Node<'a, 'b: 'a, 'c: 'b> {
277 pub chain_source: &'c test_utils::TestChainSource,
278 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
279 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
280 pub keys_manager: &'b test_utils::TestKeysInterface,
281 pub node: &'a ChannelManager<EnforcingSigner, &'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestLogger>,
282 pub network_graph: &'b NetworkGraph<&'c test_utils::TestLogger>,
283 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
284 pub node_seed: [u8; 32],
285 pub network_payment_count: Rc<RefCell<u8>>,
286 pub network_chan_count: Rc<RefCell<u32>>,
287 pub logger: &'c test_utils::TestLogger,
288 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
289 pub connect_style: Rc<RefCell<ConnectStyle>>,
291 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
292 pub fn best_block_hash(&self) -> BlockHash {
293 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
295 pub fn best_block_info(&self) -> (BlockHash, u32) {
296 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
298 pub fn get_block_header(&self, height: u32) -> BlockHeader {
299 self.blocks.lock().unwrap()[height as usize].0.header
303 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
306 // Check that we processed all pending events
307 assert!(self.node.get_and_clear_pending_msg_events().is_empty());
308 assert!(self.node.get_and_clear_pending_events().is_empty());
309 assert!(self.chain_monitor.added_monitors.lock().unwrap().is_empty());
311 // Check that if we serialize the Router, we can deserialize it again.
313 let mut w = test_utils::TestVecWriter(Vec::new());
314 self.network_graph.write(&mut w).unwrap();
315 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
316 assert!(network_graph_deser == *self.network_graph);
317 let gossip_sync = P2PGossipSync::new(
318 &network_graph_deser, Some(self.chain_source), self.logger
320 let mut chan_progress = 0;
322 let orig_announcements = self.gossip_sync.get_next_channel_announcements(chan_progress, 255);
323 let deserialized_announcements = gossip_sync.get_next_channel_announcements(chan_progress, 255);
324 assert!(orig_announcements == deserialized_announcements);
325 chan_progress = match orig_announcements.last() {
326 Some(announcement) => announcement.0.contents.short_channel_id + 1,
330 let mut node_progress = None;
332 let orig_announcements = self.gossip_sync.get_next_node_announcements(node_progress.as_ref(), 255);
333 let deserialized_announcements = gossip_sync.get_next_node_announcements(node_progress.as_ref(), 255);
334 assert!(orig_announcements == deserialized_announcements);
335 node_progress = match orig_announcements.last() {
336 Some(announcement) => Some(announcement.contents.node_id),
342 // Check that if we serialize and then deserialize all our channel monitors we get the
343 // same set of outputs to watch for on chain as we have now. Note that if we write
344 // tests that fully close channels and remove the monitors at some point this may break.
345 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
346 let mut deserialized_monitors = Vec::new();
348 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
349 let mut w = test_utils::TestVecWriter(Vec::new());
350 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
351 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
352 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
353 deserialized_monitors.push(deserialized_monitor);
357 let broadcaster = test_utils::TestBroadcaster {
358 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
359 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
362 // Before using all the new monitors to check the watch outpoints, use the full set of
363 // them to ensure we can write and reload our ChannelManager.
365 let mut channel_monitors = HashMap::new();
366 for monitor in deserialized_monitors.iter_mut() {
367 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
370 let mut w = test_utils::TestVecWriter(Vec::new());
371 self.node.write(&mut w).unwrap();
372 <(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 {
373 default_config: *self.node.get_current_default_configuration(),
374 keys_manager: self.keys_manager,
375 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
376 chain_monitor: self.chain_monitor,
377 tx_broadcaster: &broadcaster,
378 logger: &self.logger,
383 let persister = test_utils::TestPersister::new();
384 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
385 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
386 for deserialized_monitor in deserialized_monitors.drain(..) {
387 if let Err(_) = chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) {
391 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
392 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
397 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) {
398 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
401 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) {
402 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
403 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
404 (announcement, as_update, bs_update, channel_id, tx)
408 /// Gets an RAA and CS which were sent in response to a commitment update
409 macro_rules! get_revoke_commit_msgs {
410 ($node: expr, $node_id: expr) => {
412 use $crate::util::events::MessageSendEvent;
413 let events = $node.node.get_and_clear_pending_msg_events();
414 assert_eq!(events.len(), 2);
416 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
417 assert_eq!(*node_id, $node_id);
420 _ => panic!("Unexpected event"),
422 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
423 assert_eq!(*node_id, $node_id);
424 assert!(updates.update_add_htlcs.is_empty());
425 assert!(updates.update_fulfill_htlcs.is_empty());
426 assert!(updates.update_fail_htlcs.is_empty());
427 assert!(updates.update_fail_malformed_htlcs.is_empty());
428 assert!(updates.update_fee.is_none());
429 updates.commitment_signed.clone()
431 _ => panic!("Unexpected event"),
437 /// Get an specific event message from the pending events queue.
439 macro_rules! get_event_msg {
440 ($node: expr, $event_type: path, $node_id: expr) => {
442 let events = $node.node.get_and_clear_pending_msg_events();
443 assert_eq!(events.len(), 1);
445 $event_type { ref node_id, ref msg } => {
446 assert_eq!(*node_id, $node_id);
449 _ => panic!("Unexpected event"),
455 /// Get an error message from the pending events queue.
457 macro_rules! get_err_msg {
458 ($node: expr, $node_id: expr) => {
460 let events = $node.node.get_and_clear_pending_msg_events();
461 assert_eq!(events.len(), 1);
463 $crate::util::events::MessageSendEvent::HandleError {
464 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
466 assert_eq!(*node_id, $node_id);
469 _ => panic!("Unexpected event"),
475 /// Get a specific event from the pending events queue.
477 macro_rules! get_event {
478 ($node: expr, $event_type: path) => {
480 let mut events = $node.node.get_and_clear_pending_events();
481 assert_eq!(events.len(), 1);
482 let ev = events.pop().unwrap();
484 $event_type { .. } => {
487 _ => panic!("Unexpected event"),
494 /// Gets an UpdateHTLCs MessageSendEvent
495 macro_rules! get_htlc_update_msgs {
496 ($node: expr, $node_id: expr) => {
498 let events = $node.node.get_and_clear_pending_msg_events();
499 assert_eq!(events.len(), 1);
501 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
502 assert_eq!(*node_id, $node_id);
505 _ => panic!("Unexpected event"),
512 macro_rules! get_channel_ref {
513 ($node: expr, $lock: ident, $channel_id: expr) => {
515 $lock = $node.node.channel_state.lock().unwrap();
516 $lock.by_id.get_mut(&$channel_id).unwrap()
522 macro_rules! get_feerate {
523 ($node: expr, $channel_id: expr) => {
526 let chan = get_channel_ref!($node, lock, $channel_id);
533 macro_rules! get_opt_anchors {
534 ($node: expr, $channel_id: expr) => {
537 let chan = get_channel_ref!($node, lock, $channel_id);
543 /// Returns a channel monitor given a channel id, making some naive assumptions
545 macro_rules! get_monitor {
546 ($node: expr, $channel_id: expr) => {
548 use bitcoin::hashes::Hash;
549 let mut monitor = None;
550 // Assume funding vout is either 0 or 1 blindly
552 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
553 $crate::chain::transaction::OutPoint {
554 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
566 /// Returns any local commitment transactions for the channel.
568 macro_rules! get_local_commitment_txn {
569 ($node: expr, $channel_id: expr) => {
571 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
576 /// Check the error from attempting a payment.
578 macro_rules! unwrap_send_err {
579 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
581 &Err(PaymentSendFailure::AllFailedRetrySafe(ref fails)) if $all_failed => {
582 assert_eq!(fails.len(), 1);
588 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
589 assert_eq!(results.len(), 1);
591 Err($type) => { $check },
600 /// Check whether N channel monitor(s) have been added.
602 macro_rules! check_added_monitors {
603 ($node: expr, $count: expr) => {
605 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
606 assert_eq!(added_monitors.len(), $count);
607 added_monitors.clear();
612 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u64) -> ([u8; 32], Transaction, OutPoint) {
613 let chan_id = *node.network_chan_count.borrow();
615 let events = node.node.get_and_clear_pending_events();
616 assert_eq!(events.len(), 1);
618 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
619 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
620 assert_eq!(*channel_value_satoshis, expected_chan_value);
621 assert_eq!(user_channel_id, expected_user_chan_id);
623 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
624 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
626 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
627 (*temporary_channel_id, tx, funding_outpoint)
629 _ => panic!("Unexpected event"),
632 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
633 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
634 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
636 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
637 check_added_monitors!(node_a, 0);
639 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
640 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
641 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
643 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
644 assert_eq!(added_monitors.len(), 1);
645 assert_eq!(added_monitors[0].0, funding_output);
646 added_monitors.clear();
649 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()));
651 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
652 assert_eq!(added_monitors.len(), 1);
653 assert_eq!(added_monitors[0].0, funding_output);
654 added_monitors.clear();
657 let events_4 = node_a.node.get_and_clear_pending_events();
658 assert_eq!(events_4.len(), 0);
660 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
661 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
662 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
664 // Ensure that funding_transaction_generated is idempotent.
665 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
666 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
667 check_added_monitors!(node_a, 0);
672 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 {
673 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
674 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
675 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
676 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
677 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
678 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
679 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
681 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
684 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) {
685 confirm_transaction_at(node_conf, tx, conf_height);
686 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
687 node_recv.node.handle_channel_ready(&node_conf.node.get_our_node_id(), &get_event_msg!(node_conf, MessageSendEvent::SendChannelReady, node_recv.node.get_our_node_id()));
690 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
692 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
693 assert_eq!(events_6.len(), 3);
694 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
695 assert_eq!(*node_id, node_recv.node.get_our_node_id());
697 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
698 assert_eq!(*node_id, node_recv.node.get_our_node_id());
700 } else { panic!("Unexpected event: {:?}", events_6[1]); };
701 ((match events_6[0] {
702 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
703 channel_id = msg.channel_id.clone();
704 assert_eq!(*node_id, node_recv.node.get_our_node_id());
707 _ => panic!("Unexpected event"),
708 }, match events_6[announcement_sigs_idx] {
709 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
710 assert_eq!(*node_id, node_recv.node.get_our_node_id());
713 _ => panic!("Unexpected event"),
717 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
718 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
719 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
720 confirm_transaction_at(node_a, tx, conf_height);
721 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
722 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
725 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::ChannelReady, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
726 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
727 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
731 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::ChannelReady, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
732 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
733 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
734 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
736 let events_7 = node_b.node.get_and_clear_pending_msg_events();
737 assert_eq!(events_7.len(), 1);
738 let (announcement, bs_update) = match events_7[0] {
739 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
742 _ => panic!("Unexpected event"),
745 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
746 let events_8 = node_a.node.get_and_clear_pending_msg_events();
747 assert_eq!(events_8.len(), 1);
748 let as_update = match events_8[0] {
749 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
750 assert!(*announcement == *msg);
751 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
752 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
755 _ => panic!("Unexpected event"),
758 *node_a.network_chan_count.borrow_mut() += 1;
760 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
763 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) {
764 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
767 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) {
768 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
769 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
770 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
773 pub fn create_unannounced_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::ChannelReady, Transaction) {
774 let mut no_announce_cfg = test_default_channel_config();
775 no_announce_cfg.channel_handshake_config.announced_channel = false;
776 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
777 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
778 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
779 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
780 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
782 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
783 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
784 nodes[b].node.handle_funding_created(&nodes[a].node.get_our_node_id(), &get_event_msg!(nodes[a], MessageSendEvent::SendFundingCreated, nodes[b].node.get_our_node_id()));
785 check_added_monitors!(nodes[b], 1);
787 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
788 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
789 check_added_monitors!(nodes[a], 1);
791 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
792 confirm_transaction_at(&nodes[a], &tx, conf_height);
793 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
794 confirm_transaction_at(&nodes[b], &tx, conf_height);
795 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
796 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
797 nodes[a].node.handle_channel_ready(&nodes[b].node.get_our_node_id(), &get_event_msg!(nodes[b], MessageSendEvent::SendChannelReady, nodes[a].node.get_our_node_id()));
798 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
799 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
800 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
802 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
803 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
805 let mut found_a = false;
806 for chan in nodes[a].node.list_usable_channels() {
807 if chan.channel_id == as_channel_ready.channel_id {
810 assert!(!chan.is_public);
815 let mut found_b = false;
816 for chan in nodes[b].node.list_usable_channels() {
817 if chan.channel_id == as_channel_ready.channel_id {
820 assert!(!chan.is_public);
825 (as_channel_ready, tx)
828 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) {
829 nodes[a].node.broadcast_node_announcement([0, 0, 0], [0; 32], Vec::new());
830 let a_events = nodes[a].node.get_and_clear_pending_msg_events();
831 assert!(a_events.len() >= 2);
833 // ann should be re-generated by broadcast_node_announcement - check that we have it.
834 let mut found_ann_1 = false;
835 for event in a_events.iter() {
837 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
838 if msg == ann { found_ann_1 = true; }
840 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
841 _ => panic!("Unexpected event {:?}", event),
844 assert!(found_ann_1);
846 let a_node_announcement = match a_events.last().unwrap() {
847 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
850 _ => panic!("Unexpected event"),
853 nodes[b].node.broadcast_node_announcement([1, 1, 1], [1; 32], Vec::new());
854 let b_events = nodes[b].node.get_and_clear_pending_msg_events();
855 assert!(b_events.len() >= 2);
857 // ann should be re-generated by broadcast_node_announcement - check that we have it.
858 let mut found_ann_2 = false;
859 for event in b_events.iter() {
861 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, .. } => {
862 if msg == ann { found_ann_2 = true; }
864 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {},
865 _ => panic!("Unexpected event"),
868 assert!(found_ann_2);
870 let b_node_announcement = match b_events.last().unwrap() {
871 MessageSendEvent::BroadcastNodeAnnouncement { ref msg } => {
874 _ => panic!("Unexpected event"),
878 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
879 node.gossip_sync.handle_channel_update(upd_1).unwrap();
880 node.gossip_sync.handle_channel_update(upd_2).unwrap();
881 node.gossip_sync.handle_node_announcement(&a_node_announcement).unwrap();
882 node.gossip_sync.handle_node_announcement(&b_node_announcement).unwrap();
884 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
885 // forwarding info for local channels even if its not accepted in the network graph.
886 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
887 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
892 macro_rules! check_spends {
893 ($tx: expr, $($spends_txn: expr),*) => {
896 for outp in $spends_txn.output.iter() {
897 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
900 for outp in $tx.output.iter() {
901 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
903 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
905 if out_point.txid == $spends_txn.txid() {
906 return $spends_txn.output.get(out_point.vout as usize).cloned()
911 let mut total_value_in = 0;
912 for input in $tx.input.iter() {
913 total_value_in += get_output(&input.previous_output).unwrap().value;
915 let mut total_value_out = 0;
916 for output in $tx.output.iter() {
917 total_value_out += output.value;
919 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
920 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
921 assert!(total_value_out + min_fee <= total_value_in);
922 $tx.verify(get_output).unwrap();
927 macro_rules! get_closing_signed_broadcast {
928 ($node: expr, $dest_pubkey: expr) => {
930 let events = $node.get_and_clear_pending_msg_events();
931 assert!(events.len() == 1 || events.len() == 2);
932 (match events[events.len() - 1] {
933 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
934 assert_eq!(msg.contents.flags & 2, 2);
937 _ => panic!("Unexpected event"),
938 }, if events.len() == 2 {
940 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
941 assert_eq!(*node_id, $dest_pubkey);
944 _ => panic!("Unexpected event"),
952 macro_rules! check_warn_msg {
953 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
954 let msg_events = $node.node.get_and_clear_pending_msg_events();
955 assert_eq!(msg_events.len(), 1);
956 match msg_events[0] {
957 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
958 assert_eq!(node_id, $recipient_node_id);
959 assert_eq!(msg.channel_id, $chan_id);
962 _ => panic!("Unexpected event"),
967 /// Check that a channel's closing channel update has been broadcasted, and optionally
968 /// check whether an error message event has occurred.
970 macro_rules! check_closed_broadcast {
971 ($node: expr, $with_error_msg: expr) => {{
972 use $crate::util::events::MessageSendEvent;
973 use $crate::ln::msgs::ErrorAction;
975 let msg_events = $node.node.get_and_clear_pending_msg_events();
976 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
977 match msg_events[0] {
978 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
979 assert_eq!(msg.contents.flags & 2, 2);
981 _ => panic!("Unexpected event"),
984 match msg_events[1] {
985 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
986 // TODO: Check node_id
989 _ => panic!("Unexpected event"),
995 /// Check that a channel's closing channel events has been issued
997 macro_rules! check_closed_event {
998 ($node: expr, $events: expr, $reason: expr) => {
999 check_closed_event!($node, $events, $reason, false);
1001 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1002 use $crate::util::events::Event;
1004 let events = $node.node.get_and_clear_pending_events();
1005 assert_eq!(events.len(), $events);
1006 let expected_reason = $reason;
1007 let mut issues_discard_funding = false;
1008 for event in events {
1010 Event::ChannelClosed { ref reason, .. } => {
1011 assert_eq!(*reason, expected_reason);
1013 Event::DiscardFunding { .. } => {
1014 issues_discard_funding = true;
1016 _ => panic!("Unexpected event"),
1019 assert_eq!($is_check_discard_funding, issues_discard_funding);
1023 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) {
1024 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) };
1025 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) };
1028 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1029 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()));
1031 let events_1 = node_b.get_and_clear_pending_msg_events();
1032 assert!(events_1.len() >= 1);
1033 let shutdown_b = match events_1[0] {
1034 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1035 assert_eq!(node_id, &node_a.get_our_node_id());
1038 _ => panic!("Unexpected event"),
1041 let closing_signed_b = if !close_inbound_first {
1042 assert_eq!(events_1.len(), 1);
1045 Some(match events_1[1] {
1046 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1047 assert_eq!(node_id, &node_a.get_our_node_id());
1050 _ => panic!("Unexpected event"),
1054 node_a.handle_shutdown(&node_b.get_our_node_id(), &InitFeatures::known(), &shutdown_b);
1055 let (as_update, bs_update) = if close_inbound_first {
1056 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1057 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1059 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1060 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1061 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1062 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1064 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1065 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1066 assert!(none_a.is_none());
1067 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1068 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1069 (as_update, bs_update)
1071 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1073 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1074 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1076 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1077 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1078 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1080 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1081 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1082 assert!(none_b.is_none());
1083 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1084 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1085 (as_update, bs_update)
1087 assert_eq!(tx_a, tx_b);
1088 check_spends!(tx_a, funding_tx);
1090 (as_update, bs_update, tx_a)
1093 pub struct SendEvent {
1094 pub node_id: PublicKey,
1095 pub msgs: Vec<msgs::UpdateAddHTLC>,
1096 pub commitment_msg: msgs::CommitmentSigned,
1099 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1100 assert!(updates.update_fulfill_htlcs.is_empty());
1101 assert!(updates.update_fail_htlcs.is_empty());
1102 assert!(updates.update_fail_malformed_htlcs.is_empty());
1103 assert!(updates.update_fee.is_none());
1104 SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1107 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1109 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1110 _ => panic!("Unexpected event type!"),
1114 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1115 let mut events = node.node.get_and_clear_pending_msg_events();
1116 assert_eq!(events.len(), 1);
1117 SendEvent::from_event(events.pop().unwrap())
1122 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1123 /// commitment update.
1124 macro_rules! commitment_signed_dance {
1125 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1127 check_added_monitors!($node_a, 0);
1128 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1129 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1130 check_added_monitors!($node_a, 1);
1131 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1134 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1136 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1137 check_added_monitors!($node_b, 0);
1138 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1139 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1140 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1141 check_added_monitors!($node_b, 1);
1142 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1143 let (bs_revoke_and_ack, extra_msg_option) = {
1144 let events = $node_b.node.get_and_clear_pending_msg_events();
1145 assert!(events.len() <= 2);
1147 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1148 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1151 _ => panic!("Unexpected event"),
1152 }, events.get(1).map(|e| e.clone()))
1154 check_added_monitors!($node_b, 1);
1155 if $fail_backwards {
1156 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1157 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1159 (extra_msg_option, bs_revoke_and_ack)
1162 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1164 check_added_monitors!($node_a, 0);
1165 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1166 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1167 check_added_monitors!($node_a, 1);
1168 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1169 assert!(extra_msg_option.is_none());
1173 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1175 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1176 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1177 check_added_monitors!($node_a, 1);
1181 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1183 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1186 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1188 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1189 if $fail_backwards {
1190 expect_pending_htlcs_forwardable_and_htlc_handling_failed!($node_a, vec![$crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some($node_b.node.get_our_node_id()), channel_id: $commitment_signed.channel_id }]);
1191 check_added_monitors!($node_a, 1);
1193 let channel_state = $node_a.node.channel_state.lock().unwrap();
1194 assert_eq!(channel_state.pending_msg_events.len(), 1);
1195 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1196 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1197 } else { panic!("Unexpected event"); }
1199 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1205 /// Get a payment preimage and hash.
1207 macro_rules! get_payment_preimage_hash {
1208 ($dest_node: expr) => {
1210 get_payment_preimage_hash!($dest_node, None)
1213 ($dest_node: expr, $min_value_msat: expr) => {
1215 use bitcoin::hashes::Hash as _;
1216 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1217 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1218 *payment_count += 1;
1219 let payment_hash = $crate::ln::PaymentHash(
1220 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1221 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1222 (payment_preimage, payment_hash, payment_secret)
1228 macro_rules! get_route {
1229 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1230 use $crate::chain::keysinterface::KeysInterface;
1231 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1232 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1233 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1234 $crate::routing::router::get_route(
1235 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1236 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1237 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1244 macro_rules! get_route_and_payment_hash {
1245 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1246 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1247 .with_features($crate::ln::features::InvoiceFeatures::known());
1248 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1250 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1251 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1252 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1253 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1258 macro_rules! expect_pending_htlcs_forwardable_conditions {
1259 ($node: expr, $expected_failures: expr) => {{
1260 let expected_failures = $expected_failures;
1261 let events = $node.node.get_and_clear_pending_events();
1263 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1264 _ => panic!("Unexpected event"),
1267 let count = expected_failures.len() + 1;
1268 assert_eq!(events.len(), count);
1270 if expected_failures.len() > 0 {
1271 expect_htlc_handling_failed_destinations!(events, expected_failures)
1277 macro_rules! expect_htlc_handling_failed_destinations {
1278 ($events: expr, $expected_failures: expr) => {{
1279 for event in $events {
1281 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1282 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1283 assert!($expected_failures.contains(&failed_next_destination))
1285 _ => panic!("Unexpected destination"),
1292 /// Clears (and ignores) a PendingHTLCsForwardable event
1293 macro_rules! expect_pending_htlcs_forwardable_ignore {
1295 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1300 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1301 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1302 ($node: expr, $expected_failures: expr) => {{
1303 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1308 /// Handles a PendingHTLCsForwardable event
1309 macro_rules! expect_pending_htlcs_forwardable {
1311 expect_pending_htlcs_forwardable_ignore!($node);
1312 $node.node.process_pending_htlc_forwards();
1314 // Ensure process_pending_htlc_forwards is idempotent.
1315 $node.node.process_pending_htlc_forwards();
1320 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1321 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1322 ($node: expr, $expected_failures: expr) => {{
1323 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1324 $node.node.process_pending_htlc_forwards();
1326 // Ensure process_pending_htlc_forwards is idempotent.
1327 $node.node.process_pending_htlc_forwards();
1332 macro_rules! expect_pending_htlcs_forwardable_from_events {
1333 ($node: expr, $events: expr, $ignore: expr) => {{
1334 assert_eq!($events.len(), 1);
1336 Event::PendingHTLCsForwardable { .. } => { },
1337 _ => panic!("Unexpected event"),
1340 $node.node.process_pending_htlc_forwards();
1342 // Ensure process_pending_htlc_forwards is idempotent.
1343 $node.node.process_pending_htlc_forwards();
1349 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1350 macro_rules! expect_payment_received {
1351 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1352 expect_payment_received!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None)
1354 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr) => {
1355 let events = $node.node.get_and_clear_pending_events();
1356 assert_eq!(events.len(), 1);
1358 $crate::util::events::Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1359 assert_eq!($expected_payment_hash, *payment_hash);
1360 assert_eq!($expected_recv_value, amount_msat);
1362 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1363 assert_eq!(&$expected_payment_preimage, payment_preimage);
1364 assert_eq!($expected_payment_secret, *payment_secret);
1369 _ => panic!("Unexpected event"),
1375 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1376 macro_rules! expect_payment_claimed {
1377 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1378 let events = $node.node.get_and_clear_pending_events();
1379 assert_eq!(events.len(), 1);
1381 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1382 assert_eq!($expected_payment_hash, *payment_hash);
1383 assert_eq!($expected_recv_value, amount_msat);
1385 _ => panic!("Unexpected event"),
1392 macro_rules! expect_payment_sent_without_paths {
1393 ($node: expr, $expected_payment_preimage: expr) => {
1394 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1396 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1397 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1402 macro_rules! expect_payment_sent {
1403 ($node: expr, $expected_payment_preimage: expr) => {
1404 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1406 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1407 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1409 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1410 use bitcoin::hashes::Hash as _;
1411 let events = $node.node.get_and_clear_pending_events();
1412 let expected_payment_hash = $crate::ln::PaymentHash(
1413 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1415 assert!(events.len() > 1);
1417 assert_eq!(events.len(), 1);
1419 let expected_payment_id = match events[0] {
1420 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1421 assert_eq!($expected_payment_preimage, *payment_preimage);
1422 assert_eq!(expected_payment_hash, *payment_hash);
1423 assert!(fee_paid_msat.is_some());
1424 if $expected_fee_msat_opt.is_some() {
1425 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1429 _ => panic!("Unexpected event"),
1432 for i in 1..events.len() {
1434 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1435 assert_eq!(payment_id, expected_payment_id);
1436 assert_eq!(payment_hash, Some(expected_payment_hash));
1438 _ => panic!("Unexpected event"),
1447 macro_rules! expect_payment_path_successful {
1449 let events = $node.node.get_and_clear_pending_events();
1450 assert_eq!(events.len(), 1);
1452 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1453 _ => panic!("Unexpected event"),
1458 macro_rules! expect_payment_forwarded {
1459 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1460 let events = $node.node.get_and_clear_pending_events();
1461 assert_eq!(events.len(), 1);
1463 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1464 assert_eq!(fee_earned_msat, $expected_fee);
1465 if fee_earned_msat.is_some() {
1466 // Is the event prev_channel_id in one of the channels between the two nodes?
1467 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $prev_node.node.get_our_node_id() && x.channel_id == prev_channel_id.unwrap()));
1469 // We check for force closures since a force closed channel is removed from the
1470 // node's channel list
1471 if !$downstream_force_closed {
1472 assert!($node.node.list_channels().iter().any(|x| x.counterparty.node_id == $next_node.node.get_our_node_id() && x.channel_id == next_channel_id.unwrap()));
1474 assert_eq!(claim_from_onchain_tx, $upstream_force_closed);
1476 _ => panic!("Unexpected event"),
1481 pub struct PaymentFailedConditions<'a> {
1482 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1483 pub(crate) expected_blamed_scid: Option<u64>,
1484 pub(crate) expected_blamed_chan_closed: Option<bool>,
1485 pub(crate) expected_mpp_parts_remain: bool,
1488 impl<'a> PaymentFailedConditions<'a> {
1489 pub fn new() -> Self {
1491 expected_htlc_error_data: None,
1492 expected_blamed_scid: None,
1493 expected_blamed_chan_closed: None,
1494 expected_mpp_parts_remain: false,
1497 pub fn mpp_parts_remain(mut self) -> Self {
1498 self.expected_mpp_parts_remain = true;
1501 pub fn blamed_scid(mut self, scid: u64) -> Self {
1502 self.expected_blamed_scid = Some(scid);
1505 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1506 self.expected_blamed_chan_closed = Some(closed);
1509 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1510 self.expected_htlc_error_data = Some((code, data));
1516 macro_rules! expect_payment_failed_with_update {
1517 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr, $scid: expr, $chan_closed: expr) => {
1518 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1519 &$node, $expected_payment_hash, $rejected_by_dest,
1520 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1521 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1526 macro_rules! expect_payment_failed {
1527 ($node: expr, $expected_payment_hash: expr, $rejected_by_dest: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1528 #[allow(unused_mut)]
1529 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1531 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1533 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $rejected_by_dest, conditions);
1537 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1538 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_rejected_by_dest: bool,
1539 conditions: PaymentFailedConditions<'e>
1541 let mut events = node.node.get_and_clear_pending_events();
1542 assert_eq!(events.len(), 1);
1543 let expected_payment_id = match events.pop().unwrap() {
1544 Event::PaymentPathFailed { payment_hash, rejected_by_dest, path, retry, payment_id, network_update, short_channel_id,
1548 error_data, .. } => {
1549 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1550 assert_eq!(rejected_by_dest, expected_rejected_by_dest, "unexpected rejected_by_dest value");
1551 assert!(retry.is_some(), "expected retry.is_some()");
1552 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1553 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1554 if let Some(scid) = short_channel_id {
1555 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1560 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1561 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1562 if let Some((code, data)) = conditions.expected_htlc_error_data {
1563 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1564 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1568 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1569 match network_update {
1570 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1571 if let Some(scid) = conditions.expected_blamed_scid {
1572 assert_eq!(msg.contents.short_channel_id, scid);
1574 const CHAN_DISABLED_FLAG: u8 = 2;
1575 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1577 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1578 if let Some(scid) = conditions.expected_blamed_scid {
1579 assert_eq!(short_channel_id, scid);
1581 assert!(is_permanent);
1583 Some(_) => panic!("Unexpected update type"),
1584 None => panic!("Expected update"),
1590 _ => panic!("Unexpected event"),
1592 if !conditions.expected_mpp_parts_remain {
1593 node.node.abandon_payment(expected_payment_id);
1594 let events = node.node.get_and_clear_pending_events();
1595 assert_eq!(events.len(), 1);
1597 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1598 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1599 assert_eq!(*payment_id, expected_payment_id);
1601 _ => panic!("Unexpected second event"),
1606 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 {
1607 let payment_id = origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret)).unwrap();
1608 check_added_monitors!(origin_node, expected_paths.len());
1609 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1613 pub fn do_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, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) {
1614 let mut payment_event = SendEvent::from_event(ev);
1615 let mut prev_node = origin_node;
1617 for (idx, &node) in expected_path.iter().enumerate() {
1618 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1620 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1621 check_added_monitors!(node, 0);
1622 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1624 expect_pending_htlcs_forwardable!(node);
1626 if idx == expected_path.len() - 1 && clear_recipient_events {
1627 let events_2 = node.node.get_and_clear_pending_events();
1628 if payment_received_expected {
1629 assert_eq!(events_2.len(), 1);
1631 Event::PaymentReceived { ref payment_hash, ref purpose, amount_msat } => {
1632 assert_eq!(our_payment_hash, *payment_hash);
1634 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1635 assert_eq!(expected_preimage, *payment_preimage);
1636 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1638 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1639 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1640 assert!(our_payment_secret.is_none());
1643 assert_eq!(amount_msat, recv_value);
1645 _ => panic!("Unexpected event"),
1648 assert!(events_2.is_empty());
1650 } else if idx != expected_path.len() - 1 {
1651 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1652 assert_eq!(events_2.len(), 1);
1653 check_added_monitors!(node, 1);
1654 payment_event = SendEvent::from_event(events_2.remove(0));
1655 assert_eq!(payment_event.msgs.len(), 1);
1662 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>) {
1663 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_received_expected, true, expected_preimage);
1666 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) {
1667 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1668 assert_eq!(events.len(), expected_route.len());
1669 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1670 // Once we've gotten through all the HTLCs, the last one should result in a
1671 // PaymentReceived (but each previous one should not!), .
1672 let expect_payment = path_idx == expected_route.len() - 1;
1673 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1677 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) {
1678 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1679 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1680 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1683 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 {
1684 for path in expected_paths.iter() {
1685 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1687 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1689 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1690 assert_eq!(claim_event.len(), 1);
1691 match claim_event[0] {
1692 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1693 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1694 assert_eq!(preimage, our_payment_preimage),
1695 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1696 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1700 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1702 let mut expected_total_fee_msat = 0;
1704 macro_rules! msgs_from_ev {
1707 &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 } } => {
1708 assert!(update_add_htlcs.is_empty());
1709 assert_eq!(update_fulfill_htlcs.len(), 1);
1710 assert!(update_fail_htlcs.is_empty());
1711 assert!(update_fail_malformed_htlcs.is_empty());
1712 assert!(update_fee.is_none());
1713 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1715 _ => panic!("Unexpected event"),
1719 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1720 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1721 assert_eq!(events.len(), expected_paths.len());
1722 for ev in events.iter() {
1723 per_path_msgs.push(msgs_from_ev!(ev));
1726 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1727 let mut next_msgs = Some(path_msgs);
1728 let mut expected_next_node = next_hop;
1730 macro_rules! last_update_fulfill_dance {
1731 ($node: expr, $prev_node: expr) => {
1733 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1734 check_added_monitors!($node, 0);
1735 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1736 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1740 macro_rules! mid_update_fulfill_dance {
1741 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1743 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1745 let channel_state = $node.node.channel_state.lock().unwrap();
1746 let channel = channel_state
1747 .by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1748 if let Some(prev_config) = channel.prev_config() {
1749 prev_config.forwarding_fee_base_msat
1751 channel.config().forwarding_fee_base_msat
1754 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1755 expected_total_fee_msat += fee as u64;
1756 check_added_monitors!($node, 1);
1757 let new_next_msgs = if $new_msgs {
1758 let events = $node.node.get_and_clear_pending_msg_events();
1759 assert_eq!(events.len(), 1);
1760 let (res, nexthop) = msgs_from_ev!(&events[0]);
1761 expected_next_node = nexthop;
1764 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1767 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1768 next_msgs = new_next_msgs;
1773 let mut prev_node = expected_route.last().unwrap();
1774 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1775 assert_eq!(expected_next_node, node.node.get_our_node_id());
1776 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1777 if next_msgs.is_some() {
1778 // Since we are traversing in reverse, next_node is actually the previous node
1779 let next_node: &Node;
1780 if idx == expected_route.len() - 1 {
1781 next_node = origin_node;
1783 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1785 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1787 assert!(!update_next_msgs);
1788 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1790 if !skip_last && idx == expected_route.len() - 1 {
1791 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1798 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1802 // Ensure that claim_funds is idempotent.
1803 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1804 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1805 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1807 expected_total_fee_msat
1809 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) {
1810 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1812 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1816 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1817 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1820 pub const TEST_FINAL_CLTV: u32 = 70;
1822 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) {
1823 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1824 .with_features(InvoiceFeatures::known());
1825 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1826 assert_eq!(route.paths.len(), 1);
1827 assert_eq!(route.paths[0].len(), expected_route.len());
1828 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1829 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1832 let res = send_along_route(origin_node, route, expected_route, recv_value);
1833 (res.0, res.1, res.2)
1836 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1837 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1838 .with_features(InvoiceFeatures::known());
1839 let network_graph = origin_node.network_graph.read_only();
1840 let scorer = test_utils::TestScorer::with_penalty(0);
1841 let seed = [0u8; 32];
1842 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1843 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1844 let route = get_route(
1845 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
1846 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
1847 assert_eq!(route.paths.len(), 1);
1848 assert_eq!(route.paths[0].len(), expected_route.len());
1849 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1850 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1853 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
1854 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage)), true, APIError::ChannelUnavailable { ref err },
1855 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
1858 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1859 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
1860 claim_payment(&origin, expected_route, our_payment_preimage);
1863 pub fn fail_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1864 for path in expected_paths.iter() {
1865 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1867 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1868 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
1869 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
1871 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
1874 pub fn pass_failed_payment_back<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) {
1875 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
1876 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1878 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1879 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1880 assert_eq!(events.len(), expected_paths.len());
1881 for ev in events.iter() {
1882 let (update_fail, commitment_signed, node_id) = match ev {
1883 &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 } } => {
1884 assert!(update_add_htlcs.is_empty());
1885 assert!(update_fulfill_htlcs.is_empty());
1886 assert_eq!(update_fail_htlcs.len(), 1);
1887 assert!(update_fail_malformed_htlcs.is_empty());
1888 assert!(update_fee.is_none());
1889 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
1891 _ => panic!("Unexpected event"),
1893 per_path_msgs.push(((update_fail, commitment_signed), node_id));
1895 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
1896 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()));
1898 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
1899 let mut next_msgs = Some(path_msgs);
1900 let mut expected_next_node = next_hop;
1901 let mut prev_node = expected_route.last().unwrap();
1903 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1904 assert_eq!(expected_next_node, node.node.get_our_node_id());
1905 let update_next_node = !skip_last || idx != expected_route.len() - 1;
1906 if next_msgs.is_some() {
1907 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1908 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
1909 if !update_next_node {
1910 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node, vec![HTLCDestination::NextHopChannel { node_id: Some(prev_node.node.get_our_node_id()), channel_id: next_msgs.as_ref().unwrap().0.channel_id }]);
1913 let events = node.node.get_and_clear_pending_msg_events();
1914 if update_next_node {
1915 assert_eq!(events.len(), 1);
1917 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 } } => {
1918 assert!(update_add_htlcs.is_empty());
1919 assert!(update_fulfill_htlcs.is_empty());
1920 assert_eq!(update_fail_htlcs.len(), 1);
1921 assert!(update_fail_malformed_htlcs.is_empty());
1922 assert!(update_fee.is_none());
1923 expected_next_node = node_id.clone();
1924 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
1926 _ => panic!("Unexpected event"),
1929 assert!(events.is_empty());
1931 if !skip_last && idx == expected_route.len() - 1 {
1932 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1939 let prev_node = expected_route.first().unwrap();
1940 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1941 check_added_monitors!(origin_node, 0);
1942 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
1943 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
1944 let events = origin_node.node.get_and_clear_pending_events();
1945 assert_eq!(events.len(), 1);
1946 let expected_payment_id = match events[0] {
1947 Event::PaymentPathFailed { payment_hash, rejected_by_dest, all_paths_failed, ref path, ref payment_id, .. } => {
1948 assert_eq!(payment_hash, our_payment_hash);
1949 assert!(rejected_by_dest);
1950 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
1951 for (idx, hop) in expected_route.iter().enumerate() {
1952 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
1956 _ => panic!("Unexpected event"),
1958 if i == expected_paths.len() - 1 {
1959 origin_node.node.abandon_payment(expected_payment_id);
1960 let events = origin_node.node.get_and_clear_pending_events();
1961 assert_eq!(events.len(), 1);
1963 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1964 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
1965 assert_eq!(*payment_id, expected_payment_id);
1967 _ => panic!("Unexpected second event"),
1973 // Ensure that fail_htlc_backwards is idempotent.
1974 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
1975 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
1976 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1977 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1980 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
1981 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
1984 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
1985 let mut chan_mon_cfgs = Vec::new();
1986 for i in 0..node_count {
1987 let tx_broadcaster = test_utils::TestBroadcaster {
1988 txn_broadcasted: Mutex::new(Vec::new()),
1989 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
1991 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
1992 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
1993 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
1994 let persister = test_utils::TestPersister::new();
1995 let seed = [i as u8; 32];
1996 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
1998 chan_mon_cfgs.push(TestChanMonCfg{ tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2004 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2005 let mut nodes = Vec::new();
2007 for i in 0..node_count {
2008 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);
2009 let seed = [i as u8; 32];
2010 nodes.push(NodeCfg {
2011 chain_source: &chanmon_cfgs[i].chain_source,
2012 logger: &chanmon_cfgs[i].logger,
2013 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2014 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2016 keys_manager: &chanmon_cfgs[i].keys_manager,
2018 features: InitFeatures::known(),
2019 network_graph: NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger),
2026 pub fn test_default_channel_config() -> UserConfig {
2027 let mut default_config = UserConfig::default();
2028 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2029 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2030 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2031 default_config.channel_handshake_config.announced_channel = true;
2032 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2033 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2034 // It now defaults to 1, so we simply set it to the expected value here.
2035 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2036 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2037 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2038 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2042 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>> {
2043 let mut chanmgrs = Vec::new();
2044 for i in 0..node_count {
2045 let network = Network::Testnet;
2046 let params = ChainParameters {
2048 best_block: BestBlock::from_genesis(network),
2050 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, cfgs[i].logger, cfgs[i].keys_manager,
2051 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2052 chanmgrs.push(node);
2058 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>> {
2059 let mut nodes = Vec::new();
2060 let chan_count = Rc::new(RefCell::new(0));
2061 let payment_count = Rc::new(RefCell::new(0));
2062 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2064 for i in 0..node_count {
2065 let gossip_sync = P2PGossipSync::new(&cfgs[i].network_graph, None, cfgs[i].logger);
2067 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2068 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2069 node: &chan_mgrs[i], network_graph: &cfgs[i].network_graph, gossip_sync,
2070 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2071 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2072 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2073 connect_style: Rc::clone(&connect_style),
2077 for i in 0..node_count {
2078 for j in (i+1)..node_count {
2079 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None });
2080 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None });
2087 // Note that the following only works for CLTV values up to 128
2088 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2089 pub const OFFERED_HTLC_SCRIPT_WEIGHT: usize = 133;
2091 #[derive(PartialEq)]
2092 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2093 /// Tests that the given node has broadcast transactions for the given Channel
2095 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2096 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2097 /// broadcast and the revoked outputs were claimed.
2099 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2100 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2102 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2104 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> {
2105 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2106 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2108 let mut res = Vec::with_capacity(2);
2109 node_txn.retain(|tx| {
2110 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2111 check_spends!(tx, chan.3);
2112 if commitment_tx.is_none() {
2113 res.push(tx.clone());
2118 if let Some(explicit_tx) = commitment_tx {
2119 res.push(explicit_tx.clone());
2122 assert_eq!(res.len(), 1);
2124 if has_htlc_tx != HTLCType::NONE {
2125 node_txn.retain(|tx| {
2126 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2127 check_spends!(tx, res[0]);
2128 if has_htlc_tx == HTLCType::TIMEOUT {
2129 assert!(tx.lock_time.0 != 0);
2131 assert!(tx.lock_time.0 == 0);
2133 res.push(tx.clone());
2137 assert!(res.len() == 2 || res.len() == 3);
2139 assert_eq!(res[1], res[2]);
2143 assert!(node_txn.is_empty());
2147 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2148 /// HTLC transaction.
2149 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2150 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2151 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2152 // for revoked htlc outputs
2153 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2154 node_txn.retain(|tx| {
2155 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2156 check_spends!(tx, revoked_tx);
2160 node_txn.retain(|tx| {
2161 check_spends!(tx, commitment_revoked_tx);
2164 assert!(node_txn.is_empty());
2167 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2168 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2170 assert!(node_txn.len() >= 1);
2171 assert_eq!(node_txn[0].input.len(), 1);
2172 let mut found_prev = false;
2174 for tx in prev_txn {
2175 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2176 check_spends!(node_txn[0], tx);
2177 let mut iter = node_txn[0].input[0].witness.iter();
2178 iter.next().expect("expected 3 witness items");
2179 iter.next().expect("expected 3 witness items");
2180 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2181 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2187 assert!(found_prev);
2189 let mut res = Vec::new();
2190 mem::swap(&mut *node_txn, &mut res);
2194 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) {
2195 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2196 assert_eq!(events_1.len(), 2);
2197 let as_update = match events_1[0] {
2198 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2201 _ => panic!("Unexpected event"),
2204 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2205 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2206 assert_eq!(msg.data, expected_error);
2207 if needs_err_handle {
2208 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2211 _ => panic!("Unexpected event"),
2214 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2215 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2216 let bs_update = match events_2[0] {
2217 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2220 _ => panic!("Unexpected event"),
2222 if !needs_err_handle {
2224 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2225 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2226 assert_eq!(msg.data, expected_error);
2228 _ => panic!("Unexpected event"),
2233 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2234 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2238 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2239 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2243 macro_rules! get_channel_value_stat {
2244 ($node: expr, $channel_id: expr) => {{
2245 let chan_lock = $node.node.channel_state.lock().unwrap();
2246 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
2247 chan.get_value_stat()
2251 macro_rules! get_chan_reestablish_msgs {
2252 ($src_node: expr, $dst_node: expr) => {
2254 let mut res = Vec::with_capacity(1);
2255 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2256 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2257 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2258 res.push(msg.clone());
2260 panic!("Unexpected event")
2268 macro_rules! handle_chan_reestablish_msgs {
2269 ($src_node: expr, $dst_node: expr) => {
2271 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2273 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2275 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2281 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2283 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2286 let mut revoke_and_ack = None;
2287 let mut commitment_update = None;
2288 let order = if let Some(ev) = msg_events.get(idx) {
2290 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2291 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2292 revoke_and_ack = Some(msg.clone());
2294 RAACommitmentOrder::RevokeAndACKFirst
2296 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2297 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2298 commitment_update = Some(updates.clone());
2300 RAACommitmentOrder::CommitmentFirst
2302 _ => RAACommitmentOrder::CommitmentFirst,
2305 RAACommitmentOrder::CommitmentFirst
2308 if let Some(ev) = msg_events.get(idx) {
2310 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2311 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2312 assert!(revoke_and_ack.is_none());
2313 revoke_and_ack = Some(msg.clone());
2316 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2317 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2318 assert!(commitment_update.is_none());
2319 commitment_update = Some(updates.clone());
2326 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2327 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2329 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2332 assert_eq!(msg_events.len(), idx);
2334 (channel_ready, revoke_and_ack, commitment_update, order)
2339 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2340 /// for claims/fails they are separated out.
2341 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_channel_ready: (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)) {
2342 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2343 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2344 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty(), remote_network_address: None });
2345 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2347 if send_channel_ready.0 {
2348 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2350 for reestablish in reestablish_1.iter() {
2351 assert_eq!(reestablish.next_remote_commitment_number, 0);
2354 if send_channel_ready.1 {
2355 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2357 for reestablish in reestablish_2.iter() {
2358 assert_eq!(reestablish.next_remote_commitment_number, 0);
2361 if send_channel_ready.0 || send_channel_ready.1 {
2362 // If we expect any channel_ready's, both sides better have set
2363 // next_holder_commitment_number to 1
2364 for reestablish in reestablish_1.iter() {
2365 assert_eq!(reestablish.next_local_commitment_number, 1);
2367 for reestablish in reestablish_2.iter() {
2368 assert_eq!(reestablish.next_local_commitment_number, 1);
2372 let mut resp_1 = Vec::new();
2373 for msg in reestablish_1 {
2374 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2375 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2377 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2378 check_added_monitors!(node_b, 1);
2380 check_added_monitors!(node_b, 0);
2383 let mut resp_2 = Vec::new();
2384 for msg in reestablish_2 {
2385 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2386 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2388 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2389 check_added_monitors!(node_a, 1);
2391 check_added_monitors!(node_a, 0);
2394 // We don't yet support both needing updates, as that would require a different commitment dance:
2395 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2396 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2397 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2398 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2400 for chan_msgs in resp_1.drain(..) {
2401 if send_channel_ready.0 {
2402 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2403 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2404 if !announcement_event.is_empty() {
2405 assert_eq!(announcement_event.len(), 1);
2406 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2407 //TODO: Test announcement_sigs re-sending
2408 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2411 assert!(chan_msgs.0.is_none());
2414 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2415 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2416 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2417 check_added_monitors!(node_a, 1);
2419 assert!(chan_msgs.1.is_none());
2421 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 {
2422 let commitment_update = chan_msgs.2.unwrap();
2423 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2424 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2426 assert!(commitment_update.update_add_htlcs.is_empty());
2428 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2429 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2430 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2431 for update_add in commitment_update.update_add_htlcs {
2432 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2434 for update_fulfill in commitment_update.update_fulfill_htlcs {
2435 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2437 for update_fail in commitment_update.update_fail_htlcs {
2438 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2441 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2442 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2444 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2445 check_added_monitors!(node_a, 1);
2446 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2447 // No commitment_signed so get_event_msg's assert(len == 1) passes
2448 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2449 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2450 check_added_monitors!(node_b, 1);
2453 assert!(chan_msgs.2.is_none());
2457 for chan_msgs in resp_2.drain(..) {
2458 if send_channel_ready.1 {
2459 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2460 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2461 if !announcement_event.is_empty() {
2462 assert_eq!(announcement_event.len(), 1);
2463 match announcement_event[0] {
2464 MessageSendEvent::SendChannelUpdate { .. } => {},
2465 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2466 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2470 assert!(chan_msgs.0.is_none());
2473 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2474 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2475 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2476 check_added_monitors!(node_b, 1);
2478 assert!(chan_msgs.1.is_none());
2480 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 {
2481 let commitment_update = chan_msgs.2.unwrap();
2482 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2483 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2485 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2486 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2487 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2488 for update_add in commitment_update.update_add_htlcs {
2489 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2491 for update_fulfill in commitment_update.update_fulfill_htlcs {
2492 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2494 for update_fail in commitment_update.update_fail_htlcs {
2495 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2498 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2499 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2501 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2502 check_added_monitors!(node_b, 1);
2503 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2504 // No commitment_signed so get_event_msg's assert(len == 1) passes
2505 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2506 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2507 check_added_monitors!(node_a, 1);
2510 assert!(chan_msgs.2.is_none());