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::enforcing_trait_impls::EnforcingSigner;
24 use crate::util::scid_utils;
25 use crate::util::test_utils;
26 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
27 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose};
28 use crate::util::errors::APIError;
29 use crate::util::config::UserConfig;
30 use crate::util::ser::{ReadableArgs, Writeable};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::constants::genesis_block;
34 use bitcoin::blockdata::transaction::{Transaction, TxOut};
35 use bitcoin::network::constants::Network;
37 use bitcoin::hash_types::BlockHash;
38 use bitcoin::hashes::sha256::Hash as Sha256;
39 use bitcoin::hashes::Hash as _;
41 use bitcoin::secp256k1::PublicKey;
44 use crate::prelude::*;
45 use core::cell::RefCell;
47 use crate::sync::{Arc, Mutex, LockTestExt};
49 use core::iter::repeat;
50 use bitcoin::{PackedLockTime, TxMerkleNode};
52 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
54 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
55 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
57 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
58 /// output is the 1st output in the transaction.
59 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
60 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
61 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
64 /// Mine a single block containing the given transaction
65 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
66 let height = node.best_block_info().1 + 1;
67 confirm_transaction_at(node, tx, height);
69 /// Mine a single block containing the given transactions
70 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
71 let height = node.best_block_info().1 + 1;
72 confirm_transactions_at(node, txn, height);
74 /// Mine the given transaction at the given height, mining blocks as required to build to that
77 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
78 /// output is the 1st output in the transaction.
79 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
80 let first_connect_height = node.best_block_info().1 + 1;
81 assert!(first_connect_height <= conf_height);
82 if conf_height > first_connect_height {
83 connect_blocks(node, conf_height - first_connect_height);
85 let mut block = Block {
86 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
89 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
90 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
93 block.txdata.push((*tx).clone());
95 connect_block(node, &block);
96 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
98 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
99 confirm_transactions_at(node, &[tx], conf_height)
102 /// The possible ways we may notify a ChannelManager of a new block
103 #[derive(Clone, Copy, Debug, PartialEq)]
104 pub enum ConnectStyle {
105 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
106 /// the header and height information.
108 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
109 /// make a single `best_block_updated` call.
110 BestBlockFirstSkippingBlocks,
111 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
112 /// `transaction_unconfirmed` is called.
113 BestBlockFirstReorgsOnlyTip,
114 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
115 /// the header and height information.
117 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
118 /// make a single `best_block_updated` call.
119 TransactionsFirstSkippingBlocks,
120 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
121 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
122 /// times to ensure it's idempotent.
123 TransactionsDuplicativelyFirstSkippingBlocks,
124 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
125 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
126 /// times to ensure it's idempotent.
127 HighlyRedundantTransactionsFirstSkippingBlocks,
128 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
129 /// `transaction_unconfirmed` is called.
130 TransactionsFirstReorgsOnlyTip,
131 /// Provides the full block via the `chain::Listen` interface. In the current code this is
132 /// equivalent to `TransactionsFirst` with some additional assertions.
137 fn random_style() -> ConnectStyle {
138 #[cfg(feature = "std")] {
139 use core::hash::{BuildHasher, Hasher};
140 // Get a random value using the only std API to do so - the DefaultHasher
141 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
142 let res = match rand_val % 9 {
143 0 => ConnectStyle::BestBlockFirst,
144 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
145 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
146 3 => ConnectStyle::TransactionsFirst,
147 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
148 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
149 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
150 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
151 8 => ConnectStyle::FullBlockViaListen,
154 eprintln!("Using Block Connection Style: {:?}", res);
157 #[cfg(not(feature = "std"))] {
158 ConnectStyle::FullBlockViaListen
163 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
164 let skip_intermediaries = match *node.connect_style.borrow() {
165 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
166 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
167 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
171 let height = node.best_block_info().1 + 1;
172 let mut block = Block {
173 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
178 let prev_blockhash = block.header.block_hash();
179 do_connect_block(node, block, skip_intermediaries);
181 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
185 let hash = block.header.block_hash();
186 do_connect_block(node, block, false);
190 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
191 do_connect_block(node, block.clone(), false);
194 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
195 // Ensure `get_claimable_balances`' self-tests never panic
196 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
197 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
201 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
202 call_claimable_balances(node);
203 let height = node.best_block_info().1 + 1;
204 #[cfg(feature = "std")] {
205 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
207 if !skip_intermediaries {
208 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
209 match *node.connect_style.borrow() {
210 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
211 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
212 call_claimable_balances(node);
213 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
214 node.node.best_block_updated(&block.header, height);
215 node.node.transactions_confirmed(&block.header, &txdata, height);
217 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
218 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
219 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
220 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
221 let mut connections = Vec::new();
222 for (block, height) in node.blocks.lock().unwrap().iter() {
223 if !block.txdata.is_empty() {
224 // Reconnect all transactions we've ever seen to ensure transaction connection
225 // is *really* idempotent. This is a somewhat likely deployment for some
226 // esplora implementations of chain sync which try to reduce state and
227 // complexity as much as possible.
229 // Sadly we have to clone the block here to maintain lockorder. In the
230 // future we should consider Arc'ing the blocks to avoid this.
231 connections.push((block.clone(), *height));
234 for (old_block, height) in connections {
235 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
236 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
239 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
240 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
241 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
243 call_claimable_balances(node);
244 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
245 node.node.transactions_confirmed(&block.header, &txdata, height);
246 node.node.best_block_updated(&block.header, height);
248 ConnectStyle::FullBlockViaListen => {
249 node.chain_monitor.chain_monitor.block_connected(&block, height);
250 node.node.block_connected(&block, height);
254 call_claimable_balances(node);
255 node.node.test_process_background_events();
256 node.blocks.lock().unwrap().push((block, height));
259 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
260 call_claimable_balances(node);
261 #[cfg(feature = "std")] {
262 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
265 let orig = node.blocks.lock().unwrap().pop().unwrap();
266 assert!(orig.1 > 0); // Cannot disconnect genesis
267 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
269 match *node.connect_style.borrow() {
270 ConnectStyle::FullBlockViaListen => {
271 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
272 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
274 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
275 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
277 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
278 node.node.best_block_updated(&prev.0.header, prev.1);
281 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
282 for tx in orig.0.txdata {
283 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
284 node.node.transaction_unconfirmed(&tx.txid());
288 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
289 node.node.best_block_updated(&prev.0.header, prev.1);
292 call_claimable_balances(node);
296 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
297 let count = node.blocks.lock().unwrap().len() as u32 - 1;
298 disconnect_blocks(node, count);
301 pub struct TestChanMonCfg {
302 pub tx_broadcaster: test_utils::TestBroadcaster,
303 pub fee_estimator: test_utils::TestFeeEstimator,
304 pub chain_source: test_utils::TestChainSource,
305 pub persister: test_utils::TestPersister,
306 pub logger: test_utils::TestLogger,
307 pub keys_manager: test_utils::TestKeysInterface,
308 pub scorer: Mutex<test_utils::TestScorer>,
311 pub struct NodeCfg<'a> {
312 pub chain_source: &'a test_utils::TestChainSource,
313 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
314 pub fee_estimator: &'a test_utils::TestFeeEstimator,
315 pub router: test_utils::TestRouter<'a>,
316 pub chain_monitor: test_utils::TestChainMonitor<'a>,
317 pub keys_manager: &'a test_utils::TestKeysInterface,
318 pub logger: &'a test_utils::TestLogger,
319 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
320 pub node_seed: [u8; 32],
321 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
324 pub struct Node<'a, 'b: 'a, 'c: 'b> {
325 pub chain_source: &'c test_utils::TestChainSource,
326 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
327 pub fee_estimator: &'c test_utils::TestFeeEstimator,
328 pub router: &'b test_utils::TestRouter<'c>,
329 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
330 pub keys_manager: &'b test_utils::TestKeysInterface,
331 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>,
332 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
333 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
334 pub node_seed: [u8; 32],
335 pub network_payment_count: Rc<RefCell<u8>>,
336 pub network_chan_count: Rc<RefCell<u32>>,
337 pub logger: &'c test_utils::TestLogger,
338 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
339 pub connect_style: Rc<RefCell<ConnectStyle>>,
340 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
342 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
343 pub fn best_block_hash(&self) -> BlockHash {
344 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
346 pub fn best_block_info(&self) -> (BlockHash, u32) {
347 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
349 pub fn get_block_header(&self, height: u32) -> BlockHeader {
350 self.blocks.lock().unwrap()[height as usize].0.header
354 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
355 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
356 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
358 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
360 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
361 Self((node as *const Node<'a, 'b, 'c>).cast())
364 unsafe impl Send for NodePtr {}
365 unsafe impl Sync for NodePtr {}
367 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
370 // Check that we processed all pending events
371 let msg_events = self.node.get_and_clear_pending_msg_events();
372 if !msg_events.is_empty() {
373 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
375 let events = self.node.get_and_clear_pending_events();
376 if !events.is_empty() {
377 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
379 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
380 if !added_monitors.is_empty() {
381 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
384 // Check that if we serialize the network graph, we can deserialize it again.
385 let network_graph = {
386 let mut w = test_utils::TestVecWriter(Vec::new());
387 self.network_graph.write(&mut w).unwrap();
388 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
389 assert!(network_graph_deser == *self.network_graph);
390 let gossip_sync = P2PGossipSync::new(
391 &network_graph_deser, Some(self.chain_source), self.logger
393 let mut chan_progress = 0;
395 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
396 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
397 assert!(orig_announcements == deserialized_announcements);
398 chan_progress = match orig_announcements {
399 Some(announcement) => announcement.0.contents.short_channel_id + 1,
403 let mut node_progress = None;
405 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
406 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
407 assert!(orig_announcements == deserialized_announcements);
408 node_progress = match orig_announcements {
409 Some(announcement) => Some(announcement.contents.node_id),
416 // Check that if we serialize and then deserialize all our channel monitors we get the
417 // same set of outputs to watch for on chain as we have now. Note that if we write
418 // tests that fully close channels and remove the monitors at some point this may break.
419 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
420 let mut deserialized_monitors = Vec::new();
422 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
423 let mut w = test_utils::TestVecWriter(Vec::new());
424 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
425 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
426 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
427 deserialized_monitors.push(deserialized_monitor);
431 let broadcaster = test_utils::TestBroadcaster {
432 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
433 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
436 // Before using all the new monitors to check the watch outpoints, use the full set of
437 // them to ensure we can write and reload our ChannelManager.
439 let mut channel_monitors = HashMap::new();
440 for monitor in deserialized_monitors.iter_mut() {
441 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
444 let scorer = Mutex::new(test_utils::TestScorer::new());
445 let mut w = test_utils::TestVecWriter(Vec::new());
446 self.node.write(&mut w).unwrap();
447 <(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 {
448 default_config: *self.node.get_current_default_configuration(),
449 entropy_source: self.keys_manager,
450 node_signer: self.keys_manager,
451 signer_provider: self.keys_manager,
452 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
453 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
454 chain_monitor: self.chain_monitor,
455 tx_broadcaster: &broadcaster,
456 logger: &self.logger,
461 let persister = test_utils::TestPersister::new();
462 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
463 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
464 for deserialized_monitor in deserialized_monitors.drain(..) {
465 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
469 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
470 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
475 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) {
476 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
479 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) {
480 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
481 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
482 (announcement, as_update, bs_update, channel_id, tx)
485 /// Gets an RAA and CS which were sent in response to a commitment update
487 /// Should only be used directly when the `$node` is not actually a [`Node`].
488 macro_rules! do_get_revoke_commit_msgs {
489 ($node: expr, $recipient: expr) => { {
490 let events = $node.node.get_and_clear_pending_msg_events();
491 assert_eq!(events.len(), 2);
493 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
494 assert_eq!(node_id, $recipient);
497 _ => panic!("Unexpected event"),
499 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
500 assert_eq!(node_id, $recipient);
501 assert!(updates.update_add_htlcs.is_empty());
502 assert!(updates.update_fulfill_htlcs.is_empty());
503 assert!(updates.update_fail_htlcs.is_empty());
504 assert!(updates.update_fail_malformed_htlcs.is_empty());
505 assert!(updates.update_fee.is_none());
506 updates.commitment_signed.clone()
508 _ => panic!("Unexpected event"),
513 /// Gets an RAA and CS which were sent in response to a commitment update
514 pub fn get_revoke_commit_msgs(node: &Node, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
515 do_get_revoke_commit_msgs!(node, recipient)
519 /// Gets an RAA and CS which were sent in response to a commitment update
521 /// Don't use this, use the identically-named function instead.
522 macro_rules! get_revoke_commit_msgs {
523 ($node: expr, $node_id: expr) => {
524 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
528 /// Get an specific event message from the pending events queue.
530 macro_rules! get_event_msg {
531 ($node: expr, $event_type: path, $node_id: expr) => {
533 let events = $node.node.get_and_clear_pending_msg_events();
534 assert_eq!(events.len(), 1);
536 $event_type { ref node_id, ref msg } => {
537 assert_eq!(*node_id, $node_id);
540 _ => panic!("Unexpected event"),
546 /// Get an error message from the pending events queue.
547 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
548 let events = node.node.get_and_clear_pending_msg_events();
549 assert_eq!(events.len(), 1);
551 MessageSendEvent::HandleError {
552 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
554 assert_eq!(node_id, recipient);
557 _ => panic!("Unexpected event"),
561 /// Get a specific event from the pending events queue.
563 macro_rules! get_event {
564 ($node: expr, $event_type: path) => {
566 let mut events = $node.node.get_and_clear_pending_events();
567 assert_eq!(events.len(), 1);
568 let ev = events.pop().unwrap();
570 $event_type { .. } => {
573 _ => panic!("Unexpected event"),
580 /// Gets an UpdateHTLCs MessageSendEvent
581 macro_rules! get_htlc_update_msgs {
582 ($node: expr, $node_id: expr) => {
584 let events = $node.node.get_and_clear_pending_msg_events();
585 assert_eq!(events.len(), 1);
587 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
588 assert_eq!(*node_id, $node_id);
591 _ => panic!("Unexpected event"),
597 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
598 /// Returns the `msg_event`.
600 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
601 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
602 /// such messages are intended to all peers.
603 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
604 let ev_index = msg_events.iter().position(|e| { match e {
605 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
606 node_id == msg_node_id
608 MessageSendEvent::SendOpenChannel { node_id, .. } => {
609 node_id == msg_node_id
611 MessageSendEvent::SendFundingCreated { node_id, .. } => {
612 node_id == msg_node_id
614 MessageSendEvent::SendFundingSigned { node_id, .. } => {
615 node_id == msg_node_id
617 MessageSendEvent::SendChannelReady { node_id, .. } => {
618 node_id == msg_node_id
620 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
621 node_id == msg_node_id
623 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
624 node_id == msg_node_id
626 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
627 node_id == msg_node_id
629 MessageSendEvent::SendClosingSigned { node_id, .. } => {
630 node_id == msg_node_id
632 MessageSendEvent::SendShutdown { node_id, .. } => {
633 node_id == msg_node_id
635 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
636 node_id == msg_node_id
638 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
639 node_id == msg_node_id
641 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
644 MessageSendEvent::BroadcastChannelUpdate { .. } => {
647 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
650 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
651 node_id == msg_node_id
653 MessageSendEvent::HandleError { node_id, .. } => {
654 node_id == msg_node_id
656 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
657 node_id == msg_node_id
659 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
660 node_id == msg_node_id
662 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
663 node_id == msg_node_id
665 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
666 node_id == msg_node_id
669 if ev_index.is_some() {
670 msg_events.remove(ev_index.unwrap())
672 panic!("Couldn't find any MessageSendEvent to the node!")
677 macro_rules! get_channel_ref {
678 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
680 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
681 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
682 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
688 macro_rules! get_feerate {
689 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
691 let mut per_peer_state_lock;
692 let mut peer_state_lock;
693 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
700 macro_rules! get_opt_anchors {
701 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
703 let mut per_peer_state_lock;
704 let mut peer_state_lock;
705 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
711 /// Returns a channel monitor given a channel id, making some naive assumptions
713 macro_rules! get_monitor {
714 ($node: expr, $channel_id: expr) => {
716 use bitcoin::hashes::Hash;
717 let mut monitor = None;
718 // Assume funding vout is either 0 or 1 blindly
720 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
721 $crate::chain::transaction::OutPoint {
722 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
734 /// Returns any local commitment transactions for the channel.
736 macro_rules! get_local_commitment_txn {
737 ($node: expr, $channel_id: expr) => {
739 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
744 /// Check the error from attempting a payment.
746 macro_rules! unwrap_send_err {
747 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
749 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
750 assert_eq!(fails.len(), 1);
756 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
757 assert_eq!(results.len(), 1);
759 Err($type) => { $check },
768 /// Check whether N channel monitor(s) have been added.
769 pub fn check_added_monitors(node: &Node, count: usize) {
770 let mut added_monitors = node.chain_monitor.added_monitors.lock().unwrap();
771 assert_eq!(added_monitors.len(), count);
772 added_monitors.clear();
775 /// Check whether N channel monitor(s) have been added.
777 /// Don't use this, use the identically-named function instead.
779 macro_rules! check_added_monitors {
780 ($node: expr, $count: expr) => {
781 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
785 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> {
786 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
787 for encoded in monitors_encoded {
788 let mut monitor_read = &encoded[..];
789 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
790 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
791 assert!(monitor_read.is_empty());
792 monitors_read.push(monitor);
795 let mut node_read = &chanman_encoded[..];
796 let (_, node_deserialized) = {
797 let mut channel_monitors = HashMap::new();
798 for monitor in monitors_read.iter_mut() {
799 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
801 <(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 {
803 entropy_source: node.keys_manager,
804 node_signer: node.keys_manager,
805 signer_provider: node.keys_manager,
806 fee_estimator: node.fee_estimator,
808 chain_monitor: node.chain_monitor,
809 tx_broadcaster: node.tx_broadcaster,
814 assert!(node_read.is_empty());
816 for monitor in monitors_read.drain(..) {
817 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
818 ChannelMonitorUpdateStatus::Completed);
819 check_added_monitors!(node, 1);
826 macro_rules! reload_node {
827 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
828 let chanman_encoded = $chanman_encoded;
830 $persister = test_utils::TestPersister::new();
831 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
832 $node.chain_monitor = &$new_chain_monitor;
834 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
835 $node.node = &$new_channelmanager;
837 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
838 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
842 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) {
843 let chan_id = *node.network_chan_count.borrow();
845 let events = node.node.get_and_clear_pending_events();
846 assert_eq!(events.len(), 1);
848 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
849 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
850 assert_eq!(*channel_value_satoshis, expected_chan_value);
851 assert_eq!(user_channel_id, expected_user_chan_id);
853 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
854 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
856 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
857 (*temporary_channel_id, tx, funding_outpoint)
859 _ => panic!("Unexpected event"),
862 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 {
863 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
864 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
866 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
867 check_added_monitors!(node_a, 0);
869 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
870 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
871 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
873 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
874 assert_eq!(added_monitors.len(), 1);
875 assert_eq!(added_monitors[0].0, funding_output);
876 added_monitors.clear();
879 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()));
881 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
882 assert_eq!(added_monitors.len(), 1);
883 assert_eq!(added_monitors[0].0, funding_output);
884 added_monitors.clear();
887 let events_4 = node_a.node.get_and_clear_pending_events();
888 assert_eq!(events_4.len(), 0);
890 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
891 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
892 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
894 // Ensure that funding_transaction_generated is idempotent.
895 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
896 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
897 check_added_monitors!(node_a, 0);
902 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
903 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]) {
904 let initiator_channels = initiator.node.list_usable_channels().len();
905 let receiver_channels = receiver.node.list_usable_channels().len();
907 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
908 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
910 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
911 let events = receiver.node.get_and_clear_pending_events();
912 assert_eq!(events.len(), 1);
914 Event::OpenChannelRequest { temporary_channel_id, .. } => {
915 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
917 _ => panic!("Unexpected event"),
920 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
921 assert_eq!(accept_channel.minimum_depth, 0);
922 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
924 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
925 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
926 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
928 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
929 check_added_monitors!(receiver, 1);
930 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
931 assert_eq!(bs_signed_locked.len(), 2);
932 let as_channel_ready;
933 match &bs_signed_locked[0] {
934 MessageSendEvent::SendFundingSigned { node_id, msg } => {
935 assert_eq!(*node_id, initiator.node.get_our_node_id());
936 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
937 check_added_monitors!(initiator, 1);
939 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
940 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
942 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
944 _ => panic!("Unexpected event"),
946 match &bs_signed_locked[1] {
947 MessageSendEvent::SendChannelReady { node_id, msg } => {
948 assert_eq!(*node_id, initiator.node.get_our_node_id());
949 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
951 _ => panic!("Unexpected event"),
954 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
956 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
957 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
959 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
960 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
962 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
963 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
965 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
966 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
968 (tx, as_channel_ready.channel_id)
971 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 {
972 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
973 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
974 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
975 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
976 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
977 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
978 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
979 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
980 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
982 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
985 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) {
986 confirm_transaction_at(node_conf, tx, conf_height);
987 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
988 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()));
991 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]) {
993 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
994 assert_eq!(events_6.len(), 3);
995 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
996 assert_eq!(*node_id, node_recv.node.get_our_node_id());
998 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
999 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1001 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1002 ((match events_6[0] {
1003 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1004 channel_id = msg.channel_id.clone();
1005 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1008 _ => panic!("Unexpected event"),
1009 }, match events_6[announcement_sigs_idx] {
1010 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1011 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1014 _ => panic!("Unexpected event"),
1018 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]) {
1019 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1020 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1021 confirm_transaction_at(node_a, tx, conf_height);
1022 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1023 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1024 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1027 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) {
1028 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1029 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1033 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) {
1034 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1035 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1036 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1038 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1039 assert_eq!(events_7.len(), 1);
1040 let (announcement, bs_update) = match events_7[0] {
1041 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1042 (msg, update_msg.clone().unwrap())
1044 _ => panic!("Unexpected event"),
1047 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1048 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1049 assert_eq!(events_8.len(), 1);
1050 let as_update = match events_8[0] {
1051 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1052 assert!(*announcement == *msg);
1053 let update_msg = update_msg.clone().unwrap();
1054 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1055 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1058 _ => panic!("Unexpected event"),
1061 *node_a.network_chan_count.borrow_mut() += 1;
1063 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1064 ((*announcement).clone(), as_update, bs_update)
1067 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) {
1068 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1071 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) {
1072 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1073 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1074 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1077 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) {
1078 let mut no_announce_cfg = test_default_channel_config();
1079 no_announce_cfg.channel_handshake_config.announced_channel = false;
1080 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1081 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1082 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1083 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1084 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1086 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1087 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1088 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()));
1089 check_added_monitors!(nodes[b], 1);
1091 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1092 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1093 check_added_monitors!(nodes[a], 1);
1095 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1096 confirm_transaction_at(&nodes[a], &tx, conf_height);
1097 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1098 confirm_transaction_at(&nodes[b], &tx, conf_height);
1099 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1100 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1101 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()));
1102 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1103 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1104 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1105 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1106 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1108 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1109 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1111 let mut found_a = false;
1112 for chan in nodes[a].node.list_usable_channels() {
1113 if chan.channel_id == as_channel_ready.channel_id {
1116 assert!(!chan.is_public);
1121 let mut found_b = false;
1122 for chan in nodes[b].node.list_usable_channels() {
1123 if chan.channel_id == as_channel_ready.channel_id {
1126 assert!(!chan.is_public);
1131 (as_channel_ready, tx)
1134 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) {
1136 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1137 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1138 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1140 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1141 // forwarding info for local channels even if its not accepted in the network graph.
1142 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1143 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1148 macro_rules! check_spends {
1149 ($tx: expr, $($spends_txn: expr),*) => {
1152 for outp in $spends_txn.output.iter() {
1153 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1156 for outp in $tx.output.iter() {
1157 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1159 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1161 if out_point.txid == $spends_txn.txid() {
1162 return $spends_txn.output.get(out_point.vout as usize).cloned()
1167 let mut total_value_in = 0;
1168 for input in $tx.input.iter() {
1169 total_value_in += get_output(&input.previous_output).unwrap().value;
1171 let mut total_value_out = 0;
1172 for output in $tx.output.iter() {
1173 total_value_out += output.value;
1175 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1176 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1177 assert!(total_value_out + min_fee <= total_value_in);
1178 $tx.verify(get_output).unwrap();
1183 macro_rules! get_closing_signed_broadcast {
1184 ($node: expr, $dest_pubkey: expr) => {
1186 let events = $node.get_and_clear_pending_msg_events();
1187 assert!(events.len() == 1 || events.len() == 2);
1188 (match events[events.len() - 1] {
1189 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1190 assert_eq!(msg.contents.flags & 2, 2);
1193 _ => panic!("Unexpected event"),
1194 }, if events.len() == 2 {
1196 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1197 assert_eq!(*node_id, $dest_pubkey);
1200 _ => panic!("Unexpected event"),
1208 macro_rules! check_warn_msg {
1209 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1210 let msg_events = $node.node.get_and_clear_pending_msg_events();
1211 assert_eq!(msg_events.len(), 1);
1212 match msg_events[0] {
1213 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1214 assert_eq!(node_id, $recipient_node_id);
1215 assert_eq!(msg.channel_id, $chan_id);
1218 _ => panic!("Unexpected event"),
1223 /// Check that a channel's closing channel update has been broadcasted, and optionally
1224 /// check whether an error message event has occurred.
1226 macro_rules! check_closed_broadcast {
1227 ($node: expr, $with_error_msg: expr) => {{
1228 use $crate::util::events::MessageSendEvent;
1229 use $crate::ln::msgs::ErrorAction;
1231 let msg_events = $node.node.get_and_clear_pending_msg_events();
1232 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1233 match msg_events[0] {
1234 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1235 assert_eq!(msg.contents.flags & 2, 2);
1237 _ => panic!("Unexpected event"),
1239 if $with_error_msg {
1240 match msg_events[1] {
1241 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1242 // TODO: Check node_id
1245 _ => panic!("Unexpected event"),
1251 /// Check that a channel's closing channel events has been issued
1253 macro_rules! check_closed_event {
1254 ($node: expr, $events: expr, $reason: expr) => {
1255 check_closed_event!($node, $events, $reason, false);
1257 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1258 use $crate::util::events::Event;
1260 let events = $node.node.get_and_clear_pending_events();
1261 assert_eq!(events.len(), $events, "{:?}", events);
1262 let expected_reason = $reason;
1263 let mut issues_discard_funding = false;
1264 for event in events {
1266 Event::ChannelClosed { ref reason, .. } => {
1267 assert_eq!(*reason, expected_reason);
1269 Event::DiscardFunding { .. } => {
1270 issues_discard_funding = true;
1272 _ => panic!("Unexpected event"),
1275 assert_eq!($is_check_discard_funding, issues_discard_funding);
1279 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) {
1280 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) };
1281 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) };
1284 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1285 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1287 let events_1 = node_b.get_and_clear_pending_msg_events();
1288 assert!(events_1.len() >= 1);
1289 let shutdown_b = match events_1[0] {
1290 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1291 assert_eq!(node_id, &node_a.get_our_node_id());
1294 _ => panic!("Unexpected event"),
1297 let closing_signed_b = if !close_inbound_first {
1298 assert_eq!(events_1.len(), 1);
1301 Some(match events_1[1] {
1302 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1303 assert_eq!(node_id, &node_a.get_our_node_id());
1306 _ => panic!("Unexpected event"),
1310 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1311 let (as_update, bs_update) = if close_inbound_first {
1312 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1313 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1315 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1316 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1317 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1318 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1320 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1321 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1322 assert!(none_a.is_none());
1323 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1324 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1325 (as_update, bs_update)
1327 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1329 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1330 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1332 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1333 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1334 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1336 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1337 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1338 assert!(none_b.is_none());
1339 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1340 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1341 (as_update, bs_update)
1343 assert_eq!(tx_a, tx_b);
1344 check_spends!(tx_a, funding_tx);
1346 (as_update, bs_update, tx_a)
1349 pub struct SendEvent {
1350 pub node_id: PublicKey,
1351 pub msgs: Vec<msgs::UpdateAddHTLC>,
1352 pub commitment_msg: msgs::CommitmentSigned,
1355 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1356 assert!(updates.update_fulfill_htlcs.is_empty());
1357 assert!(updates.update_fail_htlcs.is_empty());
1358 assert!(updates.update_fail_malformed_htlcs.is_empty());
1359 assert!(updates.update_fee.is_none());
1360 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1363 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1365 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1366 _ => panic!("Unexpected event type!"),
1370 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1371 let mut events = node.node.get_and_clear_pending_msg_events();
1372 assert_eq!(events.len(), 1);
1373 SendEvent::from_event(events.pop().unwrap())
1378 macro_rules! expect_pending_htlcs_forwardable_conditions {
1379 ($node: expr, $expected_failures: expr) => {{
1380 let expected_failures = $expected_failures;
1381 let events = $node.node.get_and_clear_pending_events();
1383 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1384 _ => panic!("Unexpected event {:?}", events),
1387 let count = expected_failures.len() + 1;
1388 assert_eq!(events.len(), count);
1390 if expected_failures.len() > 0 {
1391 expect_htlc_handling_failed_destinations!(events, expected_failures)
1397 macro_rules! expect_htlc_handling_failed_destinations {
1398 ($events: expr, $expected_failures: expr) => {{
1399 for event in $events {
1401 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1402 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1403 assert!($expected_failures.contains(&failed_next_destination))
1405 _ => panic!("Unexpected destination"),
1412 /// Clears (and ignores) a PendingHTLCsForwardable event
1413 macro_rules! expect_pending_htlcs_forwardable_ignore {
1415 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1420 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1421 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1422 ($node: expr, $expected_failures: expr) => {{
1423 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1428 /// Handles a PendingHTLCsForwardable event
1429 macro_rules! expect_pending_htlcs_forwardable {
1431 expect_pending_htlcs_forwardable_ignore!($node);
1432 $node.node.process_pending_htlc_forwards();
1434 // Ensure process_pending_htlc_forwards is idempotent.
1435 $node.node.process_pending_htlc_forwards();
1440 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1441 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1442 ($node: expr, $expected_failures: expr) => {{
1443 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1444 $node.node.process_pending_htlc_forwards();
1446 // Ensure process_pending_htlc_forwards is idempotent.
1447 $node.node.process_pending_htlc_forwards();
1452 macro_rules! expect_pending_htlcs_forwardable_from_events {
1453 ($node: expr, $events: expr, $ignore: expr) => {{
1454 assert_eq!($events.len(), 1);
1456 Event::PendingHTLCsForwardable { .. } => { },
1457 _ => panic!("Unexpected event"),
1460 $node.node.process_pending_htlc_forwards();
1462 // Ensure process_pending_htlc_forwards is idempotent.
1463 $node.node.process_pending_htlc_forwards();
1469 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1470 /// commitment update.
1471 macro_rules! commitment_signed_dance {
1472 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1473 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1475 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1476 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1478 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1480 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1481 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1482 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1483 check_added_monitors(&$node_a, 1);
1484 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1485 assert!(extra_msg_option.is_none());
1489 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1491 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1492 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1493 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 1);
1497 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1498 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1500 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1501 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1506 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1507 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1508 check_added_monitors!(node_b, 0);
1509 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1510 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1511 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1512 check_added_monitors!(node_b, 1);
1513 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1514 let (bs_revoke_and_ack, extra_msg_option) = {
1515 let mut events = node_b.node.get_and_clear_pending_msg_events();
1516 assert!(events.len() <= 2);
1517 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1518 (match node_a_event {
1519 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1520 assert_eq!(*node_id, node_a.node.get_our_node_id());
1523 _ => panic!("Unexpected event"),
1524 }, events.get(0).map(|e| e.clone()))
1526 check_added_monitors!(node_b, 1);
1528 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1529 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1531 (extra_msg_option, bs_revoke_and_ack)
1534 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1535 check_added_monitors!(node_a, 0);
1536 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1537 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1538 check_added_monitors!(node_a, 1);
1540 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1542 if skip_last_step { return; }
1545 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1546 vec![crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1547 check_added_monitors!(node_a, 1);
1549 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1550 let mut number_of_msg_events = 0;
1551 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1552 let peer_state = peer_state_mutex.lock().unwrap();
1553 let cp_pending_msg_events = &peer_state.pending_msg_events;
1554 number_of_msg_events += cp_pending_msg_events.len();
1555 if cp_pending_msg_events.len() == 1 {
1556 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1557 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1558 } else { panic!("Unexpected event"); }
1561 // Expecting the failure backwards event to the previous hop (not `node_b`)
1562 assert_eq!(number_of_msg_events, 1);
1564 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1568 /// Get a payment preimage and hash.
1569 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1570 let mut payment_count = recipient.network_payment_count.borrow_mut();
1571 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1572 *payment_count += 1;
1573 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1574 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1575 (payment_preimage, payment_hash, payment_secret)
1578 /// Get a payment preimage and hash.
1580 /// Don't use this, use the identically-named function instead.
1582 macro_rules! get_payment_preimage_hash {
1583 ($dest_node: expr) => {
1584 get_payment_preimage_hash!($dest_node, None)
1586 ($dest_node: expr, $min_value_msat: expr) => {
1587 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1589 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1590 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1594 /// Gets a route from the given sender to the node described in `payment_params`.
1595 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64, final_cltv_expiry_delta: u32) -> Result<Route, msgs::LightningError> {
1596 let scorer = TestScorer::new();
1597 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1598 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1600 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1601 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1602 recv_value, final_cltv_expiry_delta, send_node.logger, &scorer, &random_seed_bytes
1606 /// Gets a route from the given sender to the node described in `payment_params`.
1608 /// Don't use this, use the identically-named function instead.
1610 macro_rules! get_route {
1611 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {
1612 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv)
1618 macro_rules! get_route_and_payment_hash {
1619 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1620 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1621 .with_features($recv_node.node.invoice_features());
1622 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1624 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1625 let (payment_preimage, payment_hash, payment_secret) =
1626 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1627 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv);
1628 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1633 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1634 macro_rules! expect_payment_claimable {
1635 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1636 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1638 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1639 let events = $node.node.get_and_clear_pending_events();
1640 assert_eq!(events.len(), 1);
1642 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1643 assert_eq!($expected_payment_hash, *payment_hash);
1644 assert_eq!($expected_recv_value, amount_msat);
1645 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1647 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1648 assert_eq!(&$expected_payment_preimage, payment_preimage);
1649 assert_eq!($expected_payment_secret, *payment_secret);
1654 _ => panic!("Unexpected event"),
1660 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1661 macro_rules! expect_payment_claimed {
1662 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1663 let events = $node.node.get_and_clear_pending_events();
1664 assert_eq!(events.len(), 1);
1666 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1667 assert_eq!($expected_payment_hash, *payment_hash);
1668 assert_eq!($expected_recv_value, amount_msat);
1670 _ => panic!("Unexpected event"),
1677 macro_rules! expect_payment_sent_without_paths {
1678 ($node: expr, $expected_payment_preimage: expr) => {
1679 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1681 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1682 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1687 macro_rules! expect_payment_sent {
1688 ($node: expr, $expected_payment_preimage: expr) => {
1689 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1691 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1692 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1694 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1695 use bitcoin::hashes::Hash as _;
1696 let events = $node.node.get_and_clear_pending_events();
1697 let expected_payment_hash = $crate::ln::PaymentHash(
1698 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1700 assert!(events.len() > 1);
1702 assert_eq!(events.len(), 1);
1704 let expected_payment_id = match events[0] {
1705 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1706 assert_eq!($expected_payment_preimage, *payment_preimage);
1707 assert_eq!(expected_payment_hash, *payment_hash);
1708 assert!(fee_paid_msat.is_some());
1709 if $expected_fee_msat_opt.is_some() {
1710 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1714 _ => panic!("Unexpected event"),
1717 for i in 1..events.len() {
1719 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1720 assert_eq!(payment_id, expected_payment_id);
1721 assert_eq!(payment_hash, Some(expected_payment_hash));
1723 _ => panic!("Unexpected event"),
1732 macro_rules! expect_payment_path_successful {
1734 let events = $node.node.get_and_clear_pending_events();
1735 assert_eq!(events.len(), 1);
1737 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1738 _ => panic!("Unexpected event"),
1743 macro_rules! expect_payment_forwarded {
1744 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1745 let events = $node.node.get_and_clear_pending_events();
1746 assert_eq!(events.len(), 1);
1748 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1749 assert_eq!(fee_earned_msat, $expected_fee);
1750 if fee_earned_msat.is_some() {
1751 // Is the event prev_channel_id in one of the channels between the two nodes?
1752 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()));
1754 // We check for force closures since a force closed channel is removed from the
1755 // node's channel list
1756 if !$downstream_force_closed {
1757 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()));
1759 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1761 _ => panic!("Unexpected event"),
1766 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1767 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1768 let events = node.node.get_and_clear_pending_events();
1769 assert_eq!(events.len(), 1);
1771 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1772 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1774 _ => panic!("Unexpected event"),
1779 pub struct PaymentFailedConditions<'a> {
1780 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1781 pub(crate) expected_blamed_scid: Option<u64>,
1782 pub(crate) expected_blamed_chan_closed: Option<bool>,
1783 pub(crate) expected_mpp_parts_remain: bool,
1786 impl<'a> PaymentFailedConditions<'a> {
1787 pub fn new() -> Self {
1789 expected_htlc_error_data: None,
1790 expected_blamed_scid: None,
1791 expected_blamed_chan_closed: None,
1792 expected_mpp_parts_remain: false,
1795 pub fn mpp_parts_remain(mut self) -> Self {
1796 self.expected_mpp_parts_remain = true;
1799 pub fn blamed_scid(mut self, scid: u64) -> Self {
1800 self.expected_blamed_scid = Some(scid);
1803 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1804 self.expected_blamed_chan_closed = Some(closed);
1807 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1808 self.expected_htlc_error_data = Some((code, data));
1814 macro_rules! expect_payment_failed_with_update {
1815 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1816 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1817 &$node, $expected_payment_hash, $payment_failed_permanently,
1818 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1819 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1824 macro_rules! expect_payment_failed {
1825 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1826 #[allow(unused_mut)]
1827 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1829 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1831 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1835 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1836 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1837 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1839 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
1840 let expected_payment_id = match &payment_failed_events[0] {
1841 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, failure, short_channel_id,
1845 error_data, .. } => {
1846 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
1847 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1848 assert!(retry.is_some(), "expected retry.is_some()");
1849 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1850 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1851 if let Some(scid) = short_channel_id {
1852 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1857 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1858 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1859 if let Some((code, data)) = conditions.expected_htlc_error_data {
1860 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1861 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1865 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1866 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
1868 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
1869 if let Some(scid) = conditions.expected_blamed_scid {
1870 assert_eq!(msg.contents.short_channel_id, scid);
1872 const CHAN_DISABLED_FLAG: u8 = 2;
1873 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1875 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
1876 if let Some(scid) = conditions.expected_blamed_scid {
1877 assert_eq!(*short_channel_id, scid);
1879 assert!(is_permanent);
1881 _ => panic!("Unexpected update type"),
1883 } else { panic!("Expected network update"); }
1888 _ => panic!("Unexpected event"),
1890 if !conditions.expected_mpp_parts_remain {
1891 match &payment_failed_events[1] {
1892 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1893 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1894 assert_eq!(*payment_id, expected_payment_id);
1896 _ => panic!("Unexpected second event"),
1901 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1902 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1903 conditions: PaymentFailedConditions<'e>
1905 let events = node.node.get_and_clear_pending_events();
1906 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
1909 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 {
1910 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1911 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1912 check_added_monitors!(origin_node, expected_paths.len());
1913 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1917 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>) {
1918 let mut payment_event = SendEvent::from_event(ev);
1919 let mut prev_node = origin_node;
1921 for (idx, &node) in expected_path.iter().enumerate() {
1922 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1924 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1925 check_added_monitors!(node, 0);
1926 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1928 expect_pending_htlcs_forwardable!(node);
1930 if idx == expected_path.len() - 1 && clear_recipient_events {
1931 let events_2 = node.node.get_and_clear_pending_events();
1932 if payment_claimable_expected {
1933 assert_eq!(events_2.len(), 1);
1935 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1936 assert_eq!(our_payment_hash, *payment_hash);
1937 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1939 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1940 assert_eq!(expected_preimage, *payment_preimage);
1941 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1943 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1944 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1945 assert!(our_payment_secret.is_none());
1948 assert_eq!(amount_msat, recv_value);
1949 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1950 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1952 _ => panic!("Unexpected event"),
1955 assert!(events_2.is_empty());
1957 } else if idx != expected_path.len() - 1 {
1958 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1959 assert_eq!(events_2.len(), 1);
1960 check_added_monitors!(node, 1);
1961 payment_event = SendEvent::from_event(events_2.remove(0));
1962 assert_eq!(payment_event.msgs.len(), 1);
1969 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>) {
1970 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1973 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) {
1974 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1975 assert_eq!(events.len(), expected_route.len());
1976 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1977 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
1978 // Once we've gotten through all the HTLCs, the last one should result in a
1979 // PaymentClaimable (but each previous one should not!), .
1980 let expect_payment = path_idx == expected_route.len() - 1;
1981 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1985 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) {
1986 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1987 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1988 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1991 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 {
1992 for path in expected_paths.iter() {
1993 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1995 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1997 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1998 assert_eq!(claim_event.len(), 1);
1999 match claim_event[0] {
2000 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2001 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2002 assert_eq!(preimage, our_payment_preimage),
2003 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2004 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2008 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2010 let mut expected_total_fee_msat = 0;
2012 macro_rules! msgs_from_ev {
2015 &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 } } => {
2016 assert!(update_add_htlcs.is_empty());
2017 assert_eq!(update_fulfill_htlcs.len(), 1);
2018 assert!(update_fail_htlcs.is_empty());
2019 assert!(update_fail_malformed_htlcs.is_empty());
2020 assert!(update_fee.is_none());
2021 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2023 _ => panic!("Unexpected event"),
2027 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2028 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2029 assert_eq!(events.len(), expected_paths.len());
2031 if events.len() == 1 {
2032 per_path_msgs.push(msgs_from_ev!(&events[0]));
2034 for expected_path in expected_paths.iter() {
2035 // For MPP payments, we always want the message to the first node in the path.
2036 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2037 per_path_msgs.push(msgs_from_ev!(&ev));
2041 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2042 let mut next_msgs = Some(path_msgs);
2043 let mut expected_next_node = next_hop;
2045 macro_rules! last_update_fulfill_dance {
2046 ($node: expr, $prev_node: expr) => {
2048 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2049 check_added_monitors!($node, 0);
2050 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2051 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2055 macro_rules! mid_update_fulfill_dance {
2056 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2058 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2060 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2061 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2062 .unwrap().lock().unwrap();
2063 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2064 if let Some(prev_config) = channel.prev_config() {
2065 prev_config.forwarding_fee_base_msat
2067 channel.config().forwarding_fee_base_msat
2070 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2071 expected_total_fee_msat += fee as u64;
2072 check_added_monitors!($node, 1);
2073 let new_next_msgs = if $new_msgs {
2074 let events = $node.node.get_and_clear_pending_msg_events();
2075 assert_eq!(events.len(), 1);
2076 let (res, nexthop) = msgs_from_ev!(&events[0]);
2077 expected_next_node = nexthop;
2080 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2083 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2084 next_msgs = new_next_msgs;
2089 let mut prev_node = expected_route.last().unwrap();
2090 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2091 assert_eq!(expected_next_node, node.node.get_our_node_id());
2092 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2093 if next_msgs.is_some() {
2094 // Since we are traversing in reverse, next_node is actually the previous node
2095 let next_node: &Node;
2096 if idx == expected_route.len() - 1 {
2097 next_node = origin_node;
2099 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2101 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2103 assert!(!update_next_msgs);
2104 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2106 if !skip_last && idx == expected_route.len() - 1 {
2107 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2114 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2118 // Ensure that claim_funds is idempotent.
2119 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2120 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2121 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2123 expected_total_fee_msat
2125 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) {
2126 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2128 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2132 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2133 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2136 pub const TEST_FINAL_CLTV: u32 = 70;
2138 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) {
2139 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2140 .with_features(expected_route.last().unwrap().node.invoice_features());
2141 let route = get_route(origin_node, &payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2142 assert_eq!(route.paths.len(), 1);
2143 assert_eq!(route.paths[0].len(), expected_route.len());
2144 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2145 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2148 let res = send_along_route(origin_node, route, expected_route, recv_value);
2149 (res.0, res.1, res.2)
2152 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2153 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2154 .with_features(expected_route.last().unwrap().node.invoice_features());
2155 let network_graph = origin_node.network_graph.read_only();
2156 let scorer = test_utils::TestScorer::new();
2157 let seed = [0u8; 32];
2158 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2159 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2160 let route = router::get_route(
2161 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2162 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2163 assert_eq!(route.paths.len(), 1);
2164 assert_eq!(route.paths[0].len(), expected_route.len());
2165 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2166 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2169 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2170 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 },
2171 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2174 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2175 let res = route_payment(&origin, expected_route, recv_value);
2176 claim_payment(&origin, expected_route, res.0);
2180 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) {
2181 for path in expected_paths.iter() {
2182 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2184 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2185 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2186 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2188 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2191 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) {
2192 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2193 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2195 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2196 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2197 assert_eq!(events.len(), expected_paths.len());
2198 for ev in events.iter() {
2199 let (update_fail, commitment_signed, node_id) = match ev {
2200 &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 } } => {
2201 assert!(update_add_htlcs.is_empty());
2202 assert!(update_fulfill_htlcs.is_empty());
2203 assert_eq!(update_fail_htlcs.len(), 1);
2204 assert!(update_fail_malformed_htlcs.is_empty());
2205 assert!(update_fee.is_none());
2206 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2208 _ => panic!("Unexpected event"),
2210 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2212 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2213 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()));
2215 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2216 let mut next_msgs = Some(path_msgs);
2217 let mut expected_next_node = next_hop;
2218 let mut prev_node = expected_route.last().unwrap();
2220 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2221 assert_eq!(expected_next_node, node.node.get_our_node_id());
2222 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2223 if next_msgs.is_some() {
2224 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2225 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2226 if !update_next_node {
2227 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 }]);
2230 let events = node.node.get_and_clear_pending_msg_events();
2231 if update_next_node {
2232 assert_eq!(events.len(), 1);
2234 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 } } => {
2235 assert!(update_add_htlcs.is_empty());
2236 assert!(update_fulfill_htlcs.is_empty());
2237 assert_eq!(update_fail_htlcs.len(), 1);
2238 assert!(update_fail_malformed_htlcs.is_empty());
2239 assert!(update_fee.is_none());
2240 expected_next_node = node_id.clone();
2241 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2243 _ => panic!("Unexpected event"),
2246 assert!(events.is_empty());
2248 if !skip_last && idx == expected_route.len() - 1 {
2249 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2256 let prev_node = expected_route.first().unwrap();
2257 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2258 check_added_monitors!(origin_node, 0);
2259 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2260 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2261 let events = origin_node.node.get_and_clear_pending_events();
2262 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2264 let expected_payment_id = match events[0] {
2265 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2266 assert_eq!(payment_hash, our_payment_hash);
2267 assert!(payment_failed_permanently);
2268 for (idx, hop) in expected_route.iter().enumerate() {
2269 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2273 _ => panic!("Unexpected event"),
2275 if i == expected_paths.len() - 1 {
2277 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2278 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2279 assert_eq!(*payment_id, expected_payment_id);
2281 _ => panic!("Unexpected second event"),
2287 // Ensure that fail_htlc_backwards is idempotent.
2288 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2289 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2290 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2291 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2294 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2295 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2298 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2299 let mut chan_mon_cfgs = Vec::new();
2300 for i in 0..node_count {
2301 let tx_broadcaster = test_utils::TestBroadcaster {
2302 txn_broadcasted: Mutex::new(Vec::new()),
2303 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2305 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2306 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2307 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2308 let persister = test_utils::TestPersister::new();
2309 let seed = [i as u8; 32];
2310 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2311 let scorer = Mutex::new(test_utils::TestScorer::new());
2313 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2319 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2320 let mut nodes = Vec::new();
2322 for i in 0..node_count {
2323 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);
2324 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2325 let seed = [i as u8; 32];
2326 nodes.push(NodeCfg {
2327 chain_source: &chanmon_cfgs[i].chain_source,
2328 logger: &chanmon_cfgs[i].logger,
2329 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2330 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2331 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2333 keys_manager: &chanmon_cfgs[i].keys_manager,
2336 override_init_features: Rc::new(RefCell::new(None)),
2343 pub fn test_default_channel_config() -> UserConfig {
2344 let mut default_config = UserConfig::default();
2345 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2346 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2347 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2348 default_config.channel_handshake_config.announced_channel = true;
2349 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2350 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2351 // It now defaults to 1, so we simply set it to the expected value here.
2352 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2353 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2354 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2355 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2359 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>> {
2360 let mut chanmgrs = Vec::new();
2361 for i in 0..node_count {
2362 let network = Network::Testnet;
2363 let params = ChainParameters {
2365 best_block: BestBlock::from_network(network),
2367 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,
2368 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);
2369 chanmgrs.push(node);
2375 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>> {
2376 let mut nodes = Vec::new();
2377 let chan_count = Rc::new(RefCell::new(0));
2378 let payment_count = Rc::new(RefCell::new(0));
2379 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2381 for i in 0..node_count {
2382 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2384 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2385 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2386 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2387 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2388 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2389 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2390 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2391 connect_style: Rc::clone(&connect_style),
2392 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2396 for i in 0..node_count {
2397 for j in (i+1)..node_count {
2398 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();
2399 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();
2406 // Note that the following only works for CLTV values up to 128
2407 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2409 #[derive(PartialEq)]
2410 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2411 /// Tests that the given node has broadcast transactions for the given Channel
2413 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2414 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2415 /// broadcast and the revoked outputs were claimed.
2417 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2418 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2420 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2422 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> {
2423 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2424 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2426 let mut res = Vec::with_capacity(2);
2427 node_txn.retain(|tx| {
2428 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2429 check_spends!(tx, chan.3);
2430 if commitment_tx.is_none() {
2431 res.push(tx.clone());
2436 if let Some(explicit_tx) = commitment_tx {
2437 res.push(explicit_tx.clone());
2440 assert_eq!(res.len(), 1);
2442 if has_htlc_tx != HTLCType::NONE {
2443 node_txn.retain(|tx| {
2444 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2445 check_spends!(tx, res[0]);
2446 if has_htlc_tx == HTLCType::TIMEOUT {
2447 assert!(tx.lock_time.0 != 0);
2449 assert!(tx.lock_time.0 == 0);
2451 res.push(tx.clone());
2455 assert!(res.len() == 2 || res.len() == 3);
2457 assert_eq!(res[1], res[2]);
2461 assert!(node_txn.is_empty());
2465 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2466 /// HTLC transaction.
2467 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2468 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2469 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2470 // for revoked htlc outputs
2471 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2472 node_txn.retain(|tx| {
2473 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2474 check_spends!(tx, revoked_tx);
2478 node_txn.retain(|tx| {
2479 check_spends!(tx, commitment_revoked_tx);
2482 assert!(node_txn.is_empty());
2485 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2486 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2488 assert!(node_txn.len() >= 1);
2489 assert_eq!(node_txn[0].input.len(), 1);
2490 let mut found_prev = false;
2492 for tx in prev_txn {
2493 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2494 check_spends!(node_txn[0], tx);
2495 let mut iter = node_txn[0].input[0].witness.iter();
2496 iter.next().expect("expected 3 witness items");
2497 iter.next().expect("expected 3 witness items");
2498 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2499 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2505 assert!(found_prev);
2507 let mut res = Vec::new();
2508 mem::swap(&mut *node_txn, &mut res);
2512 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) {
2513 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2514 assert_eq!(events_1.len(), 2);
2515 let as_update = match events_1[0] {
2516 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2519 _ => panic!("Unexpected event"),
2522 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2523 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2524 assert_eq!(msg.data, expected_error);
2525 if needs_err_handle {
2526 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2529 _ => panic!("Unexpected event"),
2532 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2533 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2534 let bs_update = match events_2[0] {
2535 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2538 _ => panic!("Unexpected event"),
2540 if !needs_err_handle {
2542 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2543 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2544 assert_eq!(msg.data, expected_error);
2546 _ => panic!("Unexpected event"),
2551 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2552 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2556 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2557 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2561 macro_rules! get_channel_value_stat {
2562 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2563 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2564 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2565 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2566 chan.get_value_stat()
2570 macro_rules! get_chan_reestablish_msgs {
2571 ($src_node: expr, $dst_node: expr) => {
2573 let mut announcements = $crate::prelude::HashSet::new();
2574 let mut res = Vec::with_capacity(1);
2575 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2576 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2577 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2578 res.push(msg.clone());
2579 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2580 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2581 announcements.insert(msg.contents.short_channel_id);
2583 panic!("Unexpected event")
2586 for chan in $src_node.node.list_channels() {
2587 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2588 if let Some(scid) = chan.short_channel_id {
2589 assert!(announcements.remove(&scid));
2593 assert!(announcements.is_empty());
2599 macro_rules! handle_chan_reestablish_msgs {
2600 ($src_node: expr, $dst_node: expr) => {
2602 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2604 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2606 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2612 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2614 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2617 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2618 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2619 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2621 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2622 had_channel_update = true;
2625 let mut revoke_and_ack = None;
2626 let mut commitment_update = None;
2627 let order = if let Some(ev) = msg_events.get(idx) {
2629 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2630 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2631 revoke_and_ack = Some(msg.clone());
2633 RAACommitmentOrder::RevokeAndACKFirst
2635 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2636 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2637 commitment_update = Some(updates.clone());
2639 RAACommitmentOrder::CommitmentFirst
2641 _ => RAACommitmentOrder::CommitmentFirst,
2644 RAACommitmentOrder::CommitmentFirst
2647 if let Some(ev) = msg_events.get(idx) {
2649 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2650 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2651 assert!(revoke_and_ack.is_none());
2652 revoke_and_ack = Some(msg.clone());
2655 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2656 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2657 assert!(commitment_update.is_none());
2658 commitment_update = Some(updates.clone());
2665 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2666 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2668 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2669 assert!(!had_channel_update);
2672 assert_eq!(msg_events.len(), idx);
2674 (channel_ready, revoke_and_ack, commitment_update, order)
2679 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2680 /// for claims/fails they are separated out.
2681 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)) {
2682 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();
2683 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2684 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();
2685 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2687 if send_channel_ready.0 {
2688 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2690 for reestablish in reestablish_1.iter() {
2691 assert_eq!(reestablish.next_remote_commitment_number, 0);
2694 if send_channel_ready.1 {
2695 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2697 for reestablish in reestablish_2.iter() {
2698 assert_eq!(reestablish.next_remote_commitment_number, 0);
2701 if send_channel_ready.0 || send_channel_ready.1 {
2702 // If we expect any channel_ready's, both sides better have set
2703 // next_holder_commitment_number to 1
2704 for reestablish in reestablish_1.iter() {
2705 assert_eq!(reestablish.next_local_commitment_number, 1);
2707 for reestablish in reestablish_2.iter() {
2708 assert_eq!(reestablish.next_local_commitment_number, 1);
2712 let mut resp_1 = Vec::new();
2713 for msg in reestablish_1 {
2714 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2715 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2717 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2718 check_added_monitors!(node_b, 1);
2720 check_added_monitors!(node_b, 0);
2723 let mut resp_2 = Vec::new();
2724 for msg in reestablish_2 {
2725 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2726 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2728 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2729 check_added_monitors!(node_a, 1);
2731 check_added_monitors!(node_a, 0);
2734 // We don't yet support both needing updates, as that would require a different commitment dance:
2735 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2736 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2737 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2738 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2740 for chan_msgs in resp_1.drain(..) {
2741 if send_channel_ready.0 {
2742 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2743 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2744 if !announcement_event.is_empty() {
2745 assert_eq!(announcement_event.len(), 1);
2746 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2747 //TODO: Test announcement_sigs re-sending
2748 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2751 assert!(chan_msgs.0.is_none());
2754 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2755 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2756 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2757 check_added_monitors!(node_a, 1);
2759 assert!(chan_msgs.1.is_none());
2761 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 {
2762 let commitment_update = chan_msgs.2.unwrap();
2763 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2764 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2766 assert!(commitment_update.update_add_htlcs.is_empty());
2768 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2769 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2770 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2771 for update_add in commitment_update.update_add_htlcs {
2772 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2774 for update_fulfill in commitment_update.update_fulfill_htlcs {
2775 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2777 for update_fail in commitment_update.update_fail_htlcs {
2778 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2781 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2782 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2784 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2785 check_added_monitors!(node_a, 1);
2786 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2787 // No commitment_signed so get_event_msg's assert(len == 1) passes
2788 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2789 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2790 check_added_monitors!(node_b, 1);
2793 assert!(chan_msgs.2.is_none());
2797 for chan_msgs in resp_2.drain(..) {
2798 if send_channel_ready.1 {
2799 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2800 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2801 if !announcement_event.is_empty() {
2802 assert_eq!(announcement_event.len(), 1);
2803 match announcement_event[0] {
2804 MessageSendEvent::SendChannelUpdate { .. } => {},
2805 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2806 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2810 assert!(chan_msgs.0.is_none());
2813 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2814 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2815 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2816 check_added_monitors!(node_b, 1);
2818 assert!(chan_msgs.1.is_none());
2820 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 {
2821 let commitment_update = chan_msgs.2.unwrap();
2822 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2823 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2825 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2826 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2827 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2828 for update_add in commitment_update.update_add_htlcs {
2829 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2831 for update_fulfill in commitment_update.update_fulfill_htlcs {
2832 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2834 for update_fail in commitment_update.update_fail_htlcs {
2835 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2838 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2839 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2841 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2842 check_added_monitors!(node_b, 1);
2843 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2844 // No commitment_signed so get_event_msg's assert(len == 1) passes
2845 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2846 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2847 check_added_monitors!(node_a, 1);
2850 assert!(chan_msgs.2.is_none());