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 crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, keysinterface::EntropySource};
14 use crate::chain::channelmonitor::ChannelMonitor;
15 use crate::chain::transaction::OutPoint;
16 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId, MIN_CLTV_EXPIRY_DELTA};
18 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
19 use crate::routing::router::{self, PaymentParameters, Route};
20 use crate::ln::features::InitFeatures;
22 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use crate::util::events::ClosureReason;
24 use crate::util::enforcing_trait_impls::EnforcingSigner;
25 use crate::util::scid_utils;
26 use crate::util::test_utils;
27 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
28 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
29 use crate::util::errors::APIError;
30 use crate::util::config::UserConfig;
31 use crate::util::ser::{ReadableArgs, Writeable};
33 use bitcoin::blockdata::block::{Block, BlockHeader};
34 use bitcoin::blockdata::constants::genesis_block;
35 use bitcoin::blockdata::transaction::{Transaction, TxOut};
36 use bitcoin::network::constants::Network;
38 use bitcoin::hash_types::BlockHash;
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::Hash as _;
42 use bitcoin::secp256k1::PublicKey;
45 use crate::prelude::*;
46 use core::cell::RefCell;
48 use crate::sync::{Arc, Mutex, LockTestExt};
50 use core::iter::repeat;
51 use bitcoin::{PackedLockTime, TxMerkleNode};
53 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
55 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
56 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
58 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
59 /// output is the 1st output in the transaction.
60 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
61 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
62 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
65 /// Mine a single block containing the given transaction
66 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
67 let height = node.best_block_info().1 + 1;
68 confirm_transaction_at(node, tx, height);
70 /// Mine a single block containing the given transactions
71 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
72 let height = node.best_block_info().1 + 1;
73 confirm_transactions_at(node, txn, height);
75 /// Mine the given transaction at the given height, mining blocks as required to build to that
78 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
79 /// output is the 1st output in the transaction.
80 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
81 let first_connect_height = node.best_block_info().1 + 1;
82 assert!(first_connect_height <= conf_height);
83 if conf_height > first_connect_height {
84 connect_blocks(node, conf_height - first_connect_height);
86 let mut block = Block {
87 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
90 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
91 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
94 block.txdata.push((*tx).clone());
96 connect_block(node, &block);
97 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
99 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
100 confirm_transactions_at(node, &[tx], conf_height)
103 /// The possible ways we may notify a ChannelManager of a new block
104 #[derive(Clone, Copy, Debug, PartialEq)]
105 pub enum ConnectStyle {
106 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
107 /// the header and height information.
109 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
110 /// make a single `best_block_updated` call.
111 BestBlockFirstSkippingBlocks,
112 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
113 /// `transaction_unconfirmed` is called.
114 BestBlockFirstReorgsOnlyTip,
115 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
116 /// the header and height information.
118 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
119 /// make a single `best_block_updated` call.
120 TransactionsFirstSkippingBlocks,
121 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
122 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
123 /// times to ensure it's idempotent.
124 TransactionsDuplicativelyFirstSkippingBlocks,
125 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
126 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
127 /// times to ensure it's idempotent.
128 HighlyRedundantTransactionsFirstSkippingBlocks,
129 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
130 /// `transaction_unconfirmed` is called.
131 TransactionsFirstReorgsOnlyTip,
132 /// Provides the full block via the `chain::Listen` interface. In the current code this is
133 /// equivalent to `TransactionsFirst` with some additional assertions.
138 fn random_style() -> ConnectStyle {
139 #[cfg(feature = "std")] {
140 use core::hash::{BuildHasher, Hasher};
141 // Get a random value using the only std API to do so - the DefaultHasher
142 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
143 let res = match rand_val % 9 {
144 0 => ConnectStyle::BestBlockFirst,
145 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
146 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
147 3 => ConnectStyle::TransactionsFirst,
148 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
149 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
150 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
151 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
152 8 => ConnectStyle::FullBlockViaListen,
155 eprintln!("Using Block Connection Style: {:?}", res);
158 #[cfg(not(feature = "std"))] {
159 ConnectStyle::FullBlockViaListen
164 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
165 let skip_intermediaries = match *node.connect_style.borrow() {
166 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
167 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
168 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
172 let height = node.best_block_info().1 + 1;
173 let mut block = Block {
174 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
179 let prev_blockhash = block.header.block_hash();
180 do_connect_block(node, block, skip_intermediaries);
182 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
186 let hash = block.header.block_hash();
187 do_connect_block(node, block, false);
191 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
192 do_connect_block(node, block.clone(), false);
195 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
196 // Ensure `get_claimable_balances`' self-tests never panic
197 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
198 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
202 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
203 call_claimable_balances(node);
204 let height = node.best_block_info().1 + 1;
205 #[cfg(feature = "std")] {
206 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
208 if !skip_intermediaries {
209 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
210 match *node.connect_style.borrow() {
211 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
212 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
213 call_claimable_balances(node);
214 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
215 node.node.best_block_updated(&block.header, height);
216 node.node.transactions_confirmed(&block.header, &txdata, height);
218 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
219 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
220 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
221 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
222 let mut connections = Vec::new();
223 for (block, height) in node.blocks.lock().unwrap().iter() {
224 if !block.txdata.is_empty() {
225 // Reconnect all transactions we've ever seen to ensure transaction connection
226 // is *really* idempotent. This is a somewhat likely deployment for some
227 // esplora implementations of chain sync which try to reduce state and
228 // complexity as much as possible.
230 // Sadly we have to clone the block here to maintain lockorder. In the
231 // future we should consider Arc'ing the blocks to avoid this.
232 connections.push((block.clone(), *height));
235 for (old_block, height) in connections {
236 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
237 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
240 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
241 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
242 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
244 call_claimable_balances(node);
245 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
246 node.node.transactions_confirmed(&block.header, &txdata, height);
247 node.node.best_block_updated(&block.header, height);
249 ConnectStyle::FullBlockViaListen => {
250 node.chain_monitor.chain_monitor.block_connected(&block, height);
251 node.node.block_connected(&block, height);
255 call_claimable_balances(node);
256 node.node.test_process_background_events();
257 node.blocks.lock().unwrap().push((block, height));
260 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
261 call_claimable_balances(node);
262 #[cfg(feature = "std")] {
263 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
266 let orig = node.blocks.lock().unwrap().pop().unwrap();
267 assert!(orig.1 > 0); // Cannot disconnect genesis
268 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
270 match *node.connect_style.borrow() {
271 ConnectStyle::FullBlockViaListen => {
272 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
273 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
275 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
276 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
278 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
279 node.node.best_block_updated(&prev.0.header, prev.1);
282 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
283 for tx in orig.0.txdata {
284 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
285 node.node.transaction_unconfirmed(&tx.txid());
289 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
290 node.node.best_block_updated(&prev.0.header, prev.1);
293 call_claimable_balances(node);
297 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
298 let count = node.blocks.lock().unwrap().len() as u32 - 1;
299 disconnect_blocks(node, count);
302 pub struct TestChanMonCfg {
303 pub tx_broadcaster: test_utils::TestBroadcaster,
304 pub fee_estimator: test_utils::TestFeeEstimator,
305 pub chain_source: test_utils::TestChainSource,
306 pub persister: test_utils::TestPersister,
307 pub logger: test_utils::TestLogger,
308 pub keys_manager: test_utils::TestKeysInterface,
309 pub scorer: Mutex<test_utils::TestScorer>,
312 pub struct NodeCfg<'a> {
313 pub chain_source: &'a test_utils::TestChainSource,
314 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
315 pub fee_estimator: &'a test_utils::TestFeeEstimator,
316 pub router: test_utils::TestRouter<'a>,
317 pub chain_monitor: test_utils::TestChainMonitor<'a>,
318 pub keys_manager: &'a test_utils::TestKeysInterface,
319 pub logger: &'a test_utils::TestLogger,
320 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
321 pub node_seed: [u8; 32],
322 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
325 pub struct Node<'a, 'b: 'a, 'c: 'b> {
326 pub chain_source: &'c test_utils::TestChainSource,
327 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
328 pub fee_estimator: &'c test_utils::TestFeeEstimator,
329 pub router: &'b test_utils::TestRouter<'c>,
330 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
331 pub keys_manager: &'b test_utils::TestKeysInterface,
332 pub node: &'a ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'b test_utils::TestRouter<'c>, &'c test_utils::TestLogger>,
333 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
334 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
335 pub node_seed: [u8; 32],
336 pub network_payment_count: Rc<RefCell<u8>>,
337 pub network_chan_count: Rc<RefCell<u32>>,
338 pub logger: &'c test_utils::TestLogger,
339 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
340 pub connect_style: Rc<RefCell<ConnectStyle>>,
341 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
343 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
344 pub fn best_block_hash(&self) -> BlockHash {
345 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
347 pub fn best_block_info(&self) -> (BlockHash, u32) {
348 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
350 pub fn get_block_header(&self, height: u32) -> BlockHeader {
351 self.blocks.lock().unwrap()[height as usize].0.header
355 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
356 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
357 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
359 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
361 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
362 Self((node as *const Node<'a, 'b, 'c>).cast())
365 unsafe impl Send for NodePtr {}
366 unsafe impl Sync for NodePtr {}
368 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
371 // Check that we processed all pending events
372 let msg_events = self.node.get_and_clear_pending_msg_events();
373 if !msg_events.is_empty() {
374 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
376 let events = self.node.get_and_clear_pending_events();
377 if !events.is_empty() {
378 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
380 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
381 if !added_monitors.is_empty() {
382 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
385 // Check that if we serialize the network graph, we can deserialize it again.
386 let network_graph = {
387 let mut w = test_utils::TestVecWriter(Vec::new());
388 self.network_graph.write(&mut w).unwrap();
389 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
390 assert!(network_graph_deser == *self.network_graph);
391 let gossip_sync = P2PGossipSync::new(
392 &network_graph_deser, Some(self.chain_source), self.logger
394 let mut chan_progress = 0;
396 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
397 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
398 assert!(orig_announcements == deserialized_announcements);
399 chan_progress = match orig_announcements {
400 Some(announcement) => announcement.0.contents.short_channel_id + 1,
404 let mut node_progress = None;
406 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
407 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
408 assert!(orig_announcements == deserialized_announcements);
409 node_progress = match orig_announcements {
410 Some(announcement) => Some(announcement.contents.node_id),
417 // Check that if we serialize and then deserialize all our channel monitors we get the
418 // same set of outputs to watch for on chain as we have now. Note that if we write
419 // tests that fully close channels and remove the monitors at some point this may break.
420 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
421 let mut deserialized_monitors = Vec::new();
423 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
424 let mut w = test_utils::TestVecWriter(Vec::new());
425 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
426 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
427 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
428 deserialized_monitors.push(deserialized_monitor);
432 let broadcaster = test_utils::TestBroadcaster {
433 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
434 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
437 // Before using all the new monitors to check the watch outpoints, use the full set of
438 // them to ensure we can write and reload our ChannelManager.
440 let mut channel_monitors = HashMap::new();
441 for monitor in deserialized_monitors.iter_mut() {
442 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
445 let scorer = Mutex::new(test_utils::TestScorer::new());
446 let mut w = test_utils::TestVecWriter(Vec::new());
447 self.node.write(&mut w).unwrap();
448 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
449 default_config: *self.node.get_current_default_configuration(),
450 entropy_source: self.keys_manager,
451 node_signer: self.keys_manager,
452 signer_provider: self.keys_manager,
453 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
454 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
455 chain_monitor: self.chain_monitor,
456 tx_broadcaster: &broadcaster,
457 logger: &self.logger,
462 let persister = test_utils::TestPersister::new();
463 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
464 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
465 for deserialized_monitor in deserialized_monitors.drain(..) {
466 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
470 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
471 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
476 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
477 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
480 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) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
481 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
482 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
483 (announcement, as_update, bs_update, channel_id, tx)
486 /// Gets an RAA and CS which were sent in response to a commitment update
488 /// Should only be used directly when the `$node` is not actually a [`Node`].
489 macro_rules! do_get_revoke_commit_msgs {
490 ($node: expr, $recipient: expr) => { {
491 let events = $node.node.get_and_clear_pending_msg_events();
492 assert_eq!(events.len(), 2);
494 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
495 assert_eq!(node_id, $recipient);
498 _ => panic!("Unexpected event"),
500 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
501 assert_eq!(node_id, $recipient);
502 assert!(updates.update_add_htlcs.is_empty());
503 assert!(updates.update_fulfill_htlcs.is_empty());
504 assert!(updates.update_fail_htlcs.is_empty());
505 assert!(updates.update_fail_malformed_htlcs.is_empty());
506 assert!(updates.update_fee.is_none());
507 updates.commitment_signed.clone()
509 _ => panic!("Unexpected event"),
514 /// Gets an RAA and CS which were sent in response to a commitment update
515 pub fn get_revoke_commit_msgs(node: &Node, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
516 do_get_revoke_commit_msgs!(node, recipient)
520 /// Gets an RAA and CS which were sent in response to a commitment update
522 /// Don't use this, use the identically-named function instead.
523 macro_rules! get_revoke_commit_msgs {
524 ($node: expr, $node_id: expr) => {
525 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
529 /// Get an specific event message from the pending events queue.
531 macro_rules! get_event_msg {
532 ($node: expr, $event_type: path, $node_id: expr) => {
534 let events = $node.node.get_and_clear_pending_msg_events();
535 assert_eq!(events.len(), 1);
537 $event_type { ref node_id, ref msg } => {
538 assert_eq!(*node_id, $node_id);
541 _ => panic!("Unexpected event"),
547 /// Get an error message from the pending events queue.
548 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
549 let events = node.node.get_and_clear_pending_msg_events();
550 assert_eq!(events.len(), 1);
552 MessageSendEvent::HandleError {
553 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
555 assert_eq!(node_id, recipient);
558 _ => panic!("Unexpected event"),
562 /// Get a specific event from the pending events queue.
564 macro_rules! get_event {
565 ($node: expr, $event_type: path) => {
567 let mut events = $node.node.get_and_clear_pending_events();
568 assert_eq!(events.len(), 1);
569 let ev = events.pop().unwrap();
571 $event_type { .. } => {
574 _ => panic!("Unexpected event"),
580 /// Gets an UpdateHTLCs MessageSendEvent
581 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
582 let events = node.node.get_and_clear_pending_msg_events();
583 assert_eq!(events.len(), 1);
585 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
586 assert_eq!(node_id, recipient);
589 _ => panic!("Unexpected event"),
594 /// Gets an UpdateHTLCs MessageSendEvent
596 /// Don't use this, use the identically-named function instead.
597 macro_rules! get_htlc_update_msgs {
598 ($node: expr, $node_id: expr) => {
599 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
603 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
604 /// Returns the `msg_event`.
606 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
607 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
608 /// such messages are intended to all peers.
609 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
610 let ev_index = msg_events.iter().position(|e| { match e {
611 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
612 node_id == msg_node_id
614 MessageSendEvent::SendOpenChannel { node_id, .. } => {
615 node_id == msg_node_id
617 MessageSendEvent::SendFundingCreated { node_id, .. } => {
618 node_id == msg_node_id
620 MessageSendEvent::SendFundingSigned { node_id, .. } => {
621 node_id == msg_node_id
623 MessageSendEvent::SendChannelReady { node_id, .. } => {
624 node_id == msg_node_id
626 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
627 node_id == msg_node_id
629 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
630 node_id == msg_node_id
632 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
633 node_id == msg_node_id
635 MessageSendEvent::SendClosingSigned { node_id, .. } => {
636 node_id == msg_node_id
638 MessageSendEvent::SendShutdown { node_id, .. } => {
639 node_id == msg_node_id
641 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
642 node_id == msg_node_id
644 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
645 node_id == msg_node_id
647 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
650 MessageSendEvent::BroadcastChannelUpdate { .. } => {
653 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
656 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
657 node_id == msg_node_id
659 MessageSendEvent::HandleError { node_id, .. } => {
660 node_id == msg_node_id
662 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
663 node_id == msg_node_id
665 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
666 node_id == msg_node_id
668 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
669 node_id == msg_node_id
671 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
672 node_id == msg_node_id
675 if ev_index.is_some() {
676 msg_events.remove(ev_index.unwrap())
678 panic!("Couldn't find any MessageSendEvent to the node!")
683 macro_rules! get_channel_ref {
684 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
686 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
687 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
688 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
694 macro_rules! get_feerate {
695 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
697 let mut per_peer_state_lock;
698 let mut peer_state_lock;
699 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
706 macro_rules! get_opt_anchors {
707 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
709 let mut per_peer_state_lock;
710 let mut peer_state_lock;
711 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
717 /// Returns a channel monitor given a channel id, making some naive assumptions
719 macro_rules! get_monitor {
720 ($node: expr, $channel_id: expr) => {
722 use bitcoin::hashes::Hash;
723 let mut monitor = None;
724 // Assume funding vout is either 0 or 1 blindly
726 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
727 $crate::chain::transaction::OutPoint {
728 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
740 /// Returns any local commitment transactions for the channel.
742 macro_rules! get_local_commitment_txn {
743 ($node: expr, $channel_id: expr) => {
745 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
750 /// Check the error from attempting a payment.
752 macro_rules! unwrap_send_err {
753 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
755 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
756 assert_eq!(fails.len(), 1);
762 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
763 assert_eq!(results.len(), 1);
765 Err($type) => { $check },
774 /// Check whether N channel monitor(s) have been added.
775 pub fn check_added_monitors(node: &Node, count: usize) {
776 let mut added_monitors = node.chain_monitor.added_monitors.lock().unwrap();
777 assert_eq!(added_monitors.len(), count);
778 added_monitors.clear();
781 /// Check whether N channel monitor(s) have been added.
783 /// Don't use this, use the identically-named function instead.
785 macro_rules! check_added_monitors {
786 ($node: expr, $count: expr) => {
787 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
791 pub fn _reload_node<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, default_config: UserConfig, chanman_encoded: &[u8], monitors_encoded: &[&[u8]]) -> ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'b test_utils::TestRouter<'c>, &'c test_utils::TestLogger> {
792 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
793 for encoded in monitors_encoded {
794 let mut monitor_read = &encoded[..];
795 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
796 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
797 assert!(monitor_read.is_empty());
798 monitors_read.push(monitor);
801 let mut node_read = &chanman_encoded[..];
802 let (_, node_deserialized) = {
803 let mut channel_monitors = HashMap::new();
804 for monitor in monitors_read.iter_mut() {
805 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
807 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut node_read, ChannelManagerReadArgs {
809 entropy_source: node.keys_manager,
810 node_signer: node.keys_manager,
811 signer_provider: node.keys_manager,
812 fee_estimator: node.fee_estimator,
814 chain_monitor: node.chain_monitor,
815 tx_broadcaster: node.tx_broadcaster,
820 assert!(node_read.is_empty());
822 for monitor in monitors_read.drain(..) {
823 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
824 ChannelMonitorUpdateStatus::Completed);
825 check_added_monitors!(node, 1);
832 macro_rules! reload_node {
833 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
834 let chanman_encoded = $chanman_encoded;
836 $persister = test_utils::TestPersister::new();
837 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
838 $node.chain_monitor = &$new_chain_monitor;
840 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
841 $node.node = &$new_channelmanager;
843 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
844 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
848 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: u128) -> ([u8; 32], Transaction, OutPoint) {
849 let chan_id = *node.network_chan_count.borrow();
851 let events = node.node.get_and_clear_pending_events();
852 assert_eq!(events.len(), 1);
854 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
855 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
856 assert_eq!(*channel_value_satoshis, expected_chan_value);
857 assert_eq!(user_channel_id, expected_user_chan_id);
859 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
860 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
862 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
863 (*temporary_channel_id, tx, funding_outpoint)
865 _ => panic!("Unexpected event"),
868 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 {
869 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
870 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
872 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
873 check_added_monitors!(node_a, 0);
875 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
876 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
877 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
879 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
880 assert_eq!(added_monitors.len(), 1);
881 assert_eq!(added_monitors[0].0, funding_output);
882 added_monitors.clear();
885 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()));
887 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
888 assert_eq!(added_monitors.len(), 1);
889 assert_eq!(added_monitors[0].0, funding_output);
890 added_monitors.clear();
893 let events_4 = node_a.node.get_and_clear_pending_events();
894 assert_eq!(events_4.len(), 0);
896 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
897 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
898 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
900 // Ensure that funding_transaction_generated is idempotent.
901 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
902 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
903 check_added_monitors!(node_a, 0);
908 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
909 pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, receiver: &'a Node<'b, 'c, 'd>, initiator_config: Option<UserConfig>) -> (bitcoin::Transaction, [u8; 32]) {
910 let initiator_channels = initiator.node.list_usable_channels().len();
911 let receiver_channels = receiver.node.list_usable_channels().len();
913 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
914 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
916 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
917 let events = receiver.node.get_and_clear_pending_events();
918 assert_eq!(events.len(), 1);
920 Event::OpenChannelRequest { temporary_channel_id, .. } => {
921 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
923 _ => panic!("Unexpected event"),
926 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
927 assert_eq!(accept_channel.minimum_depth, 0);
928 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
930 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
931 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
932 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
934 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
935 check_added_monitors!(receiver, 1);
936 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
937 assert_eq!(bs_signed_locked.len(), 2);
938 let as_channel_ready;
939 match &bs_signed_locked[0] {
940 MessageSendEvent::SendFundingSigned { node_id, msg } => {
941 assert_eq!(*node_id, initiator.node.get_our_node_id());
942 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
943 check_added_monitors!(initiator, 1);
945 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
946 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
948 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
950 _ => panic!("Unexpected event"),
952 match &bs_signed_locked[1] {
953 MessageSendEvent::SendChannelReady { node_id, msg } => {
954 assert_eq!(*node_id, initiator.node.get_our_node_id());
955 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
957 _ => panic!("Unexpected event"),
960 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
962 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
963 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
965 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
966 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
968 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
969 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
971 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
972 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
974 (tx, as_channel_ready.channel_id)
977 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) -> Transaction {
978 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
979 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
980 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
981 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
982 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
983 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
984 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
985 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
986 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
988 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
991 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) {
992 confirm_transaction_at(node_conf, tx, conf_height);
993 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
994 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()));
997 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]) {
999 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1000 assert_eq!(events_6.len(), 3);
1001 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1002 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1004 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1005 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1007 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1008 ((match events_6[0] {
1009 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1010 channel_id = msg.channel_id.clone();
1011 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1014 _ => panic!("Unexpected event"),
1015 }, match events_6[announcement_sigs_idx] {
1016 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1017 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1020 _ => panic!("Unexpected event"),
1024 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]) {
1025 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1026 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1027 confirm_transaction_at(node_a, tx, conf_height);
1028 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1029 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1030 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1033 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) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
1034 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1035 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1039 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) {
1040 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1041 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1042 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1044 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1045 assert_eq!(events_7.len(), 1);
1046 let (announcement, bs_update) = match events_7[0] {
1047 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1048 (msg, update_msg.clone().unwrap())
1050 _ => panic!("Unexpected event"),
1053 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1054 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1055 assert_eq!(events_8.len(), 1);
1056 let as_update = match events_8[0] {
1057 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1058 assert!(*announcement == *msg);
1059 let update_msg = update_msg.clone().unwrap();
1060 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1061 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1064 _ => panic!("Unexpected event"),
1067 *node_a.network_chan_count.borrow_mut() += 1;
1069 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1070 ((*announcement).clone(), as_update, bs_update)
1073 pub fn create_announced_chan_between_nodes<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1074 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1077 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) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1078 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1079 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1080 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1083 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) -> (msgs::ChannelReady, Transaction) {
1084 let mut no_announce_cfg = test_default_channel_config();
1085 no_announce_cfg.channel_handshake_config.announced_channel = false;
1086 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1087 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1088 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1089 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1090 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1092 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1093 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1094 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()));
1095 check_added_monitors!(nodes[b], 1);
1097 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1098 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1099 check_added_monitors!(nodes[a], 1);
1101 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1102 confirm_transaction_at(&nodes[a], &tx, conf_height);
1103 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1104 confirm_transaction_at(&nodes[b], &tx, conf_height);
1105 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1106 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1107 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()));
1108 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1109 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1110 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1111 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1112 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1114 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1115 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1117 let mut found_a = false;
1118 for chan in nodes[a].node.list_usable_channels() {
1119 if chan.channel_id == as_channel_ready.channel_id {
1122 assert!(!chan.is_public);
1127 let mut found_b = false;
1128 for chan in nodes[b].node.list_usable_channels() {
1129 if chan.channel_id == as_channel_ready.channel_id {
1132 assert!(!chan.is_public);
1137 (as_channel_ready, tx)
1140 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) {
1142 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1143 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1144 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1146 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1147 // forwarding info for local channels even if its not accepted in the network graph.
1148 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1149 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1153 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1154 for outp in tx.output.iter() {
1155 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1157 let mut total_value_in = 0;
1158 for input in tx.input.iter() {
1159 total_value_in += get_output(&input.previous_output).unwrap().value;
1161 let mut total_value_out = 0;
1162 for output in tx.output.iter() {
1163 total_value_out += output.value;
1165 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1166 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1167 assert!(total_value_out + min_fee <= total_value_in);
1168 tx.verify(get_output).unwrap();
1172 macro_rules! check_spends {
1173 ($tx: expr, $($spends_txn: expr),*) => {
1176 for outp in $spends_txn.output.iter() {
1177 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1180 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1182 if out_point.txid == $spends_txn.txid() {
1183 return $spends_txn.output.get(out_point.vout as usize).cloned()
1188 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1193 macro_rules! get_closing_signed_broadcast {
1194 ($node: expr, $dest_pubkey: expr) => {
1196 let events = $node.get_and_clear_pending_msg_events();
1197 assert!(events.len() == 1 || events.len() == 2);
1198 (match events[events.len() - 1] {
1199 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1200 assert_eq!(msg.contents.flags & 2, 2);
1203 _ => panic!("Unexpected event"),
1204 }, if events.len() == 2 {
1206 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1207 assert_eq!(*node_id, $dest_pubkey);
1210 _ => panic!("Unexpected event"),
1218 macro_rules! check_warn_msg {
1219 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1220 let msg_events = $node.node.get_and_clear_pending_msg_events();
1221 assert_eq!(msg_events.len(), 1);
1222 match msg_events[0] {
1223 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1224 assert_eq!(node_id, $recipient_node_id);
1225 assert_eq!(msg.channel_id, $chan_id);
1228 _ => panic!("Unexpected event"),
1233 /// Check that a channel's closing channel update has been broadcasted, and optionally
1234 /// check whether an error message event has occurred.
1235 pub fn check_closed_broadcast(node: &Node, with_error_msg: bool) -> Option<msgs::ErrorMessage> {
1236 let msg_events = node.node.get_and_clear_pending_msg_events();
1237 assert_eq!(msg_events.len(), if with_error_msg { 2 } else { 1 });
1238 match msg_events[0] {
1239 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1240 assert_eq!(msg.contents.flags & 2, 2);
1242 _ => panic!("Unexpected event"),
1245 match msg_events[1] {
1246 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1247 // TODO: Check node_id
1250 _ => panic!("Unexpected event"),
1255 /// Check that a channel's closing channel update has been broadcasted, and optionally
1256 /// check whether an error message event has occurred.
1258 /// Don't use this, use the identically-named function instead.
1260 macro_rules! check_closed_broadcast {
1261 ($node: expr, $with_error_msg: expr) => {
1262 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, $with_error_msg)
1266 /// Check that a channel's closing channel events has been issued
1267 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1268 let events = node.node.get_and_clear_pending_events();
1269 assert_eq!(events.len(), events_count, "{:?}", events);
1270 let mut issues_discard_funding = false;
1271 for event in events {
1273 Event::ChannelClosed { ref reason, .. } => {
1274 assert_eq!(*reason, expected_reason);
1276 Event::DiscardFunding { .. } => {
1277 issues_discard_funding = true;
1279 _ => panic!("Unexpected event"),
1282 assert_eq!(is_check_discard_funding, issues_discard_funding);
1285 /// Check that a channel's closing channel events has been issued
1287 /// Don't use this, use the identically-named function instead.
1289 macro_rules! check_closed_event {
1290 ($node: expr, $events: expr, $reason: expr) => {
1291 check_closed_event!($node, $events, $reason, false);
1293 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1294 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1298 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) {
1299 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) };
1300 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) };
1303 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1304 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1306 let events_1 = node_b.get_and_clear_pending_msg_events();
1307 assert!(events_1.len() >= 1);
1308 let shutdown_b = match events_1[0] {
1309 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1310 assert_eq!(node_id, &node_a.get_our_node_id());
1313 _ => panic!("Unexpected event"),
1316 let closing_signed_b = if !close_inbound_first {
1317 assert_eq!(events_1.len(), 1);
1320 Some(match events_1[1] {
1321 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1322 assert_eq!(node_id, &node_a.get_our_node_id());
1325 _ => panic!("Unexpected event"),
1329 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1330 let (as_update, bs_update) = if close_inbound_first {
1331 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1332 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1334 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1335 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1336 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1337 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1339 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1340 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1341 assert!(none_a.is_none());
1342 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1343 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1344 (as_update, bs_update)
1346 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1348 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1349 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1351 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1352 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1353 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1355 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1356 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1357 assert!(none_b.is_none());
1358 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1359 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1360 (as_update, bs_update)
1362 assert_eq!(tx_a, tx_b);
1363 check_spends!(tx_a, funding_tx);
1365 (as_update, bs_update, tx_a)
1368 pub struct SendEvent {
1369 pub node_id: PublicKey,
1370 pub msgs: Vec<msgs::UpdateAddHTLC>,
1371 pub commitment_msg: msgs::CommitmentSigned,
1374 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1375 assert!(updates.update_fulfill_htlcs.is_empty());
1376 assert!(updates.update_fail_htlcs.is_empty());
1377 assert!(updates.update_fail_malformed_htlcs.is_empty());
1378 assert!(updates.update_fee.is_none());
1379 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1382 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1384 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1385 _ => panic!("Unexpected event type!"),
1389 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1390 let mut events = node.node.get_and_clear_pending_msg_events();
1391 assert_eq!(events.len(), 1);
1392 SendEvent::from_event(events.pop().unwrap())
1397 /// Don't use this, use the identically-named function instead.
1398 macro_rules! expect_pending_htlcs_forwardable_conditions {
1399 ($node: expr, $expected_failures: expr) => {
1400 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1405 macro_rules! expect_htlc_handling_failed_destinations {
1406 ($events: expr, $expected_failures: expr) => {{
1407 for event in $events {
1409 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1410 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1411 assert!($expected_failures.contains(&failed_next_destination))
1413 _ => panic!("Unexpected destination"),
1419 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1420 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1421 /// `expected_failures` set.
1422 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1424 Event::PendingHTLCsForwardable { .. } => { },
1425 _ => panic!("Unexpected event {:?}", events),
1428 let count = expected_failures.len() + 1;
1429 assert_eq!(events.len(), count);
1431 if expected_failures.len() > 0 {
1432 expect_htlc_handling_failed_destinations!(events, expected_failures)
1437 /// Clears (and ignores) a PendingHTLCsForwardable event
1439 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1441 macro_rules! expect_pending_htlcs_forwardable_ignore {
1443 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1448 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1450 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1451 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1452 ($node: expr, $expected_failures: expr) => {
1453 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1458 /// Handles a PendingHTLCsForwardable event
1459 macro_rules! expect_pending_htlcs_forwardable {
1461 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1462 $node.node.process_pending_htlc_forwards();
1464 // Ensure process_pending_htlc_forwards is idempotent.
1465 $node.node.process_pending_htlc_forwards();
1470 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1471 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1472 ($node: expr, $expected_failures: expr) => {{
1473 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1474 $node.node.process_pending_htlc_forwards();
1476 // Ensure process_pending_htlc_forwards is idempotent.
1477 $node.node.process_pending_htlc_forwards();
1482 macro_rules! expect_pending_htlcs_forwardable_from_events {
1483 ($node: expr, $events: expr, $ignore: expr) => {{
1484 assert_eq!($events.len(), 1);
1486 Event::PendingHTLCsForwardable { .. } => { },
1487 _ => panic!("Unexpected event"),
1490 $node.node.process_pending_htlc_forwards();
1492 // Ensure process_pending_htlc_forwards is idempotent.
1493 $node.node.process_pending_htlc_forwards();
1499 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1500 /// commitment update.
1501 macro_rules! commitment_signed_dance {
1502 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1503 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1505 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1506 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1508 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1510 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1511 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1512 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1513 check_added_monitors(&$node_a, 1);
1514 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1515 assert!(extra_msg_option.is_none());
1519 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1521 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1522 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1523 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 1);
1527 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1528 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1530 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1531 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1536 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1537 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1538 check_added_monitors!(node_b, 0);
1539 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1540 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1541 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1542 check_added_monitors!(node_b, 1);
1543 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1544 let (bs_revoke_and_ack, extra_msg_option) = {
1545 let mut events = node_b.node.get_and_clear_pending_msg_events();
1546 assert!(events.len() <= 2);
1547 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1548 (match node_a_event {
1549 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1550 assert_eq!(*node_id, node_a.node.get_our_node_id());
1553 _ => panic!("Unexpected event"),
1554 }, events.get(0).map(|e| e.clone()))
1556 check_added_monitors!(node_b, 1);
1558 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1559 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1561 (extra_msg_option, bs_revoke_and_ack)
1564 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1565 check_added_monitors!(node_a, 0);
1566 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1567 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1568 check_added_monitors!(node_a, 1);
1570 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1572 if skip_last_step { return; }
1575 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1576 vec![crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1577 check_added_monitors!(node_a, 1);
1579 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1580 let mut number_of_msg_events = 0;
1581 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1582 let peer_state = peer_state_mutex.lock().unwrap();
1583 let cp_pending_msg_events = &peer_state.pending_msg_events;
1584 number_of_msg_events += cp_pending_msg_events.len();
1585 if cp_pending_msg_events.len() == 1 {
1586 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1587 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1588 } else { panic!("Unexpected event"); }
1591 // Expecting the failure backwards event to the previous hop (not `node_b`)
1592 assert_eq!(number_of_msg_events, 1);
1594 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1598 /// Get a payment preimage and hash.
1599 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1600 let mut payment_count = recipient.network_payment_count.borrow_mut();
1601 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1602 *payment_count += 1;
1603 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1604 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1605 (payment_preimage, payment_hash, payment_secret)
1608 /// Get a payment preimage and hash.
1610 /// Don't use this, use the identically-named function instead.
1612 macro_rules! get_payment_preimage_hash {
1613 ($dest_node: expr) => {
1614 get_payment_preimage_hash!($dest_node, None)
1616 ($dest_node: expr, $min_value_msat: expr) => {
1617 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1619 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1620 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1624 /// Gets a route from the given sender to the node described in `payment_params`.
1625 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64, final_cltv_expiry_delta: u32) -> Result<Route, msgs::LightningError> {
1626 let scorer = TestScorer::new();
1627 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1628 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1630 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1631 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1632 recv_value, final_cltv_expiry_delta, send_node.logger, &scorer, &random_seed_bytes
1636 /// Gets a route from the given sender to the node described in `payment_params`.
1638 /// Don't use this, use the identically-named function instead.
1640 macro_rules! get_route {
1641 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {
1642 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv)
1648 macro_rules! get_route_and_payment_hash {
1649 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1650 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1651 .with_features($recv_node.node.invoice_features());
1652 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1654 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1655 let (payment_preimage, payment_hash, payment_secret) =
1656 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1657 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv);
1658 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1663 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1664 macro_rules! expect_payment_claimable {
1665 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1666 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1668 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1669 let events = $node.node.get_and_clear_pending_events();
1670 assert_eq!(events.len(), 1);
1672 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1673 assert_eq!($expected_payment_hash, *payment_hash);
1674 assert_eq!($expected_recv_value, amount_msat);
1675 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1677 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1678 assert_eq!(&$expected_payment_preimage, payment_preimage);
1679 assert_eq!($expected_payment_secret, *payment_secret);
1684 _ => panic!("Unexpected event"),
1690 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1691 macro_rules! expect_payment_claimed {
1692 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1693 let events = $node.node.get_and_clear_pending_events();
1694 assert_eq!(events.len(), 1);
1696 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1697 assert_eq!($expected_payment_hash, *payment_hash);
1698 assert_eq!($expected_recv_value, amount_msat);
1700 _ => panic!("Unexpected event"),
1707 macro_rules! expect_payment_sent_without_paths {
1708 ($node: expr, $expected_payment_preimage: expr) => {
1709 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1711 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1712 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1717 macro_rules! expect_payment_sent {
1718 ($node: expr, $expected_payment_preimage: expr) => {
1719 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1721 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1722 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1724 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1725 use bitcoin::hashes::Hash as _;
1726 let events = $node.node.get_and_clear_pending_events();
1727 let expected_payment_hash = $crate::ln::PaymentHash(
1728 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1730 assert!(events.len() > 1);
1732 assert_eq!(events.len(), 1);
1734 let expected_payment_id = match events[0] {
1735 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1736 assert_eq!($expected_payment_preimage, *payment_preimage);
1737 assert_eq!(expected_payment_hash, *payment_hash);
1738 assert!(fee_paid_msat.is_some());
1739 if $expected_fee_msat_opt.is_some() {
1740 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1744 _ => panic!("Unexpected event"),
1747 for i in 1..events.len() {
1749 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1750 assert_eq!(payment_id, expected_payment_id);
1751 assert_eq!(payment_hash, Some(expected_payment_hash));
1753 _ => panic!("Unexpected event"),
1762 macro_rules! expect_payment_path_successful {
1764 let events = $node.node.get_and_clear_pending_events();
1765 assert_eq!(events.len(), 1);
1767 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1768 _ => panic!("Unexpected event"),
1773 macro_rules! expect_payment_forwarded {
1774 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1775 let events = $node.node.get_and_clear_pending_events();
1776 assert_eq!(events.len(), 1);
1778 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1779 assert_eq!(fee_earned_msat, $expected_fee);
1780 if fee_earned_msat.is_some() {
1781 // Is the event prev_channel_id in one of the channels between the two nodes?
1782 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()));
1784 // We check for force closures since a force closed channel is removed from the
1785 // node's channel list
1786 if !$downstream_force_closed {
1787 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()));
1789 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1791 _ => panic!("Unexpected event"),
1796 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1797 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1798 let events = node.node.get_and_clear_pending_events();
1799 assert_eq!(events.len(), 1);
1801 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1802 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1804 _ => panic!("Unexpected event"),
1809 pub struct PaymentFailedConditions<'a> {
1810 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1811 pub(crate) expected_blamed_scid: Option<u64>,
1812 pub(crate) expected_blamed_chan_closed: Option<bool>,
1813 pub(crate) expected_mpp_parts_remain: bool,
1816 impl<'a> PaymentFailedConditions<'a> {
1817 pub fn new() -> Self {
1819 expected_htlc_error_data: None,
1820 expected_blamed_scid: None,
1821 expected_blamed_chan_closed: None,
1822 expected_mpp_parts_remain: false,
1825 pub fn mpp_parts_remain(mut self) -> Self {
1826 self.expected_mpp_parts_remain = true;
1829 pub fn blamed_scid(mut self, scid: u64) -> Self {
1830 self.expected_blamed_scid = Some(scid);
1833 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1834 self.expected_blamed_chan_closed = Some(closed);
1837 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1838 self.expected_htlc_error_data = Some((code, data));
1844 macro_rules! expect_payment_failed_with_update {
1845 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1846 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1847 &$node, $expected_payment_hash, $payment_failed_permanently,
1848 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1849 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1854 macro_rules! expect_payment_failed {
1855 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1856 #[allow(unused_mut)]
1857 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1859 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1861 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1865 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1866 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1867 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1869 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
1870 let expected_payment_id = match &payment_failed_events[0] {
1871 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
1875 error_data, .. } => {
1876 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
1877 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1880 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1881 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1882 if let Some((code, data)) = conditions.expected_htlc_error_data {
1883 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1884 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1888 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1889 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
1891 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
1892 if let Some(scid) = conditions.expected_blamed_scid {
1893 assert_eq!(msg.contents.short_channel_id, scid);
1895 const CHAN_DISABLED_FLAG: u8 = 2;
1896 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1898 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
1899 if let Some(scid) = conditions.expected_blamed_scid {
1900 assert_eq!(*short_channel_id, scid);
1902 assert!(is_permanent);
1904 _ => panic!("Unexpected update type"),
1906 } else { panic!("Expected network update"); }
1911 _ => panic!("Unexpected event"),
1913 if !conditions.expected_mpp_parts_remain {
1914 match &payment_failed_events[1] {
1915 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1916 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1917 assert_eq!(*payment_id, expected_payment_id);
1919 _ => panic!("Unexpected second event"),
1924 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1925 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1926 conditions: PaymentFailedConditions<'e>
1928 let events = node.node.get_and_clear_pending_events();
1929 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
1932 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 {
1933 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1934 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1935 check_added_monitors!(origin_node, expected_paths.len());
1936 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1940 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_claimable_expected: bool, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) {
1941 let mut payment_event = SendEvent::from_event(ev);
1942 let mut prev_node = origin_node;
1944 for (idx, &node) in expected_path.iter().enumerate() {
1945 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1947 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1948 check_added_monitors!(node, 0);
1949 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1951 expect_pending_htlcs_forwardable!(node);
1953 if idx == expected_path.len() - 1 && clear_recipient_events {
1954 let events_2 = node.node.get_and_clear_pending_events();
1955 if payment_claimable_expected {
1956 assert_eq!(events_2.len(), 1);
1958 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1959 assert_eq!(our_payment_hash, *payment_hash);
1960 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1962 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1963 assert_eq!(expected_preimage, *payment_preimage);
1964 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1966 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1967 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1968 assert!(our_payment_secret.is_none());
1971 assert_eq!(amount_msat, recv_value);
1972 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1973 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1975 _ => panic!("Unexpected event"),
1978 assert!(events_2.is_empty());
1980 } else if idx != expected_path.len() - 1 {
1981 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1982 assert_eq!(events_2.len(), 1);
1983 check_added_monitors!(node, 1);
1984 payment_event = SendEvent::from_event(events_2.remove(0));
1985 assert_eq!(payment_event.msgs.len(), 1);
1992 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_claimable_expected: bool, expected_preimage: Option<PaymentPreimage>) {
1993 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1996 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) {
1997 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1998 assert_eq!(events.len(), expected_route.len());
1999 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2000 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2001 // Once we've gotten through all the HTLCs, the last one should result in a
2002 // PaymentClaimable (but each previous one should not!), .
2003 let expect_payment = path_idx == expected_route.len() - 1;
2004 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2008 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) {
2009 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2010 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2011 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2014 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 {
2015 for path in expected_paths.iter() {
2016 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2018 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2020 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2021 assert_eq!(claim_event.len(), 1);
2022 match claim_event[0] {
2023 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2024 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2025 assert_eq!(preimage, our_payment_preimage),
2026 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2027 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2031 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2033 let mut expected_total_fee_msat = 0;
2035 macro_rules! msgs_from_ev {
2038 &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 } } => {
2039 assert!(update_add_htlcs.is_empty());
2040 assert_eq!(update_fulfill_htlcs.len(), 1);
2041 assert!(update_fail_htlcs.is_empty());
2042 assert!(update_fail_malformed_htlcs.is_empty());
2043 assert!(update_fee.is_none());
2044 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2046 _ => panic!("Unexpected event"),
2050 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2051 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2052 assert_eq!(events.len(), expected_paths.len());
2054 if events.len() == 1 {
2055 per_path_msgs.push(msgs_from_ev!(&events[0]));
2057 for expected_path in expected_paths.iter() {
2058 // For MPP payments, we always want the message to the first node in the path.
2059 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2060 per_path_msgs.push(msgs_from_ev!(&ev));
2064 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2065 let mut next_msgs = Some(path_msgs);
2066 let mut expected_next_node = next_hop;
2068 macro_rules! last_update_fulfill_dance {
2069 ($node: expr, $prev_node: expr) => {
2071 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2072 check_added_monitors!($node, 0);
2073 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2074 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2078 macro_rules! mid_update_fulfill_dance {
2079 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2081 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2083 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2084 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2085 .unwrap().lock().unwrap();
2086 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2087 if let Some(prev_config) = channel.prev_config() {
2088 prev_config.forwarding_fee_base_msat
2090 channel.config().forwarding_fee_base_msat
2093 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2094 expected_total_fee_msat += fee as u64;
2095 check_added_monitors!($node, 1);
2096 let new_next_msgs = if $new_msgs {
2097 let events = $node.node.get_and_clear_pending_msg_events();
2098 assert_eq!(events.len(), 1);
2099 let (res, nexthop) = msgs_from_ev!(&events[0]);
2100 expected_next_node = nexthop;
2103 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2106 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2107 next_msgs = new_next_msgs;
2112 let mut prev_node = expected_route.last().unwrap();
2113 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2114 assert_eq!(expected_next_node, node.node.get_our_node_id());
2115 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2116 if next_msgs.is_some() {
2117 // Since we are traversing in reverse, next_node is actually the previous node
2118 let next_node: &Node;
2119 if idx == expected_route.len() - 1 {
2120 next_node = origin_node;
2122 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2124 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2126 assert!(!update_next_msgs);
2127 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2129 if !skip_last && idx == expected_route.len() - 1 {
2130 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2137 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2141 // Ensure that claim_funds is idempotent.
2142 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2143 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2144 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2146 expected_total_fee_msat
2148 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) {
2149 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2151 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2155 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2156 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2159 pub const TEST_FINAL_CLTV: u32 = 70;
2161 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) {
2162 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2163 .with_features(expected_route.last().unwrap().node.invoice_features());
2164 let route = get_route(origin_node, &payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2165 assert_eq!(route.paths.len(), 1);
2166 assert_eq!(route.paths[0].len(), expected_route.len());
2167 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2168 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2171 let res = send_along_route(origin_node, route, expected_route, recv_value);
2172 (res.0, res.1, res.2)
2175 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2176 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2177 .with_features(expected_route.last().unwrap().node.invoice_features());
2178 let network_graph = origin_node.network_graph.read_only();
2179 let scorer = test_utils::TestScorer::new();
2180 let seed = [0u8; 32];
2181 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2182 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2183 let route = router::get_route(
2184 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2185 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2186 assert_eq!(route.paths.len(), 1);
2187 assert_eq!(route.paths[0].len(), expected_route.len());
2188 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2189 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2192 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2193 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
2194 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2197 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2198 let res = route_payment(&origin, expected_route, recv_value);
2199 claim_payment(&origin, expected_route, res.0);
2203 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) {
2204 for path in expected_paths.iter() {
2205 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2207 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2208 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2209 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2211 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2214 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) {
2215 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2216 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2218 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2219 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2220 assert_eq!(events.len(), expected_paths.len());
2221 for ev in events.iter() {
2222 let (update_fail, commitment_signed, node_id) = match ev {
2223 &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 } } => {
2224 assert!(update_add_htlcs.is_empty());
2225 assert!(update_fulfill_htlcs.is_empty());
2226 assert_eq!(update_fail_htlcs.len(), 1);
2227 assert!(update_fail_malformed_htlcs.is_empty());
2228 assert!(update_fee.is_none());
2229 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2231 _ => panic!("Unexpected event"),
2233 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2235 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2236 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()));
2238 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2239 let mut next_msgs = Some(path_msgs);
2240 let mut expected_next_node = next_hop;
2241 let mut prev_node = expected_route.last().unwrap();
2243 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2244 assert_eq!(expected_next_node, node.node.get_our_node_id());
2245 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2246 if next_msgs.is_some() {
2247 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2248 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2249 if !update_next_node {
2250 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 }]);
2253 let events = node.node.get_and_clear_pending_msg_events();
2254 if update_next_node {
2255 assert_eq!(events.len(), 1);
2257 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 } } => {
2258 assert!(update_add_htlcs.is_empty());
2259 assert!(update_fulfill_htlcs.is_empty());
2260 assert_eq!(update_fail_htlcs.len(), 1);
2261 assert!(update_fail_malformed_htlcs.is_empty());
2262 assert!(update_fee.is_none());
2263 expected_next_node = node_id.clone();
2264 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2266 _ => panic!("Unexpected event"),
2269 assert!(events.is_empty());
2271 if !skip_last && idx == expected_route.len() - 1 {
2272 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2279 let prev_node = expected_route.first().unwrap();
2280 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2281 check_added_monitors!(origin_node, 0);
2282 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2283 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2284 let events = origin_node.node.get_and_clear_pending_events();
2285 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2287 let expected_payment_id = match events[0] {
2288 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2289 assert_eq!(payment_hash, our_payment_hash);
2290 assert!(payment_failed_permanently);
2291 for (idx, hop) in expected_route.iter().enumerate() {
2292 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2296 _ => panic!("Unexpected event"),
2298 if i == expected_paths.len() - 1 {
2300 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2301 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2302 assert_eq!(*payment_id, expected_payment_id);
2304 _ => panic!("Unexpected second event"),
2310 // Ensure that fail_htlc_backwards is idempotent.
2311 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2312 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2313 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2314 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2317 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2318 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2321 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2322 let mut chan_mon_cfgs = Vec::new();
2323 for i in 0..node_count {
2324 let tx_broadcaster = test_utils::TestBroadcaster {
2325 txn_broadcasted: Mutex::new(Vec::new()),
2326 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2328 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2329 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2330 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2331 let persister = test_utils::TestPersister::new();
2332 let seed = [i as u8; 32];
2333 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2334 let scorer = Mutex::new(test_utils::TestScorer::new());
2336 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2342 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2343 let mut nodes = Vec::new();
2345 for i in 0..node_count {
2346 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);
2347 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2348 let seed = [i as u8; 32];
2349 nodes.push(NodeCfg {
2350 chain_source: &chanmon_cfgs[i].chain_source,
2351 logger: &chanmon_cfgs[i].logger,
2352 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2353 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2354 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2356 keys_manager: &chanmon_cfgs[i].keys_manager,
2359 override_init_features: Rc::new(RefCell::new(None)),
2366 pub fn test_default_channel_config() -> UserConfig {
2367 let mut default_config = UserConfig::default();
2368 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2369 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2370 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2371 default_config.channel_handshake_config.announced_channel = true;
2372 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2373 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2374 // It now defaults to 1, so we simply set it to the expected value here.
2375 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2376 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2377 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2378 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2382 pub fn create_node_chanmgrs<'a, 'b>(node_count: usize, cfgs: &'a Vec<NodeCfg<'b>>, node_config: &[Option<UserConfig>]) -> Vec<ChannelManager<&'a TestChainMonitor<'b>, &'b test_utils::TestBroadcaster, &'a test_utils::TestKeysInterface, &'a test_utils::TestKeysInterface, &'a test_utils::TestKeysInterface, &'b test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'b>, &'b test_utils::TestLogger>> {
2383 let mut chanmgrs = Vec::new();
2384 for i in 0..node_count {
2385 let network = Network::Testnet;
2386 let params = ChainParameters {
2388 best_block: BestBlock::from_network(network),
2390 let node = ChannelManager::new(cfgs[i].fee_estimator, &cfgs[i].chain_monitor, cfgs[i].tx_broadcaster, &cfgs[i].router, cfgs[i].logger, cfgs[i].keys_manager,
2391 cfgs[i].keys_manager, cfgs[i].keys_manager, if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2392 chanmgrs.push(node);
2398 pub fn create_network<'a, 'b: 'a, 'c: 'b>(node_count: usize, cfgs: &'b Vec<NodeCfg<'c>>, chan_mgrs: &'a Vec<ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'c test_utils::TestRouter, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
2399 let mut nodes = Vec::new();
2400 let chan_count = Rc::new(RefCell::new(0));
2401 let payment_count = Rc::new(RefCell::new(0));
2402 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2404 for i in 0..node_count {
2405 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2407 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2408 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2409 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2410 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2411 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2412 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2413 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2414 connect_style: Rc::clone(&connect_style),
2415 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2419 for i in 0..node_count {
2420 for j in (i+1)..node_count {
2421 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()), remote_network_address: None }, true).unwrap();
2422 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()), remote_network_address: None }, false).unwrap();
2429 // Note that the following only works for CLTV values up to 128
2430 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2432 #[derive(PartialEq)]
2433 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2434 /// Tests that the given node has broadcast transactions for the given Channel
2436 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2437 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2438 /// broadcast and the revoked outputs were claimed.
2440 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2441 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2443 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2445 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> {
2446 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2447 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2449 let mut res = Vec::with_capacity(2);
2450 node_txn.retain(|tx| {
2451 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2452 check_spends!(tx, chan.3);
2453 if commitment_tx.is_none() {
2454 res.push(tx.clone());
2459 if let Some(explicit_tx) = commitment_tx {
2460 res.push(explicit_tx.clone());
2463 assert_eq!(res.len(), 1);
2465 if has_htlc_tx != HTLCType::NONE {
2466 node_txn.retain(|tx| {
2467 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2468 check_spends!(tx, res[0]);
2469 if has_htlc_tx == HTLCType::TIMEOUT {
2470 assert!(tx.lock_time.0 != 0);
2472 assert!(tx.lock_time.0 == 0);
2474 res.push(tx.clone());
2478 assert!(res.len() == 2 || res.len() == 3);
2480 assert_eq!(res[1], res[2]);
2484 assert!(node_txn.is_empty());
2488 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2489 /// HTLC transaction.
2490 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2491 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2492 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2493 // for revoked htlc outputs
2494 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2495 node_txn.retain(|tx| {
2496 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2497 check_spends!(tx, revoked_tx);
2501 node_txn.retain(|tx| {
2502 check_spends!(tx, commitment_revoked_tx);
2505 assert!(node_txn.is_empty());
2508 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2509 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2511 assert!(node_txn.len() >= 1);
2512 assert_eq!(node_txn[0].input.len(), 1);
2513 let mut found_prev = false;
2515 for tx in prev_txn {
2516 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2517 check_spends!(node_txn[0], tx);
2518 let mut iter = node_txn[0].input[0].witness.iter();
2519 iter.next().expect("expected 3 witness items");
2520 iter.next().expect("expected 3 witness items");
2521 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2522 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2528 assert!(found_prev);
2530 let mut res = Vec::new();
2531 mem::swap(&mut *node_txn, &mut res);
2535 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) {
2536 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2537 assert_eq!(events_1.len(), 2);
2538 let as_update = match events_1[0] {
2539 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2542 _ => panic!("Unexpected event"),
2545 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2546 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2547 assert_eq!(msg.data, expected_error);
2548 if needs_err_handle {
2549 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2552 _ => panic!("Unexpected event"),
2555 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2556 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2557 let bs_update = match events_2[0] {
2558 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2561 _ => panic!("Unexpected event"),
2563 if !needs_err_handle {
2565 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2566 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2567 assert_eq!(msg.data, expected_error);
2569 _ => panic!("Unexpected event"),
2574 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2575 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2579 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2580 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2584 macro_rules! get_channel_value_stat {
2585 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2586 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2587 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2588 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2589 chan.get_value_stat()
2593 macro_rules! get_chan_reestablish_msgs {
2594 ($src_node: expr, $dst_node: expr) => {
2596 let mut announcements = $crate::prelude::HashSet::new();
2597 let mut res = Vec::with_capacity(1);
2598 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2599 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2600 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2601 res.push(msg.clone());
2602 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2603 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2604 announcements.insert(msg.contents.short_channel_id);
2606 panic!("Unexpected event")
2609 for chan in $src_node.node.list_channels() {
2610 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2611 if let Some(scid) = chan.short_channel_id {
2612 assert!(announcements.remove(&scid));
2616 assert!(announcements.is_empty());
2622 macro_rules! handle_chan_reestablish_msgs {
2623 ($src_node: expr, $dst_node: expr) => {
2625 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2627 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2629 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2635 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2637 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2640 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2641 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2642 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2644 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2645 had_channel_update = true;
2648 let mut revoke_and_ack = None;
2649 let mut commitment_update = None;
2650 let order = if let Some(ev) = msg_events.get(idx) {
2652 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2653 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2654 revoke_and_ack = Some(msg.clone());
2656 RAACommitmentOrder::RevokeAndACKFirst
2658 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2659 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2660 commitment_update = Some(updates.clone());
2662 RAACommitmentOrder::CommitmentFirst
2664 _ => RAACommitmentOrder::CommitmentFirst,
2667 RAACommitmentOrder::CommitmentFirst
2670 if let Some(ev) = msg_events.get(idx) {
2672 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2673 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2674 assert!(revoke_and_ack.is_none());
2675 revoke_and_ack = Some(msg.clone());
2678 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2679 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2680 assert!(commitment_update.is_none());
2681 commitment_update = Some(updates.clone());
2688 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2689 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2691 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2692 assert!(!had_channel_update);
2695 assert_eq!(msg_events.len(), idx);
2697 (channel_ready, revoke_and_ack, commitment_update, order)
2702 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2703 /// for claims/fails they are separated out.
2704 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)) {
2705 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: node_b.node.init_features(), remote_network_address: None }, true).unwrap();
2706 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2707 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: node_a.node.init_features(), remote_network_address: None }, false).unwrap();
2708 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2710 if send_channel_ready.0 {
2711 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2713 for reestablish in reestablish_1.iter() {
2714 assert_eq!(reestablish.next_remote_commitment_number, 0);
2717 if send_channel_ready.1 {
2718 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2720 for reestablish in reestablish_2.iter() {
2721 assert_eq!(reestablish.next_remote_commitment_number, 0);
2724 if send_channel_ready.0 || send_channel_ready.1 {
2725 // If we expect any channel_ready's, both sides better have set
2726 // next_holder_commitment_number to 1
2727 for reestablish in reestablish_1.iter() {
2728 assert_eq!(reestablish.next_local_commitment_number, 1);
2730 for reestablish in reestablish_2.iter() {
2731 assert_eq!(reestablish.next_local_commitment_number, 1);
2735 let mut resp_1 = Vec::new();
2736 for msg in reestablish_1 {
2737 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2738 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2740 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2741 check_added_monitors!(node_b, 1);
2743 check_added_monitors!(node_b, 0);
2746 let mut resp_2 = Vec::new();
2747 for msg in reestablish_2 {
2748 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2749 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2751 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2752 check_added_monitors!(node_a, 1);
2754 check_added_monitors!(node_a, 0);
2757 // We don't yet support both needing updates, as that would require a different commitment dance:
2758 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2759 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2760 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2761 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2763 for chan_msgs in resp_1.drain(..) {
2764 if send_channel_ready.0 {
2765 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2766 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2767 if !announcement_event.is_empty() {
2768 assert_eq!(announcement_event.len(), 1);
2769 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2770 //TODO: Test announcement_sigs re-sending
2771 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2774 assert!(chan_msgs.0.is_none());
2777 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2778 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2779 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2780 check_added_monitors!(node_a, 1);
2782 assert!(chan_msgs.1.is_none());
2784 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 {
2785 let commitment_update = chan_msgs.2.unwrap();
2786 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2787 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2789 assert!(commitment_update.update_add_htlcs.is_empty());
2791 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2792 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2793 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2794 for update_add in commitment_update.update_add_htlcs {
2795 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2797 for update_fulfill in commitment_update.update_fulfill_htlcs {
2798 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2800 for update_fail in commitment_update.update_fail_htlcs {
2801 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2804 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2805 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2807 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2808 check_added_monitors!(node_a, 1);
2809 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2810 // No commitment_signed so get_event_msg's assert(len == 1) passes
2811 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2812 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2813 check_added_monitors!(node_b, 1);
2816 assert!(chan_msgs.2.is_none());
2820 for chan_msgs in resp_2.drain(..) {
2821 if send_channel_ready.1 {
2822 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2823 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2824 if !announcement_event.is_empty() {
2825 assert_eq!(announcement_event.len(), 1);
2826 match announcement_event[0] {
2827 MessageSendEvent::SendChannelUpdate { .. } => {},
2828 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2829 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2833 assert!(chan_msgs.0.is_none());
2836 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2837 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2838 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2839 check_added_monitors!(node_b, 1);
2841 assert!(chan_msgs.1.is_none());
2843 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 {
2844 let commitment_update = chan_msgs.2.unwrap();
2845 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2846 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2848 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2849 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2850 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2851 for update_add in commitment_update.update_add_htlcs {
2852 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2854 for update_fulfill in commitment_update.update_fulfill_htlcs {
2855 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2857 for update_fail in commitment_update.update_fail_htlcs {
2858 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2861 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2862 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2864 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2865 check_added_monitors!(node_b, 1);
2866 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2867 // No commitment_signed so get_event_msg's assert(len == 1) passes
2868 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2869 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2870 check_added_monitors!(node_a, 1);
2873 assert!(chan_msgs.2.is_none());