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.
548 macro_rules! get_err_msg {
549 ($node: expr, $node_id: expr) => {
551 let events = $node.node.get_and_clear_pending_msg_events();
552 assert_eq!(events.len(), 1);
554 $crate::util::events::MessageSendEvent::HandleError {
555 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
557 assert_eq!(*node_id, $node_id);
560 _ => panic!("Unexpected event"),
566 /// Get a specific event from the pending events queue.
568 macro_rules! get_event {
569 ($node: expr, $event_type: path) => {
571 let mut events = $node.node.get_and_clear_pending_events();
572 assert_eq!(events.len(), 1);
573 let ev = events.pop().unwrap();
575 $event_type { .. } => {
578 _ => panic!("Unexpected event"),
585 /// Gets an UpdateHTLCs MessageSendEvent
586 macro_rules! get_htlc_update_msgs {
587 ($node: expr, $node_id: expr) => {
589 let events = $node.node.get_and_clear_pending_msg_events();
590 assert_eq!(events.len(), 1);
592 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
593 assert_eq!(*node_id, $node_id);
596 _ => panic!("Unexpected event"),
602 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
603 /// Returns the `msg_event`.
605 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
606 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
607 /// such messages are intended to all peers.
608 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
609 let ev_index = msg_events.iter().position(|e| { match e {
610 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
611 node_id == msg_node_id
613 MessageSendEvent::SendOpenChannel { node_id, .. } => {
614 node_id == msg_node_id
616 MessageSendEvent::SendFundingCreated { node_id, .. } => {
617 node_id == msg_node_id
619 MessageSendEvent::SendFundingSigned { node_id, .. } => {
620 node_id == msg_node_id
622 MessageSendEvent::SendChannelReady { node_id, .. } => {
623 node_id == msg_node_id
625 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
626 node_id == msg_node_id
628 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
629 node_id == msg_node_id
631 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
632 node_id == msg_node_id
634 MessageSendEvent::SendClosingSigned { node_id, .. } => {
635 node_id == msg_node_id
637 MessageSendEvent::SendShutdown { node_id, .. } => {
638 node_id == msg_node_id
640 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
641 node_id == msg_node_id
643 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
644 node_id == msg_node_id
646 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
649 MessageSendEvent::BroadcastChannelUpdate { .. } => {
652 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
655 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
656 node_id == msg_node_id
658 MessageSendEvent::HandleError { node_id, .. } => {
659 node_id == msg_node_id
661 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
662 node_id == msg_node_id
664 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
665 node_id == msg_node_id
667 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
668 node_id == msg_node_id
670 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
671 node_id == msg_node_id
674 if ev_index.is_some() {
675 msg_events.remove(ev_index.unwrap())
677 panic!("Couldn't find any MessageSendEvent to the node!")
682 macro_rules! get_channel_ref {
683 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
685 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
686 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
687 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
693 macro_rules! get_feerate {
694 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
696 let mut per_peer_state_lock;
697 let mut peer_state_lock;
698 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
705 macro_rules! get_opt_anchors {
706 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
708 let mut per_peer_state_lock;
709 let mut peer_state_lock;
710 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
716 /// Returns a channel monitor given a channel id, making some naive assumptions
718 macro_rules! get_monitor {
719 ($node: expr, $channel_id: expr) => {
721 use bitcoin::hashes::Hash;
722 let mut monitor = None;
723 // Assume funding vout is either 0 or 1 blindly
725 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
726 $crate::chain::transaction::OutPoint {
727 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
739 /// Returns any local commitment transactions for the channel.
741 macro_rules! get_local_commitment_txn {
742 ($node: expr, $channel_id: expr) => {
744 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
749 /// Check the error from attempting a payment.
751 macro_rules! unwrap_send_err {
752 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
754 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
755 assert_eq!(fails.len(), 1);
761 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
762 assert_eq!(results.len(), 1);
764 Err($type) => { $check },
773 /// Check whether N channel monitor(s) have been added.
774 pub fn check_added_monitors(node: &Node, count: usize) {
775 let mut added_monitors = node.chain_monitor.added_monitors.lock().unwrap();
776 assert_eq!(added_monitors.len(), count);
777 added_monitors.clear();
780 /// Check whether N channel monitor(s) have been added.
782 /// Don't use this, use the identically-named function instead.
784 macro_rules! check_added_monitors {
785 ($node: expr, $count: expr) => {
786 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
790 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> {
791 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
792 for encoded in monitors_encoded {
793 let mut monitor_read = &encoded[..];
794 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
795 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
796 assert!(monitor_read.is_empty());
797 monitors_read.push(monitor);
800 let mut node_read = &chanman_encoded[..];
801 let (_, node_deserialized) = {
802 let mut channel_monitors = HashMap::new();
803 for monitor in monitors_read.iter_mut() {
804 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
806 <(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 {
808 entropy_source: node.keys_manager,
809 node_signer: node.keys_manager,
810 signer_provider: node.keys_manager,
811 fee_estimator: node.fee_estimator,
813 chain_monitor: node.chain_monitor,
814 tx_broadcaster: node.tx_broadcaster,
819 assert!(node_read.is_empty());
821 for monitor in monitors_read.drain(..) {
822 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
823 ChannelMonitorUpdateStatus::Completed);
824 check_added_monitors!(node, 1);
831 macro_rules! reload_node {
832 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
833 let chanman_encoded = $chanman_encoded;
835 $persister = test_utils::TestPersister::new();
836 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
837 $node.chain_monitor = &$new_chain_monitor;
839 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
840 $node.node = &$new_channelmanager;
842 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
843 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
847 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) {
848 let chan_id = *node.network_chan_count.borrow();
850 let events = node.node.get_and_clear_pending_events();
851 assert_eq!(events.len(), 1);
853 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
854 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
855 assert_eq!(*channel_value_satoshis, expected_chan_value);
856 assert_eq!(user_channel_id, expected_user_chan_id);
858 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
859 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
861 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
862 (*temporary_channel_id, tx, funding_outpoint)
864 _ => panic!("Unexpected event"),
867 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 {
868 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
869 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
871 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
872 check_added_monitors!(node_a, 0);
874 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
875 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
876 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
878 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
879 assert_eq!(added_monitors.len(), 1);
880 assert_eq!(added_monitors[0].0, funding_output);
881 added_monitors.clear();
884 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()));
886 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
887 assert_eq!(added_monitors.len(), 1);
888 assert_eq!(added_monitors[0].0, funding_output);
889 added_monitors.clear();
892 let events_4 = node_a.node.get_and_clear_pending_events();
893 assert_eq!(events_4.len(), 0);
895 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
896 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
897 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
899 // Ensure that funding_transaction_generated is idempotent.
900 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
901 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
902 check_added_monitors!(node_a, 0);
907 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
908 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]) {
909 let initiator_channels = initiator.node.list_usable_channels().len();
910 let receiver_channels = receiver.node.list_usable_channels().len();
912 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
913 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
915 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
916 let events = receiver.node.get_and_clear_pending_events();
917 assert_eq!(events.len(), 1);
919 Event::OpenChannelRequest { temporary_channel_id, .. } => {
920 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
922 _ => panic!("Unexpected event"),
925 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
926 assert_eq!(accept_channel.minimum_depth, 0);
927 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
929 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
930 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
931 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
933 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
934 check_added_monitors!(receiver, 1);
935 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
936 assert_eq!(bs_signed_locked.len(), 2);
937 let as_channel_ready;
938 match &bs_signed_locked[0] {
939 MessageSendEvent::SendFundingSigned { node_id, msg } => {
940 assert_eq!(*node_id, initiator.node.get_our_node_id());
941 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
942 check_added_monitors!(initiator, 1);
944 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
945 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
947 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
949 _ => panic!("Unexpected event"),
951 match &bs_signed_locked[1] {
952 MessageSendEvent::SendChannelReady { node_id, msg } => {
953 assert_eq!(*node_id, initiator.node.get_our_node_id());
954 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
956 _ => panic!("Unexpected event"),
959 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
961 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
962 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
964 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
965 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
967 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
968 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
970 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
971 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
973 (tx, as_channel_ready.channel_id)
976 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 {
977 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
978 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
979 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
980 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
981 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
982 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
983 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
984 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
985 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
987 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
990 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) {
991 confirm_transaction_at(node_conf, tx, conf_height);
992 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
993 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()));
996 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]) {
998 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
999 assert_eq!(events_6.len(), 3);
1000 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1001 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1003 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1004 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1006 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1007 ((match events_6[0] {
1008 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1009 channel_id = msg.channel_id.clone();
1010 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1013 _ => panic!("Unexpected event"),
1014 }, match events_6[announcement_sigs_idx] {
1015 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1016 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1019 _ => panic!("Unexpected event"),
1023 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]) {
1024 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1025 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1026 confirm_transaction_at(node_a, tx, conf_height);
1027 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1028 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1029 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1032 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) {
1033 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1034 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1038 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) {
1039 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1040 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1041 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1043 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1044 assert_eq!(events_7.len(), 1);
1045 let (announcement, bs_update) = match events_7[0] {
1046 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1047 (msg, update_msg.clone().unwrap())
1049 _ => panic!("Unexpected event"),
1052 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1053 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1054 assert_eq!(events_8.len(), 1);
1055 let as_update = match events_8[0] {
1056 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1057 assert!(*announcement == *msg);
1058 let update_msg = update_msg.clone().unwrap();
1059 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1060 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1063 _ => panic!("Unexpected event"),
1066 *node_a.network_chan_count.borrow_mut() += 1;
1068 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1069 ((*announcement).clone(), as_update, bs_update)
1072 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) {
1073 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1076 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) {
1077 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1078 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1079 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1082 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) {
1083 let mut no_announce_cfg = test_default_channel_config();
1084 no_announce_cfg.channel_handshake_config.announced_channel = false;
1085 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1086 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1087 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1088 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1089 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1091 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1092 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1093 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()));
1094 check_added_monitors!(nodes[b], 1);
1096 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1097 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1098 check_added_monitors!(nodes[a], 1);
1100 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1101 confirm_transaction_at(&nodes[a], &tx, conf_height);
1102 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1103 confirm_transaction_at(&nodes[b], &tx, conf_height);
1104 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1105 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1106 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()));
1107 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1108 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1109 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1110 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1111 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1113 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1114 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1116 let mut found_a = false;
1117 for chan in nodes[a].node.list_usable_channels() {
1118 if chan.channel_id == as_channel_ready.channel_id {
1121 assert!(!chan.is_public);
1126 let mut found_b = false;
1127 for chan in nodes[b].node.list_usable_channels() {
1128 if chan.channel_id == as_channel_ready.channel_id {
1131 assert!(!chan.is_public);
1136 (as_channel_ready, tx)
1139 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) {
1141 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1142 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1143 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1145 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1146 // forwarding info for local channels even if its not accepted in the network graph.
1147 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1148 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1153 macro_rules! check_spends {
1154 ($tx: expr, $($spends_txn: expr),*) => {
1157 for outp in $spends_txn.output.iter() {
1158 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1161 for outp in $tx.output.iter() {
1162 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1164 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1166 if out_point.txid == $spends_txn.txid() {
1167 return $spends_txn.output.get(out_point.vout as usize).cloned()
1172 let mut total_value_in = 0;
1173 for input in $tx.input.iter() {
1174 total_value_in += get_output(&input.previous_output).unwrap().value;
1176 let mut total_value_out = 0;
1177 for output in $tx.output.iter() {
1178 total_value_out += output.value;
1180 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1181 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1182 assert!(total_value_out + min_fee <= total_value_in);
1183 $tx.verify(get_output).unwrap();
1188 macro_rules! get_closing_signed_broadcast {
1189 ($node: expr, $dest_pubkey: expr) => {
1191 let events = $node.get_and_clear_pending_msg_events();
1192 assert!(events.len() == 1 || events.len() == 2);
1193 (match events[events.len() - 1] {
1194 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1195 assert_eq!(msg.contents.flags & 2, 2);
1198 _ => panic!("Unexpected event"),
1199 }, if events.len() == 2 {
1201 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1202 assert_eq!(*node_id, $dest_pubkey);
1205 _ => panic!("Unexpected event"),
1213 macro_rules! check_warn_msg {
1214 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1215 let msg_events = $node.node.get_and_clear_pending_msg_events();
1216 assert_eq!(msg_events.len(), 1);
1217 match msg_events[0] {
1218 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1219 assert_eq!(node_id, $recipient_node_id);
1220 assert_eq!(msg.channel_id, $chan_id);
1223 _ => panic!("Unexpected event"),
1228 /// Check that a channel's closing channel update has been broadcasted, and optionally
1229 /// check whether an error message event has occurred.
1231 macro_rules! check_closed_broadcast {
1232 ($node: expr, $with_error_msg: expr) => {{
1233 use $crate::util::events::MessageSendEvent;
1234 use $crate::ln::msgs::ErrorAction;
1236 let msg_events = $node.node.get_and_clear_pending_msg_events();
1237 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1238 match msg_events[0] {
1239 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1240 assert_eq!(msg.contents.flags & 2, 2);
1242 _ => panic!("Unexpected event"),
1244 if $with_error_msg {
1245 match msg_events[1] {
1246 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1247 // TODO: Check node_id
1250 _ => panic!("Unexpected event"),
1256 /// Check that a channel's closing channel events has been issued
1258 macro_rules! check_closed_event {
1259 ($node: expr, $events: expr, $reason: expr) => {
1260 check_closed_event!($node, $events, $reason, false);
1262 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1263 use $crate::util::events::Event;
1265 let events = $node.node.get_and_clear_pending_events();
1266 assert_eq!(events.len(), $events, "{:?}", events);
1267 let expected_reason = $reason;
1268 let mut issues_discard_funding = false;
1269 for event in events {
1271 Event::ChannelClosed { ref reason, .. } => {
1272 assert_eq!(*reason, expected_reason);
1274 Event::DiscardFunding { .. } => {
1275 issues_discard_funding = true;
1277 _ => panic!("Unexpected event"),
1280 assert_eq!($is_check_discard_funding, issues_discard_funding);
1284 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) {
1285 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) };
1286 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) };
1289 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1290 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1292 let events_1 = node_b.get_and_clear_pending_msg_events();
1293 assert!(events_1.len() >= 1);
1294 let shutdown_b = match events_1[0] {
1295 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1296 assert_eq!(node_id, &node_a.get_our_node_id());
1299 _ => panic!("Unexpected event"),
1302 let closing_signed_b = if !close_inbound_first {
1303 assert_eq!(events_1.len(), 1);
1306 Some(match events_1[1] {
1307 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1308 assert_eq!(node_id, &node_a.get_our_node_id());
1311 _ => panic!("Unexpected event"),
1315 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1316 let (as_update, bs_update) = if close_inbound_first {
1317 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1318 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1320 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1321 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1322 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1323 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1325 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1326 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1327 assert!(none_a.is_none());
1328 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1329 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1330 (as_update, bs_update)
1332 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1334 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1335 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1337 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1338 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1339 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1341 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1342 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1343 assert!(none_b.is_none());
1344 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1345 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1346 (as_update, bs_update)
1348 assert_eq!(tx_a, tx_b);
1349 check_spends!(tx_a, funding_tx);
1351 (as_update, bs_update, tx_a)
1354 pub struct SendEvent {
1355 pub node_id: PublicKey,
1356 pub msgs: Vec<msgs::UpdateAddHTLC>,
1357 pub commitment_msg: msgs::CommitmentSigned,
1360 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1361 assert!(updates.update_fulfill_htlcs.is_empty());
1362 assert!(updates.update_fail_htlcs.is_empty());
1363 assert!(updates.update_fail_malformed_htlcs.is_empty());
1364 assert!(updates.update_fee.is_none());
1365 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1368 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1370 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1371 _ => panic!("Unexpected event type!"),
1375 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1376 let mut events = node.node.get_and_clear_pending_msg_events();
1377 assert_eq!(events.len(), 1);
1378 SendEvent::from_event(events.pop().unwrap())
1383 macro_rules! expect_pending_htlcs_forwardable_conditions {
1384 ($node: expr, $expected_failures: expr) => {{
1385 let expected_failures = $expected_failures;
1386 let events = $node.node.get_and_clear_pending_events();
1388 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1389 _ => panic!("Unexpected event {:?}", events),
1392 let count = expected_failures.len() + 1;
1393 assert_eq!(events.len(), count);
1395 if expected_failures.len() > 0 {
1396 expect_htlc_handling_failed_destinations!(events, expected_failures)
1402 macro_rules! expect_htlc_handling_failed_destinations {
1403 ($events: expr, $expected_failures: expr) => {{
1404 for event in $events {
1406 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1407 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1408 assert!($expected_failures.contains(&failed_next_destination))
1410 _ => panic!("Unexpected destination"),
1417 /// Clears (and ignores) a PendingHTLCsForwardable event
1418 macro_rules! expect_pending_htlcs_forwardable_ignore {
1420 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1425 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1426 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1427 ($node: expr, $expected_failures: expr) => {{
1428 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1433 /// Handles a PendingHTLCsForwardable event
1434 macro_rules! expect_pending_htlcs_forwardable {
1436 expect_pending_htlcs_forwardable_ignore!($node);
1437 $node.node.process_pending_htlc_forwards();
1439 // Ensure process_pending_htlc_forwards is idempotent.
1440 $node.node.process_pending_htlc_forwards();
1445 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1446 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1447 ($node: expr, $expected_failures: expr) => {{
1448 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1449 $node.node.process_pending_htlc_forwards();
1451 // Ensure process_pending_htlc_forwards is idempotent.
1452 $node.node.process_pending_htlc_forwards();
1457 macro_rules! expect_pending_htlcs_forwardable_from_events {
1458 ($node: expr, $events: expr, $ignore: expr) => {{
1459 assert_eq!($events.len(), 1);
1461 Event::PendingHTLCsForwardable { .. } => { },
1462 _ => panic!("Unexpected event"),
1465 $node.node.process_pending_htlc_forwards();
1467 // Ensure process_pending_htlc_forwards is idempotent.
1468 $node.node.process_pending_htlc_forwards();
1474 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1475 /// commitment update.
1476 macro_rules! commitment_signed_dance {
1477 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1478 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1480 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1481 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1483 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1485 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1486 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1487 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1488 check_added_monitors(&$node_a, 1);
1489 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1490 assert!(extra_msg_option.is_none());
1494 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1496 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1497 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1498 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 1);
1502 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1503 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1505 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1506 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1511 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1512 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1513 check_added_monitors!(node_b, 0);
1514 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1515 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1516 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1517 check_added_monitors!(node_b, 1);
1518 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1519 let (bs_revoke_and_ack, extra_msg_option) = {
1520 let mut events = node_b.node.get_and_clear_pending_msg_events();
1521 assert!(events.len() <= 2);
1522 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1523 (match node_a_event {
1524 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1525 assert_eq!(*node_id, node_a.node.get_our_node_id());
1528 _ => panic!("Unexpected event"),
1529 }, events.get(0).map(|e| e.clone()))
1531 check_added_monitors!(node_b, 1);
1533 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1534 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1536 (extra_msg_option, bs_revoke_and_ack)
1539 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1540 check_added_monitors!(node_a, 0);
1541 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1542 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1543 check_added_monitors!(node_a, 1);
1545 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1547 if skip_last_step { return; }
1550 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1551 vec![crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1552 check_added_monitors!(node_a, 1);
1554 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1555 let mut number_of_msg_events = 0;
1556 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1557 let peer_state = peer_state_mutex.lock().unwrap();
1558 let cp_pending_msg_events = &peer_state.pending_msg_events;
1559 number_of_msg_events += cp_pending_msg_events.len();
1560 if cp_pending_msg_events.len() == 1 {
1561 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1562 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1563 } else { panic!("Unexpected event"); }
1566 // Expecting the failure backwards event to the previous hop (not `node_b`)
1567 assert_eq!(number_of_msg_events, 1);
1569 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1573 /// Get a payment preimage and hash.
1574 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1575 let mut payment_count = recipient.network_payment_count.borrow_mut();
1576 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1577 *payment_count += 1;
1578 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1579 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1580 (payment_preimage, payment_hash, payment_secret)
1583 /// Get a payment preimage and hash.
1585 /// Don't use this, use the identically-named function instead.
1587 macro_rules! get_payment_preimage_hash {
1588 ($dest_node: expr) => {
1589 get_payment_preimage_hash!($dest_node, None)
1591 ($dest_node: expr, $min_value_msat: expr) => {
1592 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1594 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1595 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1599 /// Gets a route from the given sender to the node described in `payment_params`.
1600 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64, final_cltv_expiry_delta: u32) -> Result<Route, msgs::LightningError> {
1601 let scorer = TestScorer::new();
1602 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1603 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1605 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1606 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1607 recv_value, final_cltv_expiry_delta, send_node.logger, &scorer, &random_seed_bytes
1611 /// Gets a route from the given sender to the node described in `payment_params`.
1613 /// Don't use this, use the identically-named function instead.
1615 macro_rules! get_route {
1616 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {
1617 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv)
1623 macro_rules! get_route_and_payment_hash {
1624 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1625 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1626 .with_features($recv_node.node.invoice_features());
1627 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1629 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1630 let (payment_preimage, payment_hash, payment_secret) =
1631 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1632 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv);
1633 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1638 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1639 macro_rules! expect_payment_claimable {
1640 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1641 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1643 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1644 let events = $node.node.get_and_clear_pending_events();
1645 assert_eq!(events.len(), 1);
1647 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1648 assert_eq!($expected_payment_hash, *payment_hash);
1649 assert_eq!($expected_recv_value, amount_msat);
1650 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1652 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1653 assert_eq!(&$expected_payment_preimage, payment_preimage);
1654 assert_eq!($expected_payment_secret, *payment_secret);
1659 _ => panic!("Unexpected event"),
1665 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1666 macro_rules! expect_payment_claimed {
1667 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1668 let events = $node.node.get_and_clear_pending_events();
1669 assert_eq!(events.len(), 1);
1671 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1672 assert_eq!($expected_payment_hash, *payment_hash);
1673 assert_eq!($expected_recv_value, amount_msat);
1675 _ => panic!("Unexpected event"),
1682 macro_rules! expect_payment_sent_without_paths {
1683 ($node: expr, $expected_payment_preimage: expr) => {
1684 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1686 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1687 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1692 macro_rules! expect_payment_sent {
1693 ($node: expr, $expected_payment_preimage: expr) => {
1694 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1696 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1697 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1699 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1700 use bitcoin::hashes::Hash as _;
1701 let events = $node.node.get_and_clear_pending_events();
1702 let expected_payment_hash = $crate::ln::PaymentHash(
1703 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1705 assert!(events.len() > 1);
1707 assert_eq!(events.len(), 1);
1709 let expected_payment_id = match events[0] {
1710 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1711 assert_eq!($expected_payment_preimage, *payment_preimage);
1712 assert_eq!(expected_payment_hash, *payment_hash);
1713 assert!(fee_paid_msat.is_some());
1714 if $expected_fee_msat_opt.is_some() {
1715 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1719 _ => panic!("Unexpected event"),
1722 for i in 1..events.len() {
1724 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1725 assert_eq!(payment_id, expected_payment_id);
1726 assert_eq!(payment_hash, Some(expected_payment_hash));
1728 _ => panic!("Unexpected event"),
1737 macro_rules! expect_payment_path_successful {
1739 let events = $node.node.get_and_clear_pending_events();
1740 assert_eq!(events.len(), 1);
1742 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1743 _ => panic!("Unexpected event"),
1748 macro_rules! expect_payment_forwarded {
1749 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1750 let events = $node.node.get_and_clear_pending_events();
1751 assert_eq!(events.len(), 1);
1753 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1754 assert_eq!(fee_earned_msat, $expected_fee);
1755 if fee_earned_msat.is_some() {
1756 // Is the event prev_channel_id in one of the channels between the two nodes?
1757 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()));
1759 // We check for force closures since a force closed channel is removed from the
1760 // node's channel list
1761 if !$downstream_force_closed {
1762 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()));
1764 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1766 _ => panic!("Unexpected event"),
1771 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1772 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1773 let events = node.node.get_and_clear_pending_events();
1774 assert_eq!(events.len(), 1);
1776 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1777 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1779 _ => panic!("Unexpected event"),
1784 pub struct PaymentFailedConditions<'a> {
1785 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1786 pub(crate) expected_blamed_scid: Option<u64>,
1787 pub(crate) expected_blamed_chan_closed: Option<bool>,
1788 pub(crate) expected_mpp_parts_remain: bool,
1791 impl<'a> PaymentFailedConditions<'a> {
1792 pub fn new() -> Self {
1794 expected_htlc_error_data: None,
1795 expected_blamed_scid: None,
1796 expected_blamed_chan_closed: None,
1797 expected_mpp_parts_remain: false,
1800 pub fn mpp_parts_remain(mut self) -> Self {
1801 self.expected_mpp_parts_remain = true;
1804 pub fn blamed_scid(mut self, scid: u64) -> Self {
1805 self.expected_blamed_scid = Some(scid);
1808 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1809 self.expected_blamed_chan_closed = Some(closed);
1812 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1813 self.expected_htlc_error_data = Some((code, data));
1819 macro_rules! expect_payment_failed_with_update {
1820 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1821 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1822 &$node, $expected_payment_hash, $payment_failed_permanently,
1823 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1824 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1829 macro_rules! expect_payment_failed {
1830 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1831 #[allow(unused_mut)]
1832 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1834 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1836 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1840 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1841 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1842 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1844 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
1845 let expected_payment_id = match &payment_failed_events[0] {
1846 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, failure, short_channel_id,
1850 error_data, .. } => {
1851 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
1852 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1853 assert!(retry.is_some(), "expected retry.is_some()");
1854 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1855 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1856 if let Some(scid) = short_channel_id {
1857 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1862 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1863 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1864 if let Some((code, data)) = conditions.expected_htlc_error_data {
1865 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1866 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1870 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1871 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
1873 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
1874 if let Some(scid) = conditions.expected_blamed_scid {
1875 assert_eq!(msg.contents.short_channel_id, scid);
1877 const CHAN_DISABLED_FLAG: u8 = 2;
1878 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1880 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
1881 if let Some(scid) = conditions.expected_blamed_scid {
1882 assert_eq!(*short_channel_id, scid);
1884 assert!(is_permanent);
1886 _ => panic!("Unexpected update type"),
1888 } else { panic!("Expected network update"); }
1893 _ => panic!("Unexpected event"),
1895 if !conditions.expected_mpp_parts_remain {
1896 match &payment_failed_events[1] {
1897 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1898 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1899 assert_eq!(*payment_id, expected_payment_id);
1901 _ => panic!("Unexpected second event"),
1906 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1907 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1908 conditions: PaymentFailedConditions<'e>
1910 let events = node.node.get_and_clear_pending_events();
1911 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
1914 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 {
1915 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1916 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1917 check_added_monitors!(origin_node, expected_paths.len());
1918 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1922 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>) {
1923 let mut payment_event = SendEvent::from_event(ev);
1924 let mut prev_node = origin_node;
1926 for (idx, &node) in expected_path.iter().enumerate() {
1927 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1929 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1930 check_added_monitors!(node, 0);
1931 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1933 expect_pending_htlcs_forwardable!(node);
1935 if idx == expected_path.len() - 1 && clear_recipient_events {
1936 let events_2 = node.node.get_and_clear_pending_events();
1937 if payment_claimable_expected {
1938 assert_eq!(events_2.len(), 1);
1940 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1941 assert_eq!(our_payment_hash, *payment_hash);
1942 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1944 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1945 assert_eq!(expected_preimage, *payment_preimage);
1946 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1948 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1949 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1950 assert!(our_payment_secret.is_none());
1953 assert_eq!(amount_msat, recv_value);
1954 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1955 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1957 _ => panic!("Unexpected event"),
1960 assert!(events_2.is_empty());
1962 } else if idx != expected_path.len() - 1 {
1963 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1964 assert_eq!(events_2.len(), 1);
1965 check_added_monitors!(node, 1);
1966 payment_event = SendEvent::from_event(events_2.remove(0));
1967 assert_eq!(payment_event.msgs.len(), 1);
1974 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>) {
1975 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1978 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) {
1979 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1980 assert_eq!(events.len(), expected_route.len());
1981 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1982 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
1983 // Once we've gotten through all the HTLCs, the last one should result in a
1984 // PaymentClaimable (but each previous one should not!), .
1985 let expect_payment = path_idx == expected_route.len() - 1;
1986 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1990 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) {
1991 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1992 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1993 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1996 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 {
1997 for path in expected_paths.iter() {
1998 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2000 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2002 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2003 assert_eq!(claim_event.len(), 1);
2004 match claim_event[0] {
2005 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2006 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2007 assert_eq!(preimage, our_payment_preimage),
2008 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2009 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2013 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2015 let mut expected_total_fee_msat = 0;
2017 macro_rules! msgs_from_ev {
2020 &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 } } => {
2021 assert!(update_add_htlcs.is_empty());
2022 assert_eq!(update_fulfill_htlcs.len(), 1);
2023 assert!(update_fail_htlcs.is_empty());
2024 assert!(update_fail_malformed_htlcs.is_empty());
2025 assert!(update_fee.is_none());
2026 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2028 _ => panic!("Unexpected event"),
2032 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2033 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2034 assert_eq!(events.len(), expected_paths.len());
2036 if events.len() == 1 {
2037 per_path_msgs.push(msgs_from_ev!(&events[0]));
2039 for expected_path in expected_paths.iter() {
2040 // For MPP payments, we always want the message to the first node in the path.
2041 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2042 per_path_msgs.push(msgs_from_ev!(&ev));
2046 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2047 let mut next_msgs = Some(path_msgs);
2048 let mut expected_next_node = next_hop;
2050 macro_rules! last_update_fulfill_dance {
2051 ($node: expr, $prev_node: expr) => {
2053 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2054 check_added_monitors!($node, 0);
2055 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2056 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2060 macro_rules! mid_update_fulfill_dance {
2061 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2063 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2065 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2066 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2067 .unwrap().lock().unwrap();
2068 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2069 if let Some(prev_config) = channel.prev_config() {
2070 prev_config.forwarding_fee_base_msat
2072 channel.config().forwarding_fee_base_msat
2075 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2076 expected_total_fee_msat += fee as u64;
2077 check_added_monitors!($node, 1);
2078 let new_next_msgs = if $new_msgs {
2079 let events = $node.node.get_and_clear_pending_msg_events();
2080 assert_eq!(events.len(), 1);
2081 let (res, nexthop) = msgs_from_ev!(&events[0]);
2082 expected_next_node = nexthop;
2085 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2088 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2089 next_msgs = new_next_msgs;
2094 let mut prev_node = expected_route.last().unwrap();
2095 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2096 assert_eq!(expected_next_node, node.node.get_our_node_id());
2097 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2098 if next_msgs.is_some() {
2099 // Since we are traversing in reverse, next_node is actually the previous node
2100 let next_node: &Node;
2101 if idx == expected_route.len() - 1 {
2102 next_node = origin_node;
2104 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2106 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2108 assert!(!update_next_msgs);
2109 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2111 if !skip_last && idx == expected_route.len() - 1 {
2112 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2119 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2123 // Ensure that claim_funds is idempotent.
2124 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2125 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2126 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2128 expected_total_fee_msat
2130 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) {
2131 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2133 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2137 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2138 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2141 pub const TEST_FINAL_CLTV: u32 = 70;
2143 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) {
2144 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2145 .with_features(expected_route.last().unwrap().node.invoice_features());
2146 let route = get_route(origin_node, &payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2147 assert_eq!(route.paths.len(), 1);
2148 assert_eq!(route.paths[0].len(), expected_route.len());
2149 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2150 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2153 let res = send_along_route(origin_node, route, expected_route, recv_value);
2154 (res.0, res.1, res.2)
2157 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2158 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2159 .with_features(expected_route.last().unwrap().node.invoice_features());
2160 let network_graph = origin_node.network_graph.read_only();
2161 let scorer = test_utils::TestScorer::new();
2162 let seed = [0u8; 32];
2163 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2164 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2165 let route = router::get_route(
2166 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2167 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2168 assert_eq!(route.paths.len(), 1);
2169 assert_eq!(route.paths[0].len(), expected_route.len());
2170 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2171 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2174 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2175 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 },
2176 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2179 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2180 let res = route_payment(&origin, expected_route, recv_value);
2181 claim_payment(&origin, expected_route, res.0);
2185 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) {
2186 for path in expected_paths.iter() {
2187 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2189 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2190 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2191 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2193 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2196 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) {
2197 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2198 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2200 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2201 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2202 assert_eq!(events.len(), expected_paths.len());
2203 for ev in events.iter() {
2204 let (update_fail, commitment_signed, node_id) = match ev {
2205 &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 } } => {
2206 assert!(update_add_htlcs.is_empty());
2207 assert!(update_fulfill_htlcs.is_empty());
2208 assert_eq!(update_fail_htlcs.len(), 1);
2209 assert!(update_fail_malformed_htlcs.is_empty());
2210 assert!(update_fee.is_none());
2211 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2213 _ => panic!("Unexpected event"),
2215 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2217 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2218 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()));
2220 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2221 let mut next_msgs = Some(path_msgs);
2222 let mut expected_next_node = next_hop;
2223 let mut prev_node = expected_route.last().unwrap();
2225 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2226 assert_eq!(expected_next_node, node.node.get_our_node_id());
2227 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2228 if next_msgs.is_some() {
2229 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2230 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2231 if !update_next_node {
2232 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 }]);
2235 let events = node.node.get_and_clear_pending_msg_events();
2236 if update_next_node {
2237 assert_eq!(events.len(), 1);
2239 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 } } => {
2240 assert!(update_add_htlcs.is_empty());
2241 assert!(update_fulfill_htlcs.is_empty());
2242 assert_eq!(update_fail_htlcs.len(), 1);
2243 assert!(update_fail_malformed_htlcs.is_empty());
2244 assert!(update_fee.is_none());
2245 expected_next_node = node_id.clone();
2246 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2248 _ => panic!("Unexpected event"),
2251 assert!(events.is_empty());
2253 if !skip_last && idx == expected_route.len() - 1 {
2254 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2261 let prev_node = expected_route.first().unwrap();
2262 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2263 check_added_monitors!(origin_node, 0);
2264 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2265 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2266 let events = origin_node.node.get_and_clear_pending_events();
2267 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2269 let expected_payment_id = match events[0] {
2270 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2271 assert_eq!(payment_hash, our_payment_hash);
2272 assert!(payment_failed_permanently);
2273 for (idx, hop) in expected_route.iter().enumerate() {
2274 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2278 _ => panic!("Unexpected event"),
2280 if i == expected_paths.len() - 1 {
2282 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2283 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2284 assert_eq!(*payment_id, expected_payment_id);
2286 _ => panic!("Unexpected second event"),
2292 // Ensure that fail_htlc_backwards is idempotent.
2293 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2294 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2295 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2296 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2299 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2300 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2303 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2304 let mut chan_mon_cfgs = Vec::new();
2305 for i in 0..node_count {
2306 let tx_broadcaster = test_utils::TestBroadcaster {
2307 txn_broadcasted: Mutex::new(Vec::new()),
2308 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2310 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2311 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2312 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2313 let persister = test_utils::TestPersister::new();
2314 let seed = [i as u8; 32];
2315 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2316 let scorer = Mutex::new(test_utils::TestScorer::new());
2318 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2324 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2325 let mut nodes = Vec::new();
2327 for i in 0..node_count {
2328 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);
2329 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2330 let seed = [i as u8; 32];
2331 nodes.push(NodeCfg {
2332 chain_source: &chanmon_cfgs[i].chain_source,
2333 logger: &chanmon_cfgs[i].logger,
2334 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2335 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2336 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2338 keys_manager: &chanmon_cfgs[i].keys_manager,
2341 override_init_features: Rc::new(RefCell::new(None)),
2348 pub fn test_default_channel_config() -> UserConfig {
2349 let mut default_config = UserConfig::default();
2350 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2351 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2352 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2353 default_config.channel_handshake_config.announced_channel = true;
2354 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2355 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2356 // It now defaults to 1, so we simply set it to the expected value here.
2357 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2358 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2359 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2360 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2364 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>> {
2365 let mut chanmgrs = Vec::new();
2366 for i in 0..node_count {
2367 let network = Network::Testnet;
2368 let params = ChainParameters {
2370 best_block: BestBlock::from_network(network),
2372 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,
2373 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);
2374 chanmgrs.push(node);
2380 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>> {
2381 let mut nodes = Vec::new();
2382 let chan_count = Rc::new(RefCell::new(0));
2383 let payment_count = Rc::new(RefCell::new(0));
2384 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2386 for i in 0..node_count {
2387 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2389 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2390 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2391 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2392 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2393 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2394 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2395 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2396 connect_style: Rc::clone(&connect_style),
2397 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2401 for i in 0..node_count {
2402 for j in (i+1)..node_count {
2403 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();
2404 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();
2411 // Note that the following only works for CLTV values up to 128
2412 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2414 #[derive(PartialEq)]
2415 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2416 /// Tests that the given node has broadcast transactions for the given Channel
2418 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2419 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2420 /// broadcast and the revoked outputs were claimed.
2422 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2423 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2425 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2427 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> {
2428 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2429 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2431 let mut res = Vec::with_capacity(2);
2432 node_txn.retain(|tx| {
2433 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2434 check_spends!(tx, chan.3);
2435 if commitment_tx.is_none() {
2436 res.push(tx.clone());
2441 if let Some(explicit_tx) = commitment_tx {
2442 res.push(explicit_tx.clone());
2445 assert_eq!(res.len(), 1);
2447 if has_htlc_tx != HTLCType::NONE {
2448 node_txn.retain(|tx| {
2449 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2450 check_spends!(tx, res[0]);
2451 if has_htlc_tx == HTLCType::TIMEOUT {
2452 assert!(tx.lock_time.0 != 0);
2454 assert!(tx.lock_time.0 == 0);
2456 res.push(tx.clone());
2460 assert!(res.len() == 2 || res.len() == 3);
2462 assert_eq!(res[1], res[2]);
2466 assert!(node_txn.is_empty());
2470 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2471 /// HTLC transaction.
2472 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2473 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2474 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2475 // for revoked htlc outputs
2476 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2477 node_txn.retain(|tx| {
2478 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2479 check_spends!(tx, revoked_tx);
2483 node_txn.retain(|tx| {
2484 check_spends!(tx, commitment_revoked_tx);
2487 assert!(node_txn.is_empty());
2490 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2491 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2493 assert!(node_txn.len() >= 1);
2494 assert_eq!(node_txn[0].input.len(), 1);
2495 let mut found_prev = false;
2497 for tx in prev_txn {
2498 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2499 check_spends!(node_txn[0], tx);
2500 let mut iter = node_txn[0].input[0].witness.iter();
2501 iter.next().expect("expected 3 witness items");
2502 iter.next().expect("expected 3 witness items");
2503 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2504 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2510 assert!(found_prev);
2512 let mut res = Vec::new();
2513 mem::swap(&mut *node_txn, &mut res);
2517 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) {
2518 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2519 assert_eq!(events_1.len(), 2);
2520 let as_update = match events_1[0] {
2521 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2524 _ => panic!("Unexpected event"),
2527 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2528 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2529 assert_eq!(msg.data, expected_error);
2530 if needs_err_handle {
2531 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2534 _ => panic!("Unexpected event"),
2537 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2538 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2539 let bs_update = match events_2[0] {
2540 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2543 _ => panic!("Unexpected event"),
2545 if !needs_err_handle {
2547 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2548 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2549 assert_eq!(msg.data, expected_error);
2551 _ => panic!("Unexpected event"),
2556 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2557 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2561 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2562 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2566 macro_rules! get_channel_value_stat {
2567 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2568 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2569 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2570 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2571 chan.get_value_stat()
2575 macro_rules! get_chan_reestablish_msgs {
2576 ($src_node: expr, $dst_node: expr) => {
2578 let mut announcements = $crate::prelude::HashSet::new();
2579 let mut res = Vec::with_capacity(1);
2580 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2581 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2582 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2583 res.push(msg.clone());
2584 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2585 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2586 announcements.insert(msg.contents.short_channel_id);
2588 panic!("Unexpected event")
2591 for chan in $src_node.node.list_channels() {
2592 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2593 if let Some(scid) = chan.short_channel_id {
2594 assert!(announcements.remove(&scid));
2598 assert!(announcements.is_empty());
2604 macro_rules! handle_chan_reestablish_msgs {
2605 ($src_node: expr, $dst_node: expr) => {
2607 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2609 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2611 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2617 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2619 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2622 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2623 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2624 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2626 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2627 had_channel_update = true;
2630 let mut revoke_and_ack = None;
2631 let mut commitment_update = None;
2632 let order = if let Some(ev) = msg_events.get(idx) {
2634 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2635 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2636 revoke_and_ack = Some(msg.clone());
2638 RAACommitmentOrder::RevokeAndACKFirst
2640 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2641 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2642 commitment_update = Some(updates.clone());
2644 RAACommitmentOrder::CommitmentFirst
2646 _ => RAACommitmentOrder::CommitmentFirst,
2649 RAACommitmentOrder::CommitmentFirst
2652 if let Some(ev) = msg_events.get(idx) {
2654 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2655 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2656 assert!(revoke_and_ack.is_none());
2657 revoke_and_ack = Some(msg.clone());
2660 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2661 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2662 assert!(commitment_update.is_none());
2663 commitment_update = Some(updates.clone());
2670 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2671 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2673 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2674 assert!(!had_channel_update);
2677 assert_eq!(msg_events.len(), idx);
2679 (channel_ready, revoke_and_ack, commitment_update, order)
2684 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2685 /// for claims/fails they are separated out.
2686 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)) {
2687 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();
2688 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2689 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();
2690 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2692 if send_channel_ready.0 {
2693 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2695 for reestablish in reestablish_1.iter() {
2696 assert_eq!(reestablish.next_remote_commitment_number, 0);
2699 if send_channel_ready.1 {
2700 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2702 for reestablish in reestablish_2.iter() {
2703 assert_eq!(reestablish.next_remote_commitment_number, 0);
2706 if send_channel_ready.0 || send_channel_ready.1 {
2707 // If we expect any channel_ready's, both sides better have set
2708 // next_holder_commitment_number to 1
2709 for reestablish in reestablish_1.iter() {
2710 assert_eq!(reestablish.next_local_commitment_number, 1);
2712 for reestablish in reestablish_2.iter() {
2713 assert_eq!(reestablish.next_local_commitment_number, 1);
2717 let mut resp_1 = Vec::new();
2718 for msg in reestablish_1 {
2719 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2720 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2722 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2723 check_added_monitors!(node_b, 1);
2725 check_added_monitors!(node_b, 0);
2728 let mut resp_2 = Vec::new();
2729 for msg in reestablish_2 {
2730 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2731 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2733 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2734 check_added_monitors!(node_a, 1);
2736 check_added_monitors!(node_a, 0);
2739 // We don't yet support both needing updates, as that would require a different commitment dance:
2740 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2741 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2742 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2743 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2745 for chan_msgs in resp_1.drain(..) {
2746 if send_channel_ready.0 {
2747 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2748 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2749 if !announcement_event.is_empty() {
2750 assert_eq!(announcement_event.len(), 1);
2751 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2752 //TODO: Test announcement_sigs re-sending
2753 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2756 assert!(chan_msgs.0.is_none());
2759 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2760 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2761 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2762 check_added_monitors!(node_a, 1);
2764 assert!(chan_msgs.1.is_none());
2766 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 {
2767 let commitment_update = chan_msgs.2.unwrap();
2768 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2769 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2771 assert!(commitment_update.update_add_htlcs.is_empty());
2773 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2774 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2775 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2776 for update_add in commitment_update.update_add_htlcs {
2777 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2779 for update_fulfill in commitment_update.update_fulfill_htlcs {
2780 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2782 for update_fail in commitment_update.update_fail_htlcs {
2783 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2786 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2787 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2789 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2790 check_added_monitors!(node_a, 1);
2791 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2792 // No commitment_signed so get_event_msg's assert(len == 1) passes
2793 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2794 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2795 check_added_monitors!(node_b, 1);
2798 assert!(chan_msgs.2.is_none());
2802 for chan_msgs in resp_2.drain(..) {
2803 if send_channel_ready.1 {
2804 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2805 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2806 if !announcement_event.is_empty() {
2807 assert_eq!(announcement_event.len(), 1);
2808 match announcement_event[0] {
2809 MessageSendEvent::SendChannelUpdate { .. } => {},
2810 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2811 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2815 assert!(chan_msgs.0.is_none());
2818 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2819 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2820 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2821 check_added_monitors!(node_b, 1);
2823 assert!(chan_msgs.1.is_none());
2825 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 {
2826 let commitment_update = chan_msgs.2.unwrap();
2827 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2828 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2830 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2831 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2832 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2833 for update_add in commitment_update.update_add_htlcs {
2834 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2836 for update_fulfill in commitment_update.update_fulfill_htlcs {
2837 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2839 for update_fail in commitment_update.update_fail_htlcs {
2840 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2843 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2844 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2846 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2847 check_added_monitors!(node_b, 1);
2848 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2849 // No commitment_signed so get_event_msg's assert(len == 1) passes
2850 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2851 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2852 check_added_monitors!(node_a, 1);
2855 assert!(chan_msgs.2.is_none());