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, chainmonitor::Persist};
14 use crate::chain::channelmonitor::ChannelMonitor;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{ClaimedHTLC, ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
17 use crate::events::bump_transaction::{BumpTransactionEvent, BumpTransactionEventHandler, Wallet, WalletSource};
18 use crate::ln::types::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
19 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
20 use crate::ln::features::InitFeatures;
22 use crate::ln::msgs::{ChannelMessageHandler, OnionMessageHandler, RoutingMessageHandler};
23 use crate::ln::peer_handler::IgnoringMessageHandler;
24 use crate::onion_message::messenger::OnionMessenger;
25 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
26 use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
27 use crate::sign::{EntropySource, RandomBytes};
28 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
29 use crate::util::errors::APIError;
31 use crate::util::logger::Logger;
32 use crate::util::scid_utils;
33 use crate::util::test_channel_signer::TestChannelSigner;
35 use crate::util::test_channel_signer::SignerOp;
36 use crate::util::test_utils;
37 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
38 use crate::util::ser::{ReadableArgs, Writeable};
40 use bitcoin::amount::Amount;
41 use bitcoin::blockdata::block::{Block, Header, Version};
42 use bitcoin::blockdata::locktime::absolute::LockTime;
43 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut};
44 use bitcoin::hash_types::{BlockHash, TxMerkleNode};
45 use bitcoin::hashes::sha256::Hash as Sha256;
46 use bitcoin::hashes::Hash as _;
47 use bitcoin::network::Network;
48 use bitcoin::pow::CompactTarget;
49 use bitcoin::secp256k1::{PublicKey, SecretKey};
50 use bitcoin::transaction;
53 use core::cell::RefCell;
54 use core::iter::repeat;
58 use crate::prelude::*;
59 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
61 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
63 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
64 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
66 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
67 /// output is the 1st output in the transaction.
68 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
69 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
70 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
73 /// Mine a single block containing the given transaction
75 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
76 /// output is the 1st output in the transaction.
77 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
78 let height = node.best_block_info().1 + 1;
79 confirm_transaction_at(node, tx, height)
81 /// Mine a single block containing the given transactions
82 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
83 let height = node.best_block_info().1 + 1;
84 confirm_transactions_at(node, txn, height);
86 /// Mine a single block containing the given transaction without extra consistency checks which may
87 /// impact ChannelManager state.
88 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
89 let height = node.best_block_info().1 + 1;
90 let mut block = Block {
92 version: Version::NO_SOFT_FORK_SIGNALLING,
93 prev_blockhash: node.best_block_hash(),
94 merkle_root: TxMerkleNode::all_zeros(),
96 bits: CompactTarget::from_consensus(42),
101 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
102 block.txdata.push(Transaction { version: transaction::Version(0), lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
104 block.txdata.push((*tx).clone());
105 do_connect_block_without_consistency_checks(node, block, false);
107 /// Mine the given transaction at the given height, mining blocks as required to build to that
110 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
111 /// output is the 1st output in the transaction.
112 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
113 let first_connect_height = node.best_block_info().1 + 1;
114 assert!(first_connect_height <= conf_height);
115 if conf_height > first_connect_height {
116 connect_blocks(node, conf_height - first_connect_height);
118 let mut txdata = Vec::new();
119 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
120 txdata.push(Transaction { version: transaction::Version(0), lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
123 txdata.push((*tx).clone());
125 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
126 connect_block(node, &block);
127 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
129 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
130 confirm_transactions_at(node, &[tx], conf_height)
133 /// The possible ways we may notify a ChannelManager of a new block
134 #[derive(Clone, Copy, Debug, PartialEq)]
135 pub enum ConnectStyle {
136 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
137 /// the header and height information.
139 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
140 /// make a single `best_block_updated` call.
141 BestBlockFirstSkippingBlocks,
142 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
143 /// `transaction_unconfirmed` is called.
144 BestBlockFirstReorgsOnlyTip,
145 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
146 /// the header and height information.
148 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
149 /// make a single `best_block_updated` call.
150 TransactionsFirstSkippingBlocks,
151 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
152 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
153 /// times to ensure it's idempotent.
154 TransactionsDuplicativelyFirstSkippingBlocks,
155 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
156 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
157 /// times to ensure it's idempotent.
158 HighlyRedundantTransactionsFirstSkippingBlocks,
159 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
160 /// `transaction_unconfirmed` is called.
161 TransactionsFirstReorgsOnlyTip,
162 /// Provides the full block via the `chain::Listen` interface. In the current code this is
163 /// equivalent to `TransactionsFirst` with some additional assertions.
168 pub fn skips_blocks(&self) -> bool {
170 ConnectStyle::BestBlockFirst => false,
171 ConnectStyle::BestBlockFirstSkippingBlocks => true,
172 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
173 ConnectStyle::TransactionsFirst => false,
174 ConnectStyle::TransactionsFirstSkippingBlocks => true,
175 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
176 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
177 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
178 ConnectStyle::FullBlockViaListen => false,
182 pub fn updates_best_block_first(&self) -> bool {
184 ConnectStyle::BestBlockFirst => true,
185 ConnectStyle::BestBlockFirstSkippingBlocks => true,
186 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
187 ConnectStyle::TransactionsFirst => false,
188 ConnectStyle::TransactionsFirstSkippingBlocks => false,
189 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
190 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
191 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
192 ConnectStyle::FullBlockViaListen => false,
196 fn random_style() -> ConnectStyle {
197 #[cfg(feature = "std")] {
198 use core::hash::{BuildHasher, Hasher};
199 // Get a random value using the only std API to do so - the DefaultHasher
200 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
201 let res = match rand_val % 9 {
202 0 => ConnectStyle::BestBlockFirst,
203 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
204 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
205 3 => ConnectStyle::TransactionsFirst,
206 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
207 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
208 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
209 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
210 8 => ConnectStyle::FullBlockViaListen,
213 eprintln!("Using Block Connection Style: {:?}", res);
216 #[cfg(not(feature = "std"))] {
217 ConnectStyle::FullBlockViaListen
222 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> Header {
224 version: Version::NO_SOFT_FORK_SIGNALLING,
226 merkle_root: TxMerkleNode::all_zeros(),
228 bits: CompactTarget::from_consensus(42),
233 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
234 Block { header: create_dummy_header(prev_blockhash, time), txdata }
237 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
238 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
240 let height = node.best_block_info().1 + 1;
241 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
244 let prev_blockhash = block.header.block_hash();
245 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
246 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
248 let hash = block.header.block_hash();
249 do_connect_block_with_consistency_checks(node, block, false);
253 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
254 do_connect_block_with_consistency_checks(node, block.clone(), false);
257 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
258 // Ensure `get_claimable_balances`' self-tests never panic
259 for (funding_outpoint, _channel_id) in node.chain_monitor.chain_monitor.list_monitors() {
260 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
264 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
265 call_claimable_balances(node);
266 do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
267 call_claimable_balances(node);
268 node.node.test_process_background_events();
271 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
272 let height = node.best_block_info().1 + 1;
273 #[cfg(feature = "std")] {
274 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
276 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
277 // transaction broadcast are correct.
278 node.blocks.lock().unwrap().push((block.clone(), height));
279 if !skip_intermediaries {
280 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
281 match *node.connect_style.borrow() {
282 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
283 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
284 call_claimable_balances(node);
285 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
286 node.node.best_block_updated(&block.header, height);
287 node.node.transactions_confirmed(&block.header, &txdata, height);
289 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
290 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
291 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
292 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
293 let mut connections = Vec::new();
294 for (block, height) in node.blocks.lock().unwrap().iter() {
295 if !block.txdata.is_empty() {
296 // Reconnect all transactions we've ever seen to ensure transaction connection
297 // is *really* idempotent. This is a somewhat likely deployment for some
298 // esplora implementations of chain sync which try to reduce state and
299 // complexity as much as possible.
301 // Sadly we have to clone the block here to maintain lockorder. In the
302 // future we should consider Arc'ing the blocks to avoid this.
303 connections.push((block.clone(), *height));
306 for (old_block, height) in connections {
307 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
308 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
311 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
312 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
313 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
315 call_claimable_balances(node);
316 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
317 node.node.transactions_confirmed(&block.header, &txdata, height);
318 node.node.best_block_updated(&block.header, height);
320 ConnectStyle::FullBlockViaListen => {
321 node.chain_monitor.chain_monitor.block_connected(&block, height);
322 node.node.block_connected(&block, height);
327 for tx in &block.txdata {
328 for input in &tx.input {
329 node.wallet_source.remove_utxo(input.previous_output);
331 let wallet_script = node.wallet_source.get_change_script().unwrap();
332 for (idx, output) in tx.output.iter().enumerate() {
333 if output.script_pubkey == wallet_script {
334 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
335 node.wallet_source.add_utxo(outpoint, output.value);
341 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
342 call_claimable_balances(node);
343 #[cfg(feature = "std")] {
344 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
347 let orig = node.blocks.lock().unwrap().pop().unwrap();
348 assert!(orig.1 > 0); // Cannot disconnect genesis
349 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
351 match *node.connect_style.borrow() {
352 ConnectStyle::FullBlockViaListen => {
353 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
354 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
356 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
357 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
359 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
360 node.node.best_block_updated(&prev.0.header, prev.1);
363 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
364 for tx in orig.0.txdata {
365 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
366 node.node.transaction_unconfirmed(&tx.txid());
370 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
371 node.node.best_block_updated(&prev.0.header, prev.1);
374 call_claimable_balances(node);
378 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
379 let count = node.blocks.lock().unwrap().len() as u32 - 1;
380 disconnect_blocks(node, count);
383 pub struct TestChanMonCfg {
384 pub tx_broadcaster: test_utils::TestBroadcaster,
385 pub fee_estimator: test_utils::TestFeeEstimator,
386 pub chain_source: test_utils::TestChainSource,
387 pub persister: test_utils::TestPersister,
388 pub logger: test_utils::TestLogger,
389 pub keys_manager: test_utils::TestKeysInterface,
390 pub scorer: RwLock<test_utils::TestScorer>,
393 pub struct NodeCfg<'a> {
394 pub chain_source: &'a test_utils::TestChainSource,
395 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
396 pub fee_estimator: &'a test_utils::TestFeeEstimator,
397 pub router: test_utils::TestRouter<'a>,
398 pub message_router: test_utils::TestMessageRouter<'a>,
399 pub chain_monitor: test_utils::TestChainMonitor<'a>,
400 pub keys_manager: &'a test_utils::TestKeysInterface,
401 pub logger: &'a test_utils::TestLogger,
402 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
403 pub node_seed: [u8; 32],
404 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
407 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
408 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
409 &'chan_mon_cfg test_utils::TestBroadcaster,
410 &'node_cfg test_utils::TestKeysInterface,
411 &'node_cfg test_utils::TestKeysInterface,
412 &'node_cfg test_utils::TestKeysInterface,
413 &'chan_mon_cfg test_utils::TestFeeEstimator,
414 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
415 &'chan_mon_cfg test_utils::TestLogger,
418 type TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg> = OnionMessenger<
420 &'node_cfg test_utils::TestKeysInterface,
421 &'chan_mon_cfg test_utils::TestLogger,
422 &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
423 &'node_cfg test_utils::TestMessageRouter<'chan_mon_cfg>,
424 &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
425 IgnoringMessageHandler,
428 /// For use with [`OnionMessenger`] otherwise `test_restored_packages_retry` will fail. This is
429 /// because that test uses older serialized data produced by calling [`EntropySource`] in a specific
430 /// manner. Using the same [`EntropySource`] with [`OnionMessenger`] would introduce another call,
431 /// causing the produced data to no longer match.
432 pub struct DedicatedEntropy(RandomBytes);
434 impl Deref for DedicatedEntropy {
435 type Target = RandomBytes;
436 fn deref(&self) -> &Self::Target { &self.0 }
439 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
440 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
441 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
442 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
443 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
444 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
445 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
446 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
447 pub onion_messenger: TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg>,
448 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
449 pub gossip_sync: P2PGossipSync<&'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>, &'chan_mon_cfg test_utils::TestChainSource, &'chan_mon_cfg test_utils::TestLogger>,
450 pub node_seed: [u8; 32],
451 pub network_payment_count: Rc<RefCell<u8>>,
452 pub network_chan_count: Rc<RefCell<u32>>,
453 pub logger: &'chan_mon_cfg test_utils::TestLogger,
454 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
455 pub connect_style: Rc<RefCell<ConnectStyle>>,
456 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
457 pub wallet_source: Arc<test_utils::TestWalletSource>,
458 pub bump_tx_handler: BumpTransactionEventHandler<
459 &'chan_mon_cfg test_utils::TestBroadcaster,
460 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
461 &'chan_mon_cfg test_utils::TestKeysInterface,
462 &'chan_mon_cfg test_utils::TestLogger,
466 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
467 pub fn init_features(&self, peer_node_id: &PublicKey) -> InitFeatures {
468 self.override_init_features.borrow().clone()
469 .unwrap_or_else(|| self.node.init_features() | self.onion_messenger.provided_init_features(peer_node_id))
473 #[cfg(feature = "std")]
474 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
475 #[cfg(feature = "std")]
476 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
477 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
478 pub fn best_block_hash(&self) -> BlockHash {
479 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
481 pub fn best_block_info(&self) -> (BlockHash, u32) {
482 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
484 pub fn get_block_header(&self, height: u32) -> Header {
485 self.blocks.lock().unwrap()[height as usize].0.header
488 /// Toggles this node's signer to be available for the given signer operation.
489 /// This is useful for testing behavior for restoring an async signer that previously
490 /// could not return a signature immediately.
492 pub fn enable_channel_signer_op(&self, peer_id: &PublicKey, chan_id: &ChannelId, signer_op: SignerOp) {
493 self.set_channel_signer_ops(peer_id, chan_id, signer_op, true);
496 /// Toggles this node's signer to be unavailable, returning `Err` for the given signer operation.
497 /// This is useful for testing behavior for an async signer that cannot return a signature
500 pub fn disable_channel_signer_op(&self, peer_id: &PublicKey, chan_id: &ChannelId, signer_op: SignerOp) {
501 self.set_channel_signer_ops(peer_id, chan_id, signer_op, false);
504 /// Changes the channel signer's availability for the specified peer, channel, and signer
507 /// For the specified signer operation, when `available` is set to `true`, the channel signer
508 /// will behave normally, returning `Ok`. When set to `false`, and the channel signer will
509 /// act like an off-line remote signer, returning `Err`. This applies to the signer in all
510 /// relevant places, i.e. the channel manager, chain monitor, and the keys manager.
512 fn set_channel_signer_ops(&self, peer_id: &PublicKey, chan_id: &ChannelId, signer_op: SignerOp, available: bool) {
513 use crate::sign::ChannelSigner;
514 log_debug!(self.logger, "Setting channel signer for {} as available={}", chan_id, available);
516 let per_peer_state = self.node.per_peer_state.read().unwrap();
517 let mut chan_lock = per_peer_state.get(peer_id).unwrap().lock().unwrap();
519 let mut channel_keys_id = None;
520 if let Some(chan) = chan_lock.channel_by_id.get_mut(chan_id).map(|phase| phase.context_mut()) {
521 let signer = chan.get_mut_signer().as_mut_ecdsa().unwrap();
523 signer.enable_op(signer_op);
525 signer.disable_op(signer_op);
527 channel_keys_id = Some(chan.channel_keys_id);
530 let monitor = self.chain_monitor.chain_monitor.list_monitors().into_iter()
531 .find(|(_, channel_id)| *channel_id == *chan_id)
532 .and_then(|(funding_txo, _)| self.chain_monitor.chain_monitor.get_monitor(funding_txo).ok());
533 if let Some(monitor) = monitor {
534 monitor.do_mut_signer_call(|signer| {
535 channel_keys_id = channel_keys_id.or(Some(signer.inner.channel_keys_id()));
537 signer.enable_op(signer_op);
539 signer.disable_op(signer_op);
544 let channel_keys_id = channel_keys_id.unwrap();
545 let mut unavailable_signers_ops = self.keys_manager.unavailable_signers_ops.lock().unwrap();
546 let entry = unavailable_signers_ops.entry(channel_keys_id).or_insert(new_hash_set());
548 entry.remove(&signer_op);
549 if entry.is_empty() {
550 unavailable_signers_ops.remove(&channel_keys_id);
553 entry.insert(signer_op);
558 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
559 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
560 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
562 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
564 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
565 Self((node as *const Node<'a, 'b, 'c>).cast())
568 unsafe impl Send for NodePtr {}
569 unsafe impl Sync for NodePtr {}
572 pub trait NodeHolder {
573 type CM: AChannelManager;
574 fn node(&self) -> &ChannelManager<
575 <Self::CM as AChannelManager>::M,
576 <Self::CM as AChannelManager>::T,
577 <Self::CM as AChannelManager>::ES,
578 <Self::CM as AChannelManager>::NS,
579 <Self::CM as AChannelManager>::SP,
580 <Self::CM as AChannelManager>::F,
581 <Self::CM as AChannelManager>::R,
582 <Self::CM as AChannelManager>::L>;
583 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
585 impl<H: NodeHolder> NodeHolder for &H {
587 fn node(&self) -> &ChannelManager<
588 <Self::CM as AChannelManager>::M,
589 <Self::CM as AChannelManager>::T,
590 <Self::CM as AChannelManager>::ES,
591 <Self::CM as AChannelManager>::NS,
592 <Self::CM as AChannelManager>::SP,
593 <Self::CM as AChannelManager>::F,
594 <Self::CM as AChannelManager>::R,
595 <Self::CM as AChannelManager>::L> { (*self).node() }
596 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
598 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
599 type CM = TestChannelManager<'b, 'c>;
600 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
601 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
604 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
607 // Check that we processed all pending events
608 let msg_events = self.node.get_and_clear_pending_msg_events();
609 if !msg_events.is_empty() {
610 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
612 let events = self.node.get_and_clear_pending_events();
613 if !events.is_empty() {
614 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
616 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
617 if !added_monitors.is_empty() {
618 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
621 // Check that if we serialize the network graph, we can deserialize it again.
622 let network_graph = {
623 let mut w = test_utils::TestVecWriter(Vec::new());
624 self.network_graph.write(&mut w).unwrap();
625 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
626 assert!(network_graph_deser == *self.network_graph);
627 let gossip_sync = P2PGossipSync::new(
628 &network_graph_deser, Some(self.chain_source), self.logger
630 let mut chan_progress = 0;
632 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
633 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
634 assert!(orig_announcements == deserialized_announcements);
635 chan_progress = match orig_announcements {
636 Some(announcement) => announcement.0.contents.short_channel_id + 1,
640 let mut node_progress = None;
642 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
643 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
644 assert!(orig_announcements == deserialized_announcements);
645 node_progress = match orig_announcements {
646 Some(announcement) => Some(announcement.contents.node_id),
653 // Check that if we serialize and then deserialize all our channel monitors we get the
654 // same set of outputs to watch for on chain as we have now. Note that if we write
655 // tests that fully close channels and remove the monitors at some point this may break.
656 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
657 let mut deserialized_monitors = Vec::new();
659 for (outpoint, _channel_id) in self.chain_monitor.chain_monitor.list_monitors() {
660 let mut w = test_utils::TestVecWriter(Vec::new());
661 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
662 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
663 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
664 deserialized_monitors.push(deserialized_monitor);
668 let broadcaster = test_utils::TestBroadcaster {
669 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
670 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
673 // Before using all the new monitors to check the watch outpoints, use the full set of
674 // them to ensure we can write and reload our ChannelManager.
676 let mut channel_monitors = new_hash_map();
677 for monitor in deserialized_monitors.iter_mut() {
678 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
681 let scorer = RwLock::new(test_utils::TestScorer::new());
682 let mut w = test_utils::TestVecWriter(Vec::new());
683 self.node.write(&mut w).unwrap();
684 <(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 {
685 default_config: *self.node.get_current_default_configuration(),
686 entropy_source: self.keys_manager,
687 node_signer: self.keys_manager,
688 signer_provider: self.keys_manager,
689 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
690 router: &test_utils::TestRouter::new(Arc::new(network_graph), &self.logger, &scorer),
691 chain_monitor: self.chain_monitor,
692 tx_broadcaster: &broadcaster,
693 logger: &self.logger,
698 let persister = test_utils::TestPersister::new();
699 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
700 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
701 for deserialized_monitor in deserialized_monitors.drain(..) {
702 let funding_outpoint = deserialized_monitor.get_funding_txo().0;
703 if chain_monitor.watch_channel(funding_outpoint, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
707 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
708 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
713 pub fn create_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
714 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
717 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c: 'd, '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, ChannelId, Transaction) {
718 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
719 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
720 (announcement, as_update, bs_update, channel_id, tx)
723 /// Gets an RAA and CS which were sent in response to a commitment update
724 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
725 let events = node.node().get_and_clear_pending_msg_events();
726 assert_eq!(events.len(), 2);
728 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
729 assert_eq!(node_id, recipient);
732 _ => panic!("Unexpected event"),
734 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
735 assert_eq!(node_id, recipient);
736 assert!(updates.update_add_htlcs.is_empty());
737 assert!(updates.update_fulfill_htlcs.is_empty());
738 assert!(updates.update_fail_htlcs.is_empty());
739 assert!(updates.update_fail_malformed_htlcs.is_empty());
740 assert!(updates.update_fee.is_none());
741 updates.commitment_signed.clone()
743 _ => panic!("Unexpected event"),
748 /// Gets an RAA and CS which were sent in response to a commitment update
750 /// Don't use this, use the identically-named function instead.
751 macro_rules! get_revoke_commit_msgs {
752 ($node: expr, $node_id: expr) => {
753 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
757 /// Get an specific event message from the pending events queue.
759 macro_rules! get_event_msg {
760 ($node: expr, $event_type: path, $node_id: expr) => {
762 let events = $node.node.get_and_clear_pending_msg_events();
763 assert_eq!(events.len(), 1);
765 $event_type { ref node_id, ref msg } => {
766 assert_eq!(*node_id, $node_id);
769 _ => panic!("Unexpected event"),
775 /// Get an error message from the pending events queue.
776 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
777 let events = node.node.get_and_clear_pending_msg_events();
778 assert_eq!(events.len(), 1);
780 MessageSendEvent::HandleError {
781 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
783 assert_eq!(node_id, recipient);
786 MessageSendEvent::HandleError {
787 action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
789 assert_eq!(node_id, recipient);
790 msg.as_ref().unwrap().clone()
792 _ => panic!("Unexpected event"),
796 /// Get a specific event from the pending events queue.
798 macro_rules! get_event {
799 ($node: expr, $event_type: path) => {
801 let mut events = $node.node.get_and_clear_pending_events();
802 assert_eq!(events.len(), 1);
803 let ev = events.pop().unwrap();
805 $event_type { .. } => {
808 _ => panic!("Unexpected event"),
814 /// Gets an UpdateHTLCs MessageSendEvent
815 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
816 let events = node.node.get_and_clear_pending_msg_events();
817 assert_eq!(events.len(), 1);
819 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
820 assert_eq!(node_id, recipient);
823 _ => panic!("Unexpected event"),
828 /// Gets an UpdateHTLCs MessageSendEvent
830 /// Don't use this, use the identically-named function instead.
831 macro_rules! get_htlc_update_msgs {
832 ($node: expr, $node_id: expr) => {
833 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
837 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
838 /// Returns the `msg_event`.
840 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
841 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
842 /// such messages are intended to all peers.
843 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
844 let ev_index = msg_events.iter().position(|e| { match e {
845 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
846 node_id == msg_node_id
848 MessageSendEvent::SendOpenChannel { node_id, .. } => {
849 node_id == msg_node_id
851 MessageSendEvent::SendFundingCreated { node_id, .. } => {
852 node_id == msg_node_id
854 MessageSendEvent::SendFundingSigned { node_id, .. } => {
855 node_id == msg_node_id
857 MessageSendEvent::SendChannelReady { node_id, .. } => {
858 node_id == msg_node_id
860 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
861 node_id == msg_node_id
863 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
864 node_id == msg_node_id
866 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
867 node_id == msg_node_id
869 MessageSendEvent::SendClosingSigned { node_id, .. } => {
870 node_id == msg_node_id
872 MessageSendEvent::SendShutdown { node_id, .. } => {
873 node_id == msg_node_id
875 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
876 node_id == msg_node_id
878 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
879 node_id == msg_node_id
881 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
884 MessageSendEvent::BroadcastChannelUpdate { .. } => {
887 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
890 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
891 node_id == msg_node_id
893 MessageSendEvent::HandleError { node_id, .. } => {
894 node_id == msg_node_id
896 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
897 node_id == msg_node_id
899 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
900 node_id == msg_node_id
902 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
903 node_id == msg_node_id
905 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
906 node_id == msg_node_id
908 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
909 node_id == msg_node_id
911 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
912 node_id == msg_node_id
914 MessageSendEvent::SendStfu { node_id, .. } => {
915 node_id == msg_node_id
917 MessageSendEvent::SendSplice { node_id, .. } => {
918 node_id == msg_node_id
920 MessageSendEvent::SendSpliceAck { node_id, .. } => {
921 node_id == msg_node_id
923 MessageSendEvent::SendSpliceLocked { node_id, .. } => {
924 node_id == msg_node_id
926 MessageSendEvent::SendTxAddInput { node_id, .. } => {
927 node_id == msg_node_id
929 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
930 node_id == msg_node_id
932 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
933 node_id == msg_node_id
935 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
936 node_id == msg_node_id
938 MessageSendEvent::SendTxComplete { node_id, .. } => {
939 node_id == msg_node_id
941 MessageSendEvent::SendTxSignatures { node_id, .. } => {
942 node_id == msg_node_id
944 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
945 node_id == msg_node_id
947 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
948 node_id == msg_node_id
950 MessageSendEvent::SendTxAbort { node_id, .. } => {
951 node_id == msg_node_id
954 if ev_index.is_some() {
955 msg_events.remove(ev_index.unwrap())
957 panic!("Couldn't find any MessageSendEvent to the node!")
962 macro_rules! get_channel_ref {
963 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
965 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
966 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
967 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
973 macro_rules! get_feerate {
974 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
976 let mut per_peer_state_lock;
977 let mut peer_state_lock;
978 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
979 phase.context().get_feerate_sat_per_1000_weight()
985 macro_rules! get_channel_type_features {
986 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
988 let mut per_peer_state_lock;
989 let mut peer_state_lock;
990 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
991 chan.context().get_channel_type().clone()
996 /// Returns a channel monitor given a channel id, making some naive assumptions
998 macro_rules! get_monitor {
999 ($node: expr, $channel_id: expr) => {
1001 use bitcoin::hashes::Hash;
1002 let mut monitor = None;
1003 // Assume funding vout is either 0 or 1 blindly
1005 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
1006 $crate::chain::transaction::OutPoint {
1007 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
1010 monitor = Some(mon);
1019 /// Returns any local commitment transactions for the channel.
1021 macro_rules! get_local_commitment_txn {
1022 ($node: expr, $channel_id: expr) => {
1024 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
1029 /// Check the error from attempting a payment.
1031 macro_rules! unwrap_send_err {
1032 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
1034 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
1035 assert_eq!(fails.len(), 1);
1037 $type => { $check },
1041 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
1042 assert_eq!(results.len(), 1);
1044 Err($type) => { $check },
1048 &Err(PaymentSendFailure::PathParameterError(ref result)) if !$all_failed => {
1049 assert_eq!(result.len(), 1);
1051 Err($type) => { $check },
1060 /// Check whether N channel monitor(s) have been added.
1061 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
1062 if let Some(chain_monitor) = node.chain_monitor() {
1063 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
1064 let n = added_monitors.len();
1065 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
1066 added_monitors.clear();
1070 /// Check whether N channel monitor(s) have been added.
1072 /// Don't use this, use the identically-named function instead.
1074 macro_rules! check_added_monitors {
1075 ($node: expr, $count: expr) => {
1076 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
1080 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
1082 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
1083 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
1084 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
1085 let mut nodes = path.iter().rev();
1086 let dest = nodes.next().expect("path should have a destination").node;
1087 let prev = nodes.next().unwrap_or(&origin_node).node;
1088 let dest_channels = dest.list_channels();
1089 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
1090 .expect("HTLC's channel should be one of destination node's channels");
1091 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
1092 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
1095 pub fn _reload_node<'a, 'b, 'c>(node: &'a Node<'a, 'b, 'c>, default_config: UserConfig, chanman_encoded: &[u8], monitors_encoded: &[&[u8]]) -> TestChannelManager<'b, 'c> {
1096 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1097 for encoded in monitors_encoded {
1098 let mut monitor_read = &encoded[..];
1099 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1100 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1101 assert!(monitor_read.is_empty());
1102 monitors_read.push(monitor);
1105 let mut node_read = &chanman_encoded[..];
1106 let (_, node_deserialized) = {
1107 let mut channel_monitors = new_hash_map();
1108 for monitor in monitors_read.iter_mut() {
1109 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1111 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1113 entropy_source: node.keys_manager,
1114 node_signer: node.keys_manager,
1115 signer_provider: node.keys_manager,
1116 fee_estimator: node.fee_estimator,
1117 router: node.router,
1118 chain_monitor: node.chain_monitor,
1119 tx_broadcaster: node.tx_broadcaster,
1120 logger: node.logger,
1124 assert!(node_read.is_empty());
1126 for monitor in monitors_read.drain(..) {
1127 let funding_outpoint = monitor.get_funding_txo().0;
1128 assert_eq!(node.chain_monitor.watch_channel(funding_outpoint, monitor),
1129 Ok(ChannelMonitorUpdateStatus::Completed));
1130 check_added_monitors!(node, 1);
1137 macro_rules! reload_node {
1138 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1139 let chanman_encoded = $chanman_encoded;
1141 $persister = test_utils::TestPersister::new();
1142 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1143 $node.chain_monitor = &$new_chain_monitor;
1145 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1146 $node.node = &$new_channelmanager;
1147 $node.onion_messenger.set_offers_handler(&$new_channelmanager);
1149 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1150 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1154 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1155 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1156 -> (ChannelId, Transaction, OutPoint)
1158 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1161 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1162 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1163 -> (ChannelId, Transaction, OutPoint)
1165 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1168 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1169 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1170 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1171 let chan_id = *node.network_chan_count.borrow();
1173 let events = node.node.get_and_clear_pending_events();
1174 assert_eq!(events.len(), 1);
1176 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1177 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1178 assert_eq!(*channel_value_satoshis, expected_chan_value);
1179 assert_eq!(user_channel_id, expected_user_chan_id);
1181 let input = if coinbase {
1183 previous_output: bitcoin::OutPoint::null(),
1184 ..Default::default()
1190 let tx = Transaction { version: transaction::Version(chan_id as i32), lock_time: LockTime::ZERO, input, output: vec![TxOut {
1191 value: Amount::from_sat(*channel_value_satoshis), script_pubkey: output_script.clone(),
1193 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1194 (*temporary_channel_id, tx, funding_outpoint)
1196 _ => panic!("Unexpected event"),
1200 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: ChannelId) -> Transaction {
1201 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1202 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1204 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1205 check_added_monitors!(node_a, 0);
1207 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1208 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1209 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1211 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1212 assert_eq!(added_monitors.len(), 1);
1213 assert_eq!(added_monitors[0].0, funding_output);
1214 added_monitors.clear();
1216 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1218 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()));
1220 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1221 assert_eq!(added_monitors.len(), 1);
1222 assert_eq!(added_monitors[0].0, funding_output);
1223 added_monitors.clear();
1225 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1227 let events_4 = node_a.node.get_and_clear_pending_events();
1228 assert_eq!(events_4.len(), 0);
1230 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1231 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1232 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1234 // Ensure that funding_transaction_generated is idempotent.
1235 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1236 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1237 check_added_monitors!(node_a, 0);
1242 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1243 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, ChannelId) {
1244 let initiator_channels = initiator.node.list_usable_channels().len();
1245 let receiver_channels = receiver.node.list_usable_channels().len();
1247 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1248 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1250 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1251 let events = receiver.node.get_and_clear_pending_events();
1252 assert_eq!(events.len(), 1);
1254 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1255 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1257 _ => panic!("Unexpected event"),
1260 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1261 assert_eq!(accept_channel.common_fields.minimum_depth, 0);
1262 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1264 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1265 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1266 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1268 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1269 check_added_monitors!(receiver, 1);
1270 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1271 assert_eq!(bs_signed_locked.len(), 2);
1272 let as_channel_ready;
1273 match &bs_signed_locked[0] {
1274 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1275 assert_eq!(*node_id, initiator.node.get_our_node_id());
1276 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1277 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1278 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1279 check_added_monitors!(initiator, 1);
1281 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1282 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1284 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1286 _ => panic!("Unexpected event"),
1288 match &bs_signed_locked[1] {
1289 MessageSendEvent::SendChannelReady { node_id, msg } => {
1290 assert_eq!(*node_id, initiator.node.get_our_node_id());
1291 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1292 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1294 _ => panic!("Unexpected event"),
1297 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1298 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1300 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1301 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1303 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1304 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1306 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1307 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1309 (tx, as_channel_ready.channel_id)
1312 pub fn exchange_open_accept_chan<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, push_msat: u64) -> ChannelId {
1313 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1314 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1315 assert_eq!(open_channel_msg.common_fields.temporary_channel_id, create_chan_id);
1316 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1317 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1318 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1319 let events = node_b.node.get_and_clear_pending_events();
1320 assert_eq!(events.len(), 1);
1322 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1323 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1324 _ => panic!("Unexpected event"),
1327 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1328 assert_eq!(accept_channel_msg.common_fields.temporary_channel_id, create_chan_id);
1329 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1330 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1335 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 {
1336 let create_chan_id = exchange_open_accept_chan(node_a, node_b, channel_value, push_msat);
1337 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1340 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) {
1341 confirm_transaction_at(node_conf, tx, conf_height);
1342 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1343 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()));
1346 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), ChannelId) {
1348 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1349 assert_eq!(events_6.len(), 3);
1350 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1351 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1353 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1354 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1356 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1357 ((match events_6[0] {
1358 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1359 channel_id = msg.channel_id.clone();
1360 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1363 _ => panic!("Unexpected event"),
1364 }, match events_6[announcement_sigs_idx] {
1365 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1366 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1369 _ => panic!("Unexpected event"),
1373 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId) {
1374 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1375 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1376 confirm_transaction_at(node_a, tx, conf_height);
1377 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1378 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1379 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1382 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c: 'd, '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), ChannelId, Transaction) {
1383 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1384 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1388 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) {
1389 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1390 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1391 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1393 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1394 assert_eq!(events_7.len(), 1);
1395 let (announcement, bs_update) = match events_7[0] {
1396 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1397 (msg, update_msg.clone().unwrap())
1399 _ => panic!("Unexpected event"),
1402 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1403 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1404 assert_eq!(events_8.len(), 1);
1405 let as_update = match events_8[0] {
1406 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1407 assert!(*announcement == *msg);
1408 let update_msg = update_msg.clone().unwrap();
1409 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1410 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1413 _ => panic!("Unexpected event"),
1416 *node_a.network_chan_count.borrow_mut() += 1;
1418 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1419 ((*announcement).clone(), as_update, bs_update)
1422 pub fn create_announced_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1423 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1426 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1427 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1428 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1429 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1432 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) {
1433 let mut no_announce_cfg = test_default_channel_config();
1434 no_announce_cfg.channel_handshake_config.announced_channel = false;
1435 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1436 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1437 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1438 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1439 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1441 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1442 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1443 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()));
1444 check_added_monitors!(nodes[b], 1);
1446 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1447 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1449 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1450 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1451 check_added_monitors!(nodes[a], 1);
1453 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1454 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1455 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1457 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1458 confirm_transaction_at(&nodes[a], &tx, conf_height);
1459 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1460 confirm_transaction_at(&nodes[b], &tx, conf_height);
1461 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1462 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1463 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()));
1464 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1465 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1466 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1467 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1468 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1470 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1471 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1473 let mut found_a = false;
1474 for chan in nodes[a].node.list_usable_channels() {
1475 if chan.channel_id == as_channel_ready.channel_id {
1478 assert!(!chan.is_public);
1483 let mut found_b = false;
1484 for chan in nodes[b].node.list_usable_channels() {
1485 if chan.channel_id == as_channel_ready.channel_id {
1488 assert!(!chan.is_public);
1493 (as_channel_ready, tx)
1496 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) {
1498 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1499 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1500 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1502 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1503 // forwarding info for local channels even if its not accepted in the network graph.
1504 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1505 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1509 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1510 for outp in tx.output.iter() {
1511 assert!(outp.value >= outp.script_pubkey.dust_value(), "Spending tx output didn't meet dust limit");
1513 let mut total_value_in = 0;
1514 for input in tx.input.iter() {
1515 total_value_in += get_output(&input.previous_output).unwrap().value.to_sat();
1517 let mut total_value_out = 0;
1518 for output in tx.output.iter() {
1519 total_value_out += output.value.to_sat();
1521 let min_fee = (tx.weight().to_wu() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1522 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1523 assert!(total_value_out + min_fee <= total_value_in);
1524 tx.verify(get_output).unwrap();
1528 macro_rules! check_spends {
1529 ($tx: expr, $($spends_txn: expr),*) => {
1532 for outp in $spends_txn.output.iter() {
1533 assert!(outp.value >= outp.script_pubkey.dust_value(), "Input tx output didn't meet dust limit");
1536 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1538 if out_point.txid == $spends_txn.txid() {
1539 return $spends_txn.output.get(out_point.vout as usize).cloned()
1544 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1549 macro_rules! get_closing_signed_broadcast {
1550 ($node: expr, $dest_pubkey: expr) => {
1552 let events = $node.get_and_clear_pending_msg_events();
1553 assert!(events.len() == 1 || events.len() == 2);
1554 (match events[events.len() - 1] {
1555 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1556 assert_eq!(msg.contents.flags & 2, 2);
1559 _ => panic!("Unexpected event"),
1560 }, if events.len() == 2 {
1562 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1563 assert_eq!(*node_id, $dest_pubkey);
1566 _ => panic!("Unexpected event"),
1574 macro_rules! check_warn_msg {
1575 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1576 let msg_events = $node.node.get_and_clear_pending_msg_events();
1577 assert_eq!(msg_events.len(), 1);
1578 match msg_events[0] {
1579 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1580 assert_eq!(node_id, $recipient_node_id);
1581 assert_eq!(msg.channel_id, $chan_id);
1584 _ => panic!("Unexpected event"),
1589 /// Checks if at least one peer is connected.
1590 fn is_any_peer_connected(node: &Node) -> bool {
1591 let peer_state = node.node.per_peer_state.read().unwrap();
1592 for (_, peer_mutex) in peer_state.iter() {
1593 let peer = peer_mutex.lock().unwrap();
1594 if peer.is_connected { return true; }
1599 /// Check that a channel's closing channel update has been broadcasted, and optionally
1600 /// check whether an error message event has occurred.
1601 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1602 let mut dummy_connected = false;
1603 if !is_any_peer_connected(node) {
1604 connect_dummy_node(&node);
1605 dummy_connected = true;
1607 let msg_events = node.node.get_and_clear_pending_msg_events();
1608 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1609 if dummy_connected {
1610 disconnect_dummy_node(&node);
1612 msg_events.into_iter().filter_map(|msg_event| {
1614 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1615 assert_eq!(msg.contents.flags & 2, 2);
1618 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1619 assert!(with_error_msg);
1620 // TODO: Check node_id
1623 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1624 assert!(with_error_msg);
1625 // TODO: Check node_id
1628 _ => panic!("Unexpected event"),
1633 /// Check that a channel's closing channel update has been broadcasted, and optionally
1634 /// check whether an error message event has occurred.
1636 /// Don't use this, use the identically-named function instead.
1638 macro_rules! check_closed_broadcast {
1639 ($node: expr, $with_error_msg: expr) => {
1640 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1645 pub struct ExpectedCloseEvent {
1646 pub channel_capacity_sats: Option<u64>,
1647 pub channel_id: Option<ChannelId>,
1648 pub counterparty_node_id: Option<PublicKey>,
1649 pub discard_funding: bool,
1650 pub reason: Option<ClosureReason>,
1651 pub channel_funding_txo: Option<OutPoint>,
1652 pub user_channel_id: Option<u128>,
1655 impl ExpectedCloseEvent {
1656 pub fn from_id_reason(channel_id: ChannelId, discard_funding: bool, reason: ClosureReason) -> Self {
1658 channel_capacity_sats: None,
1659 channel_id: Some(channel_id),
1660 counterparty_node_id: None,
1662 reason: Some(reason),
1663 channel_funding_txo: None,
1664 user_channel_id: None,
1669 /// Check that multiple channel closing events have been issued.
1670 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1671 let closed_events_count = expected_close_events.len();
1672 let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1673 let events = node.node.get_and_clear_pending_events();
1674 assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1675 for expected_event in expected_close_events {
1676 assert!(events.iter().any(|e| matches!(
1678 Event::ChannelClosed {
1681 counterparty_node_id,
1682 channel_capacity_sats,
1683 channel_funding_txo,
1687 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1688 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1690 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1691 expected_event.channel_capacity_sats
1692 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
1693 expected_event.channel_funding_txo
1694 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
1695 expected_event.user_channel_id
1696 .map(|expected| *user_channel_id == expected).unwrap_or(true)
1700 assert_eq!(events.iter().filter(|e| matches!(
1702 Event::DiscardFunding { .. },
1703 )).count(), discard_events_count);
1706 /// Check that a channel's closing channel events has been issued
1707 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1708 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1709 let expected_events_count = if is_check_discard_funding {
1710 2 * expected_counterparty_node_ids.len()
1712 expected_counterparty_node_ids.len()
1714 assert_eq!(events_count, expected_events_count);
1715 let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1716 channel_capacity_sats: Some(expected_channel_capacity),
1718 counterparty_node_id: Some(*node_id),
1719 discard_funding: is_check_discard_funding,
1720 reason: Some(expected_reason.clone()),
1721 channel_funding_txo: None,
1722 user_channel_id: None,
1723 }).collect::<Vec<_>>();
1724 check_closed_events(node, expected_close_events.as_slice());
1727 /// Check that a channel's closing channel events has been issued
1729 /// Don't use this, use the identically-named function instead.
1731 macro_rules! check_closed_event {
1732 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1733 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1735 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1736 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1737 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1741 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1742 let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1743 assert_eq!(events.len(), count);
1744 for event in events {
1746 Event::BumpTransaction(bump_event) => {
1747 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1749 node.bump_tx_handler.handle_event(&bump_event);
1756 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &ChannelId, funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
1757 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) };
1758 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) };
1761 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1762 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1764 let events_1 = node_b.get_and_clear_pending_msg_events();
1765 assert!(events_1.len() >= 1);
1766 let shutdown_b = match events_1[0] {
1767 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1768 assert_eq!(node_id, &node_a.get_our_node_id());
1771 _ => panic!("Unexpected event"),
1774 let closing_signed_b = if !close_inbound_first {
1775 assert_eq!(events_1.len(), 1);
1778 Some(match events_1[1] {
1779 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1780 assert_eq!(node_id, &node_a.get_our_node_id());
1783 _ => panic!("Unexpected event"),
1787 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1788 let (as_update, bs_update) = if close_inbound_first {
1789 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1790 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1792 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1793 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1794 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1795 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1797 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1798 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1799 assert!(none_a.is_none());
1800 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1801 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1802 (as_update, bs_update)
1804 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1806 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1807 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1809 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1810 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1811 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1813 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1814 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1815 assert!(none_b.is_none());
1816 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1817 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1818 (as_update, bs_update)
1820 assert_eq!(tx_a, tx_b);
1821 check_spends!(tx_a, funding_tx);
1823 (as_update, bs_update, tx_a)
1826 pub struct SendEvent {
1827 pub node_id: PublicKey,
1828 pub msgs: Vec<msgs::UpdateAddHTLC>,
1829 pub commitment_msg: msgs::CommitmentSigned,
1832 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1833 assert!(updates.update_fulfill_htlcs.is_empty());
1834 assert!(updates.update_fail_htlcs.is_empty());
1835 assert!(updates.update_fail_malformed_htlcs.is_empty());
1836 assert!(updates.update_fee.is_none());
1837 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1840 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1842 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1843 _ => panic!("Unexpected event type!"),
1847 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1848 let mut events = node.node.get_and_clear_pending_msg_events();
1849 assert_eq!(events.len(), 1);
1850 SendEvent::from_event(events.pop().unwrap())
1855 /// Don't use this, use the identically-named function instead.
1856 macro_rules! expect_pending_htlcs_forwardable_conditions {
1857 ($node: expr, $expected_failures: expr) => {
1858 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1863 macro_rules! expect_htlc_handling_failed_destinations {
1864 ($events: expr, $expected_failures: expr) => {{
1865 for event in $events {
1867 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1868 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1869 assert!($expected_failures.contains(&failed_next_destination))
1871 _ => panic!("Unexpected destination"),
1877 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1878 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1879 /// `expected_failures` set.
1880 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1881 let count = expected_failures.len() + 1;
1882 assert_eq!(events.len(), count);
1883 assert!(events.iter().find(|event| matches!(event, Event::PendingHTLCsForwardable { .. })).is_some());
1884 if expected_failures.len() > 0 {
1885 expect_htlc_handling_failed_destinations!(events, expected_failures)
1890 /// Clears (and ignores) a PendingHTLCsForwardable event
1892 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1894 macro_rules! expect_pending_htlcs_forwardable_ignore {
1896 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1901 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1903 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1904 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1905 ($node: expr, $expected_failures: expr) => {
1906 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1911 /// Handles a PendingHTLCsForwardable event
1912 macro_rules! expect_pending_htlcs_forwardable {
1914 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1915 $node.node.process_pending_htlc_forwards();
1917 // Ensure process_pending_htlc_forwards is idempotent.
1918 $node.node.process_pending_htlc_forwards();
1923 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1924 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1925 ($node: expr, $expected_failures: expr) => {{
1926 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1927 $node.node.process_pending_htlc_forwards();
1929 // Ensure process_pending_htlc_forwards is idempotent.
1930 $node.node.process_pending_htlc_forwards();
1935 macro_rules! expect_pending_htlcs_forwardable_from_events {
1936 ($node: expr, $events: expr, $ignore: expr) => {{
1937 assert_eq!($events.len(), 1);
1939 Event::PendingHTLCsForwardable { .. } => { },
1940 _ => panic!("Unexpected event"),
1943 $node.node.process_pending_htlc_forwards();
1945 // Ensure process_pending_htlc_forwards is idempotent.
1946 $node.node.process_pending_htlc_forwards();
1952 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1953 /// commitment update.
1954 macro_rules! commitment_signed_dance {
1955 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1956 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1958 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1959 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1961 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1963 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1964 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1965 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1966 check_added_monitors(&$node_a, 1);
1967 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1968 assert!(extra_msg_option.is_none());
1972 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1973 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1975 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1976 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1980 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1981 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1982 /// `revoke_and_ack` response to it.
1984 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1985 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1986 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1987 /// the commitment we're exchanging. `includes_claim` provides that information.
1989 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1990 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1991 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1992 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1993 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1997 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1998 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1999 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
2001 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
2002 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
2003 check_added_monitors!(node_b, 0);
2004 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2005 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2006 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2007 check_added_monitors!(node_b, 1);
2008 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
2009 let (bs_revoke_and_ack, extra_msg_option) = {
2010 let mut events = node_b.node.get_and_clear_pending_msg_events();
2011 assert!(events.len() <= 2);
2012 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
2013 (match node_a_event {
2014 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2015 assert_eq!(*node_id, node_a.node.get_our_node_id());
2018 _ => panic!("Unexpected event"),
2019 }, events.get(0).map(|e| e.clone()))
2021 check_added_monitors!(node_b, 1);
2023 assert!(node_a.node.get_and_clear_pending_events().is_empty());
2024 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2026 (extra_msg_option, bs_revoke_and_ack)
2029 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
2030 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
2032 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
2033 /// on failure or that no new messages are left over on success.
2034 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
2035 check_added_monitors!(node_a, 0);
2036 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2037 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
2038 check_added_monitors!(node_a, 1);
2040 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
2041 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
2042 if fail_backwards { assert!(!got_claim); }
2043 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
2045 if skip_last_step { return; }
2048 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
2049 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
2050 check_added_monitors!(node_a, 1);
2052 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
2053 let mut number_of_msg_events = 0;
2054 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
2055 let peer_state = peer_state_mutex.lock().unwrap();
2056 let cp_pending_msg_events = &peer_state.pending_msg_events;
2057 number_of_msg_events += cp_pending_msg_events.len();
2058 if cp_pending_msg_events.len() == 1 {
2059 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
2060 assert_ne!(*cp_id, node_b.node.get_our_node_id());
2061 } else { panic!("Unexpected event"); }
2064 // Expecting the failure backwards event to the previous hop (not `node_b`)
2065 assert_eq!(number_of_msg_events, 1);
2067 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2071 /// Get a payment preimage and hash.
2072 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2073 let mut payment_count = recipient.network_payment_count.borrow_mut();
2074 let payment_preimage = PaymentPreimage([*payment_count; 32]);
2075 *payment_count += 1;
2076 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
2077 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
2078 (payment_preimage, payment_hash, payment_secret)
2081 /// Get a payment preimage and hash.
2083 /// Don't use this, use the identically-named function instead.
2085 macro_rules! get_payment_preimage_hash {
2086 ($dest_node: expr) => {
2087 get_payment_preimage_hash!($dest_node, None)
2089 ($dest_node: expr, $min_value_msat: expr) => {
2090 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
2092 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
2093 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
2097 /// Gets a route from the given sender to the node described in `payment_params`.
2098 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2099 let scorer = TestScorer::new();
2100 let keys_manager = TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2101 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2103 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
2104 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2105 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2109 /// Like `get_route` above, but adds a random CLTV offset to the final hop.
2110 pub fn find_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2111 let scorer = TestScorer::new();
2112 let keys_manager = TestKeysInterface::new(&[0u8; 32], Network::Testnet);
2113 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2115 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph,
2116 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2117 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2121 /// Gets a route from the given sender to the node described in `payment_params`.
2123 /// Don't use this, use the identically-named function instead.
2125 macro_rules! get_route {
2126 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
2127 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2128 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
2134 macro_rules! get_route_and_payment_hash {
2135 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
2136 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
2137 .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
2138 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
2140 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
2141 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
2143 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
2144 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2145 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
2146 let (payment_preimage, payment_hash, payment_secret) =
2147 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
2148 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
2149 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
2153 pub fn check_payment_claimable(
2154 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2155 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2156 expected_receiver_node_id: PublicKey,
2159 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2160 assert_eq!(expected_payment_hash, *payment_hash);
2161 assert_eq!(expected_recv_value, *amount_msat);
2162 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2164 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
2165 assert_eq!(&expected_payment_preimage, payment_preimage);
2166 assert_eq!(expected_payment_secret, *payment_secret);
2168 PaymentPurpose::Bolt12OfferPayment { payment_preimage, payment_secret, .. } => {
2169 assert_eq!(&expected_payment_preimage, payment_preimage);
2170 assert_eq!(expected_payment_secret, *payment_secret);
2172 PaymentPurpose::Bolt12RefundPayment { payment_preimage, payment_secret, .. } => {
2173 assert_eq!(&expected_payment_preimage, payment_preimage);
2174 assert_eq!(expected_payment_secret, *payment_secret);
2179 _ => panic!("Unexpected event"),
2184 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2185 macro_rules! expect_payment_claimable {
2186 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2187 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2189 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2190 let events = $node.node.get_and_clear_pending_events();
2191 assert_eq!(events.len(), 1);
2192 $crate::ln::functional_test_utils::check_payment_claimable(&events[0], $expected_payment_hash, $expected_payment_secret, $expected_recv_value, $expected_payment_preimage, $expected_receiver_node_id)
2197 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2198 macro_rules! expect_payment_claimed {
2199 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2200 let events = $node.node.get_and_clear_pending_events();
2201 assert_eq!(events.len(), 1);
2203 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2204 assert_eq!($expected_payment_hash, *payment_hash);
2205 assert_eq!($expected_recv_value, amount_msat);
2207 _ => panic!("Unexpected event"),
2212 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2213 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2214 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2216 let events = node.node().get_and_clear_pending_events();
2217 let expected_payment_hash = PaymentHash(
2218 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array());
2219 if expect_per_path_claims {
2220 assert!(events.len() > 1);
2222 assert_eq!(events.len(), 1);
2224 if expect_post_ev_mon_update {
2225 check_added_monitors(node, 1);
2227 let expected_payment_id = match events[0] {
2228 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2229 assert_eq!(expected_payment_preimage, *payment_preimage);
2230 assert_eq!(expected_payment_hash, *payment_hash);
2231 if let Some(expected_fee_msat) = expected_fee_msat_opt {
2232 assert_eq!(*fee_paid_msat, expected_fee_msat);
2234 assert!(fee_paid_msat.is_some());
2238 _ => panic!("Unexpected event"),
2240 if expect_per_path_claims {
2241 for i in 1..events.len() {
2243 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2244 assert_eq!(payment_id, expected_payment_id);
2245 assert_eq!(payment_hash, Some(expected_payment_hash));
2247 _ => panic!("Unexpected event"),
2254 macro_rules! expect_payment_sent {
2255 ($node: expr, $expected_payment_preimage: expr) => {
2256 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2258 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2259 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2261 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2262 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2263 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2269 macro_rules! expect_payment_path_successful {
2271 let events = $node.node.get_and_clear_pending_events();
2272 assert_eq!(events.len(), 1);
2274 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2275 _ => panic!("Unexpected event"),
2280 /// Returns the total fee earned by this HTLC forward, in msat.
2281 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2282 event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2283 expected_extra_fees_msat: Option<u64>, upstream_force_closed: bool,
2284 downstream_force_closed: bool, allow_1_msat_fee_overpay: bool,
2287 Event::PaymentForwarded {
2288 prev_channel_id, next_channel_id, prev_user_channel_id, next_user_channel_id,
2289 total_fee_earned_msat, skimmed_fee_msat, claim_from_onchain_tx, ..
2291 if allow_1_msat_fee_overpay {
2292 // Aggregating fees for blinded paths may result in a rounding error, causing slight
2293 // overpayment in fees.
2294 let actual_fee = total_fee_earned_msat.unwrap();
2295 let expected_fee = expected_fee.unwrap();
2296 assert!(actual_fee == expected_fee || actual_fee == expected_fee + 1);
2298 assert_eq!(total_fee_earned_msat, expected_fee);
2301 // Check that the (knowingly) withheld amount is always less or equal to the expected
2303 assert!(skimmed_fee_msat == expected_extra_fees_msat);
2304 if !upstream_force_closed {
2305 // Is the event prev_channel_id in one of the channels between the two nodes?
2306 assert!(node.node().list_channels().iter().any(|x|
2307 x.counterparty.node_id == prev_node.node().get_our_node_id() &&
2308 x.channel_id == prev_channel_id.unwrap() &&
2309 x.user_channel_id == prev_user_channel_id.unwrap()
2312 // We check for force closures since a force closed channel is removed from the
2313 // node's channel list
2314 if !downstream_force_closed {
2315 // As documented, `next_user_channel_id` will only be `Some` if we didn't settle via an
2316 // onchain transaction, just as the `total_fee_earned_msat` field. Rather than
2317 // introducing yet another variable, we use the latter's state as a flag to detect
2318 // this and only check if it's `Some`.
2319 if total_fee_earned_msat.is_none() {
2320 assert!(node.node().list_channels().iter().any(|x|
2321 x.counterparty.node_id == next_node.node().get_our_node_id() &&
2322 x.channel_id == next_channel_id.unwrap()
2325 assert!(node.node().list_channels().iter().any(|x|
2326 x.counterparty.node_id == next_node.node().get_our_node_id() &&
2327 x.channel_id == next_channel_id.unwrap() &&
2328 x.user_channel_id == next_user_channel_id.unwrap()
2332 assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2333 total_fee_earned_msat
2335 _ => panic!("Unexpected event"),
2340 macro_rules! expect_payment_forwarded {
2341 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2342 let mut events = $node.node.get_and_clear_pending_events();
2343 assert_eq!(events.len(), 1);
2344 $crate::ln::functional_test_utils::expect_payment_forwarded(
2345 events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee, None,
2346 $upstream_force_closed, $downstream_force_closed, false
2353 macro_rules! expect_channel_shutdown_state {
2354 ($node: expr, $chan_id: expr, $state: path) => {
2355 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2356 assert_eq!(chan_details.len(), 1);
2357 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2361 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2362 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2363 let events = node.node.get_and_clear_pending_events();
2364 assert_eq!(events.len(), 1);
2366 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2367 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2370 _ => panic!("Unexpected event"),
2374 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2375 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2376 let events = node.node.get_and_clear_pending_events();
2377 assert_eq!(events.len(), 1);
2379 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2380 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2382 _ => panic!("Unexpected event"),
2386 #[cfg(any(test, feature = "_test_utils"))]
2387 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2388 let mut events = node.node.get_and_clear_pending_events();
2390 for event in events.drain(..) {
2392 Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2393 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2394 assert!(result_idx.is_some());
2396 probe_results.remove(result_idx.unwrap());
2402 // Ensure that we received a ProbeSuccessful event for each probe result.
2403 assert!(probe_results.is_empty());
2406 pub struct PaymentFailedConditions<'a> {
2407 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2408 pub(crate) expected_blamed_scid: Option<u64>,
2409 pub(crate) expected_blamed_chan_closed: Option<bool>,
2410 pub(crate) expected_mpp_parts_remain: bool,
2413 impl<'a> PaymentFailedConditions<'a> {
2414 pub fn new() -> Self {
2416 expected_htlc_error_data: None,
2417 expected_blamed_scid: None,
2418 expected_blamed_chan_closed: None,
2419 expected_mpp_parts_remain: false,
2422 pub fn mpp_parts_remain(mut self) -> Self {
2423 self.expected_mpp_parts_remain = true;
2426 pub fn blamed_scid(mut self, scid: u64) -> Self {
2427 self.expected_blamed_scid = Some(scid);
2430 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2431 self.expected_blamed_chan_closed = Some(closed);
2434 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2435 self.expected_htlc_error_data = Some((code, data));
2441 macro_rules! expect_payment_failed_with_update {
2442 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2443 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2444 &$node, $expected_payment_hash, $payment_failed_permanently,
2445 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2446 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2451 macro_rules! expect_payment_failed {
2452 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2453 #[allow(unused_mut)]
2454 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2456 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2458 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2462 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2463 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2464 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2466 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2467 let expected_payment_id = match &payment_failed_events[0] {
2468 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2472 error_data, .. } => {
2473 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2474 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2477 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2478 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2479 if let Some((code, data)) = conditions.expected_htlc_error_data {
2480 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2481 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2485 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2486 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2488 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } => {
2489 if let Some(scid) = conditions.expected_blamed_scid {
2490 assert_eq!(*short_channel_id, scid);
2492 assert_eq!(*is_permanent, chan_closed);
2494 _ => panic!("Unexpected update type"),
2496 } else { panic!("Expected network update"); }
2501 _ => panic!("Unexpected event"),
2503 if !conditions.expected_mpp_parts_remain {
2504 match &payment_failed_events[1] {
2505 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2506 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2507 assert_eq!(*payment_id, expected_payment_id);
2508 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2509 PaymentFailureReason::RecipientRejected
2511 PaymentFailureReason::RetriesExhausted
2514 _ => panic!("Unexpected second event"),
2519 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2520 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2521 conditions: PaymentFailedConditions<'e>
2523 let events = node.node.get_and_clear_pending_events();
2524 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2527 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 {
2528 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2529 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2530 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2531 check_added_monitors!(origin_node, expected_paths.len());
2532 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2536 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2537 let origin_node_id = expected_path[0].node.get_our_node_id();
2539 // iterate from the receiving node to the origin node and handle update fail htlc.
2540 for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2541 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2542 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2543 check_added_monitors!(prev_node, 0);
2545 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2546 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2547 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2551 pub struct PassAlongPathArgs<'a, 'b, 'c, 'd> {
2552 pub origin_node: &'a Node<'b, 'c, 'd>,
2553 pub expected_path: &'a [&'a Node<'b, 'c, 'd>],
2554 pub recv_value: u64,
2555 pub payment_hash: PaymentHash,
2556 pub payment_secret: Option<PaymentSecret>,
2557 pub event: MessageSendEvent,
2558 pub payment_claimable_expected: bool,
2559 pub clear_recipient_events: bool,
2560 pub expected_preimage: Option<PaymentPreimage>,
2562 pub custom_tlvs: Vec<(u64, Vec<u8>)>,
2563 pub payment_metadata: Option<Vec<u8>>,
2566 impl<'a, 'b, 'c, 'd> PassAlongPathArgs<'a, 'b, 'c, 'd> {
2568 origin_node: &'a Node<'b, 'c, 'd>, expected_path: &'a [&'a Node<'b, 'c, 'd>], recv_value: u64,
2569 payment_hash: PaymentHash, event: MessageSendEvent,
2572 origin_node, expected_path, recv_value, payment_hash, payment_secret: None, event,
2573 payment_claimable_expected: true, clear_recipient_events: true, expected_preimage: None,
2574 is_probe: false, custom_tlvs: Vec::new(), payment_metadata: None,
2577 pub fn without_clearing_recipient_events(mut self) -> Self {
2578 self.clear_recipient_events = false;
2581 pub fn is_probe(mut self) -> Self {
2582 self.payment_claimable_expected = false;
2583 self.is_probe = true;
2586 pub fn without_claimable_event(mut self) -> Self {
2587 self.payment_claimable_expected = false;
2590 pub fn with_payment_secret(mut self, payment_secret: PaymentSecret) -> Self {
2591 self.payment_secret = Some(payment_secret);
2594 pub fn with_payment_preimage(mut self, payment_preimage: PaymentPreimage) -> Self {
2595 self.expected_preimage = Some(payment_preimage);
2598 pub fn with_custom_tlvs(mut self, custom_tlvs: Vec<(u64, Vec<u8>)>) -> Self {
2599 self.custom_tlvs = custom_tlvs;
2602 pub fn with_payment_metadata(mut self, payment_metadata: Vec<u8>) -> Self {
2603 self.payment_metadata = Some(payment_metadata);
2608 pub fn do_pass_along_path<'a, 'b, 'c>(args: PassAlongPathArgs) -> Option<Event> {
2609 let PassAlongPathArgs {
2610 origin_node, expected_path, recv_value, payment_hash: our_payment_hash,
2611 payment_secret: our_payment_secret, event: ev, payment_claimable_expected,
2612 clear_recipient_events, expected_preimage, is_probe, custom_tlvs, payment_metadata,
2615 let mut payment_event = SendEvent::from_event(ev);
2616 let mut prev_node = origin_node;
2617 let mut event = None;
2619 for (idx, &node) in expected_path.iter().enumerate() {
2620 let is_last_hop = idx == expected_path.len() - 1;
2621 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2623 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2624 check_added_monitors!(node, 0);
2626 if is_last_hop && is_probe {
2627 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2629 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2630 expect_pending_htlcs_forwardable!(node);
2633 if is_last_hop && clear_recipient_events {
2634 let events_2 = node.node.get_and_clear_pending_events();
2635 if payment_claimable_expected {
2636 assert_eq!(events_2.len(), 1);
2637 match &events_2[0] {
2638 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2639 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2640 claim_deadline, onion_fields, ..
2642 assert_eq!(our_payment_hash, *payment_hash);
2643 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2644 assert!(onion_fields.is_some());
2645 assert_eq!(onion_fields.as_ref().unwrap().custom_tlvs, custom_tlvs);
2646 assert_eq!(onion_fields.as_ref().unwrap().payment_metadata, payment_metadata);
2648 PaymentPurpose::Bolt11InvoicePayment { payment_preimage, payment_secret, .. } => {
2649 assert_eq!(expected_preimage, *payment_preimage);
2650 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2651 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2653 PaymentPurpose::Bolt12OfferPayment { payment_preimage, payment_secret, .. } => {
2654 assert_eq!(expected_preimage, *payment_preimage);
2655 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2656 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2658 PaymentPurpose::Bolt12RefundPayment { payment_preimage, payment_secret, .. } => {
2659 assert_eq!(expected_preimage, *payment_preimage);
2660 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2661 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2663 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2664 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2665 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2668 assert_eq!(*amount_msat, recv_value);
2669 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2670 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2671 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2673 _ => panic!("Unexpected event"),
2675 event = Some(events_2[0].clone());
2677 assert!(events_2.is_empty());
2679 } else if !is_last_hop {
2680 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2681 assert_eq!(events_2.len(), 1);
2682 check_added_monitors!(node, 1);
2683 payment_event = SendEvent::from_event(events_2.remove(0));
2684 assert_eq!(payment_event.msgs.len(), 1);
2692 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>) -> Option<Event> {
2693 let mut args = PassAlongPathArgs::new(origin_node, expected_path, recv_value, our_payment_hash, ev);
2694 if !payment_claimable_expected {
2695 args = args.without_claimable_event();
2697 if let Some(payment_secret) = our_payment_secret {
2698 args = args.with_payment_secret(payment_secret);
2700 if let Some(payment_preimage) = expected_preimage {
2701 args = args.with_payment_preimage(payment_preimage);
2703 do_pass_along_path(args)
2706 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2707 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2708 assert_eq!(events.len(), expected_route.len());
2710 check_added_monitors!(origin_node, expected_route.len());
2712 for path in expected_route.iter() {
2713 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2715 do_pass_along_path(PassAlongPathArgs::new(origin_node, path, 0, PaymentHash([0_u8; 32]), ev)
2717 .without_clearing_recipient_events());
2719 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2721 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2725 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) {
2726 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2727 assert_eq!(events.len(), expected_route.len());
2729 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2730 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2731 // Once we've gotten through all the HTLCs, the last one should result in a
2732 // PaymentClaimable (but each previous one should not!).
2733 let expect_payment = path_idx == expected_route.len() - 1;
2734 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2738 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) {
2739 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2740 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2741 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2744 pub fn do_claim_payment_along_route(args: ClaimAlongRouteArgs) -> u64 {
2745 for path in args.expected_paths.iter() {
2746 assert_eq!(path.last().unwrap().node.get_our_node_id(), args.expected_paths[0].last().unwrap().node.get_our_node_id());
2748 args.expected_paths[0].last().unwrap().node.claim_funds(args.payment_preimage);
2749 pass_claimed_payment_along_route(args)
2752 pub struct ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2753 pub origin_node: &'a Node<'b, 'c, 'd>,
2754 pub expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2755 pub expected_extra_fees: Vec<u32>,
2756 pub expected_min_htlc_overpay: Vec<u32>,
2757 pub skip_last: bool,
2758 pub payment_preimage: PaymentPreimage,
2759 pub custom_tlvs: Vec<(u64, Vec<u8>)>,
2760 // Allow forwarding nodes to have taken 1 msat more fee than expected based on the downstream
2763 // Necessary because our test utils calculate the expected fee for an intermediate node based on
2764 // the amount was claimed in their downstream peer's fulfill, but blinded intermediate nodes
2765 // calculate their fee based on the inbound amount from their upstream peer, causing a difference
2767 pub allow_1_msat_fee_overpay: bool,
2770 impl<'a, 'b, 'c, 'd> ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2772 origin_node: &'a Node<'b, 'c, 'd>, expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2773 payment_preimage: PaymentPreimage,
2776 origin_node, expected_paths, expected_extra_fees: vec![0; expected_paths.len()],
2777 expected_min_htlc_overpay: vec![0; expected_paths.len()], skip_last: false, payment_preimage,
2778 allow_1_msat_fee_overpay: false, custom_tlvs: vec![],
2781 pub fn skip_last(mut self, skip_last: bool) -> Self {
2782 self.skip_last = skip_last;
2785 pub fn with_expected_extra_fees(mut self, extra_fees: Vec<u32>) -> Self {
2786 self.expected_extra_fees = extra_fees;
2789 pub fn with_expected_min_htlc_overpay(mut self, extra_fees: Vec<u32>) -> Self {
2790 self.expected_min_htlc_overpay = extra_fees;
2793 pub fn allow_1_msat_fee_overpay(mut self) -> Self {
2794 self.allow_1_msat_fee_overpay = true;
2797 pub fn with_custom_tlvs(mut self, custom_tlvs: Vec<(u64, Vec<u8>)>) -> Self {
2798 self.custom_tlvs = custom_tlvs;
2803 pub fn pass_claimed_payment_along_route(args: ClaimAlongRouteArgs) -> u64 {
2804 let ClaimAlongRouteArgs {
2805 origin_node, expected_paths, expected_extra_fees, expected_min_htlc_overpay, skip_last,
2806 payment_preimage: our_payment_preimage, allow_1_msat_fee_overpay, custom_tlvs,
2808 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2809 assert_eq!(claim_event.len(), 1);
2811 let mut fwd_amt_msat = 0;
2812 match claim_event[0] {
2813 Event::PaymentClaimed {
2814 purpose: PaymentPurpose::SpontaneousPayment(preimage)
2815 | PaymentPurpose::Bolt11InvoicePayment { payment_preimage: Some(preimage), .. }
2816 | PaymentPurpose::Bolt12OfferPayment { payment_preimage: Some(preimage), .. }
2817 | PaymentPurpose::Bolt12RefundPayment { payment_preimage: Some(preimage), .. },
2823 assert_eq!(preimage, our_payment_preimage);
2824 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2825 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2826 assert_eq!(onion_fields.as_ref().unwrap().custom_tlvs, custom_tlvs);
2827 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2828 fwd_amt_msat = amount_msat;
2830 Event::PaymentClaimed {
2831 purpose: PaymentPurpose::Bolt11InvoicePayment { .. }
2832 | PaymentPurpose::Bolt12OfferPayment { .. }
2833 | PaymentPurpose::Bolt12RefundPayment { .. },
2840 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2841 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2842 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2843 assert_eq!(onion_fields.as_ref().unwrap().custom_tlvs, custom_tlvs);
2844 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2845 fwd_amt_msat = amount_msat;
2850 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2852 let mut expected_total_fee_msat = 0;
2854 macro_rules! msgs_from_ev {
2857 &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 } } => {
2858 assert!(update_add_htlcs.is_empty());
2859 assert_eq!(update_fulfill_htlcs.len(), 1);
2860 assert!(update_fail_htlcs.is_empty());
2861 assert!(update_fail_malformed_htlcs.is_empty());
2862 assert!(update_fee.is_none());
2863 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2865 _ => panic!("Unexpected event"),
2869 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2870 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2871 assert_eq!(events.len(), expected_paths.len());
2873 if events.len() == 1 {
2874 per_path_msgs.push(msgs_from_ev!(&events[0]));
2876 for expected_path in expected_paths.iter() {
2877 // For MPP payments, we want the fulfill message from the payee to the penultimate hop in the
2879 let penultimate_hop_node_id = expected_path.iter().rev().skip(1).next()
2880 .map(|n| n.node.get_our_node_id())
2881 .unwrap_or(origin_node.node.get_our_node_id());
2882 let ev = remove_first_msg_event_to_node(&penultimate_hop_node_id, &mut events);
2883 per_path_msgs.push(msgs_from_ev!(&ev));
2887 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2888 let mut next_msgs = Some(path_msgs);
2889 let mut expected_next_node = next_hop;
2891 macro_rules! last_update_fulfill_dance {
2892 ($node: expr, $prev_node: expr) => {
2894 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2895 check_added_monitors!($node, 0);
2896 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2897 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2901 macro_rules! mid_update_fulfill_dance {
2902 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2904 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2906 let (base_fee, prop_fee) = {
2907 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2908 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2909 .unwrap().lock().unwrap();
2910 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2911 if let Some(prev_config) = channel.context().prev_config() {
2912 (prev_config.forwarding_fee_base_msat as u64,
2913 prev_config.forwarding_fee_proportional_millionths as u64)
2915 (channel.context().config().forwarding_fee_base_msat as u64,
2916 channel.context().config().forwarding_fee_proportional_millionths as u64)
2919 ((fwd_amt_msat * prop_fee / 1_000_000) + base_fee) as u32
2922 let mut expected_extra_fee = None;
2924 fee += expected_extra_fees[i];
2925 fee += expected_min_htlc_overpay[i];
2926 expected_extra_fee = if expected_extra_fees[i] > 0 { Some(expected_extra_fees[i] as u64) } else { None };
2928 let mut events = $node.node.get_and_clear_pending_events();
2929 assert_eq!(events.len(), 1);
2930 let actual_fee = expect_payment_forwarded(events.pop().unwrap(), *$node, $next_node, $prev_node,
2931 Some(fee as u64), expected_extra_fee, false, false, allow_1_msat_fee_overpay);
2932 expected_total_fee_msat += actual_fee.unwrap();
2933 fwd_amt_msat += actual_fee.unwrap();
2934 check_added_monitors!($node, 1);
2935 let new_next_msgs = if $new_msgs {
2936 let events = $node.node.get_and_clear_pending_msg_events();
2937 assert_eq!(events.len(), 1);
2938 let (res, nexthop) = msgs_from_ev!(&events[0]);
2939 expected_next_node = nexthop;
2942 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2945 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2946 next_msgs = new_next_msgs;
2951 let mut prev_node = expected_route.last().unwrap();
2952 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2953 assert_eq!(expected_next_node, node.node.get_our_node_id());
2954 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2955 if next_msgs.is_some() {
2956 // Since we are traversing in reverse, next_node is actually the previous node
2957 let next_node: &Node;
2958 if idx == expected_route.len() - 1 {
2959 next_node = origin_node;
2961 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2963 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2965 assert!(!update_next_msgs);
2966 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2968 if !skip_last && idx == expected_route.len() - 1 {
2969 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2976 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2980 // Ensure that claim_funds is idempotent.
2981 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2982 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2983 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2985 expected_total_fee_msat
2987 pub fn claim_payment_along_route(args: ClaimAlongRouteArgs) {
2988 let origin_node = args.origin_node;
2989 let payment_preimage = args.payment_preimage;
2990 let skip_last = args.skip_last;
2991 let expected_total_fee_msat = do_claim_payment_along_route(args);
2993 expect_payment_sent!(origin_node, payment_preimage, Some(expected_total_fee_msat));
2997 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2998 claim_payment_along_route(
2999 ClaimAlongRouteArgs::new(origin_node, &[expected_route], our_payment_preimage)
3003 pub const TEST_FINAL_CLTV: u32 = 70;
3005 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, PaymentId) {
3006 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
3007 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
3008 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
3009 let route = get_route(origin_node, &route_params).unwrap();
3010 assert_eq!(route.paths.len(), 1);
3011 assert_eq!(route.paths[0].hops.len(), expected_route.len());
3012 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
3013 assert_eq!(hop.pubkey, node.node.get_our_node_id());
3016 let res = send_along_route(origin_node, route, expected_route, recv_value);
3017 (res.0, res.1, res.2, res.3)
3020 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
3021 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
3022 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
3023 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
3024 let network_graph = origin_node.network_graph.read_only();
3025 let scorer = test_utils::TestScorer::new();
3026 let seed = [0u8; 32];
3027 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
3028 let random_seed_bytes = keys_manager.get_secure_random_bytes();
3029 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
3030 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
3031 assert_eq!(route.paths.len(), 1);
3032 assert_eq!(route.paths[0].hops.len(), expected_route.len());
3033 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
3034 assert_eq!(hop.pubkey, node.node.get_our_node_id());
3037 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
3038 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
3039 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
3040 true, APIError::ChannelUnavailable { ref err },
3041 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
3044 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
3045 let res = route_payment(&origin, expected_route, recv_value);
3046 claim_payment(&origin, expected_route, res.0);
3050 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) {
3051 for path in expected_paths.iter() {
3052 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
3054 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
3055 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
3056 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
3058 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
3061 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, expected_fail_reason: PaymentFailureReason) {
3062 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
3063 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
3065 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
3066 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
3067 assert_eq!(events.len(), expected_paths.len());
3068 for ev in events.iter() {
3069 let (update_fail, commitment_signed, node_id) = match ev {
3070 &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 } } => {
3071 assert!(update_add_htlcs.is_empty());
3072 assert!(update_fulfill_htlcs.is_empty());
3073 assert_eq!(update_fail_htlcs.len(), 1);
3074 assert!(update_fail_malformed_htlcs.is_empty());
3075 assert!(update_fee.is_none());
3076 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
3078 _ => panic!("Unexpected event"),
3080 per_path_msgs.push(((update_fail, commitment_signed), node_id));
3082 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
3083 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()));
3085 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
3086 let mut next_msgs = Some(path_msgs);
3087 let mut expected_next_node = next_hop;
3088 let mut prev_node = expected_route.last().unwrap();
3090 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
3091 assert_eq!(expected_next_node, node.node.get_our_node_id());
3092 let update_next_node = !skip_last || idx != expected_route.len() - 1;
3093 if next_msgs.is_some() {
3094 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
3095 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
3096 if !update_next_node {
3097 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 }]);
3100 let events = node.node.get_and_clear_pending_msg_events();
3101 if update_next_node {
3102 assert_eq!(events.len(), 1);
3104 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 } } => {
3105 assert!(update_add_htlcs.is_empty());
3106 assert!(update_fulfill_htlcs.is_empty());
3107 assert_eq!(update_fail_htlcs.len(), 1);
3108 assert!(update_fail_malformed_htlcs.is_empty());
3109 assert!(update_fee.is_none());
3110 expected_next_node = node_id.clone();
3111 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
3113 _ => panic!("Unexpected event"),
3116 assert!(events.is_empty());
3118 if !skip_last && idx == expected_route.len() - 1 {
3119 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3126 let prev_node = expected_route.first().unwrap();
3127 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
3128 check_added_monitors!(origin_node, 0);
3129 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
3130 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
3131 let events = origin_node.node.get_and_clear_pending_events();
3132 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
3134 let expected_payment_id = match events[0] {
3135 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
3136 assert_eq!(payment_hash, our_payment_hash);
3137 assert!(payment_failed_permanently);
3138 for (idx, hop) in expected_route.iter().enumerate() {
3139 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
3143 _ => panic!("Unexpected event"),
3145 if i == expected_paths.len() - 1 {
3147 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
3148 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
3149 assert_eq!(*payment_id, expected_payment_id);
3150 assert_eq!(reason.unwrap(), expected_fail_reason);
3152 _ => panic!("Unexpected second event"),
3158 // Ensure that fail_htlc_backwards is idempotent.
3159 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
3160 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
3161 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
3162 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
3165 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
3166 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
3169 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
3170 let mut chan_mon_cfgs = Vec::new();
3171 for i in 0..node_count {
3172 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
3173 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
3174 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
3175 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
3176 let persister = test_utils::TestPersister::new();
3177 let seed = [i as u8; 32];
3178 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
3179 let scorer = RwLock::new(test_utils::TestScorer::new());
3181 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
3187 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
3188 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
3191 pub fn create_node_cfgs_with_persisters<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>, persisters: Vec<&'a impl Persist<TestChannelSigner>>) -> Vec<NodeCfg<'a>> {
3192 let mut nodes = Vec::new();
3194 for i in 0..node_count {
3195 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, persisters[i], &chanmon_cfgs[i].keys_manager);
3196 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
3197 let seed = [i as u8; 32];
3198 nodes.push(NodeCfg {
3199 chain_source: &chanmon_cfgs[i].chain_source,
3200 logger: &chanmon_cfgs[i].logger,
3201 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
3202 fee_estimator: &chanmon_cfgs[i].fee_estimator,
3203 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].logger, &chanmon_cfgs[i].scorer),
3204 message_router: test_utils::TestMessageRouter::new(network_graph.clone(), &chanmon_cfgs[i].keys_manager),
3206 keys_manager: &chanmon_cfgs[i].keys_manager,
3209 override_init_features: Rc::new(RefCell::new(None)),
3216 pub fn test_default_channel_config() -> UserConfig {
3217 let mut default_config = UserConfig::default();
3218 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
3219 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
3220 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
3221 default_config.channel_handshake_config.announced_channel = true;
3222 default_config.channel_handshake_limits.force_announced_channel_preference = false;
3223 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
3224 // It now defaults to 1, so we simply set it to the expected value here.
3225 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
3226 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
3227 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
3229 default_config.channel_config.max_dust_htlc_exposure =
3230 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
3234 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>> {
3235 let mut chanmgrs = Vec::new();
3236 for i in 0..node_count {
3237 let network = Network::Testnet;
3238 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
3239 let params = ChainParameters {
3241 best_block: BestBlock::from_network(network),
3243 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,
3244 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, genesis_block.header.time);
3245 chanmgrs.push(node);
3251 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>> {
3252 let mut nodes = Vec::new();
3253 let chan_count = Rc::new(RefCell::new(0));
3254 let payment_count = Rc::new(RefCell::new(0));
3255 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
3257 for i in 0..node_count {
3258 let dedicated_entropy = DedicatedEntropy(RandomBytes::new([i as u8; 32]));
3259 let onion_messenger = OnionMessenger::new(
3260 dedicated_entropy, cfgs[i].keys_manager, cfgs[i].logger, &chan_mgrs[i],
3261 &cfgs[i].message_router, &chan_mgrs[i], IgnoringMessageHandler {},
3263 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
3264 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
3266 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
3267 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
3268 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
3269 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
3270 node_seed: cfgs[i].node_seed, onion_messenger, network_chan_count: chan_count.clone(),
3271 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
3272 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
3273 connect_style: Rc::clone(&connect_style),
3274 override_init_features: Rc::clone(&cfgs[i].override_init_features),
3275 wallet_source: Arc::clone(&wallet_source),
3276 bump_tx_handler: BumpTransactionEventHandler::new(
3277 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
3278 &cfgs[i].keys_manager, cfgs[i].logger,
3283 for i in 0..node_count {
3284 for j in (i+1)..node_count {
3285 connect_nodes(&nodes[i], &nodes[j]);
3292 fn connect_nodes<'a, 'b: 'a, 'c: 'b>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>) {
3293 let node_id_a = node_a.node.get_our_node_id();
3294 let node_id_b = node_b.node.get_our_node_id();
3296 let init_a = msgs::Init {
3297 features: node_a.init_features(&node_id_b),
3299 remote_network_address: None,
3301 let init_b = msgs::Init {
3302 features: node_b.init_features(&node_id_a),
3304 remote_network_address: None,
3307 node_a.node.peer_connected(&node_id_b, &init_b, true).unwrap();
3308 node_b.node.peer_connected(&node_id_a, &init_a, false).unwrap();
3309 node_a.onion_messenger.peer_connected(&node_id_b, &init_b, true).unwrap();
3310 node_b.onion_messenger.peer_connected(&node_id_a, &init_a, false).unwrap();
3313 pub fn connect_dummy_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) {
3314 let node_id_dummy = PublicKey::from_slice(&[2; 33]).unwrap();
3316 let mut dummy_init_features = InitFeatures::empty();
3317 dummy_init_features.set_static_remote_key_required();
3319 let init_dummy = msgs::Init {
3320 features: dummy_init_features,
3322 remote_network_address: None
3325 node.node.peer_connected(&node_id_dummy, &init_dummy, true).unwrap();
3326 node.onion_messenger.peer_connected(&node_id_dummy, &init_dummy, true).unwrap();
3329 pub fn disconnect_dummy_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) {
3330 let node_id_dummy = PublicKey::from_slice(&[2; 33]).unwrap();
3331 node.node.peer_disconnected(&node_id_dummy);
3332 node.onion_messenger.peer_disconnected(&node_id_dummy);
3335 // Note that the following only works for CLTV values up to 128
3336 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3337 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3339 #[derive(PartialEq)]
3340 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
3341 /// Tests that the given node has broadcast transactions for the given Channel
3343 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
3344 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
3345 /// broadcast and the revoked outputs were claimed.
3347 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
3348 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
3350 /// All broadcast transactions must be accounted for in one of the above three types of we'll
3352 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
3353 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3354 let mut txn_seen = new_hash_set();
3355 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3356 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
3358 let mut res = Vec::with_capacity(2);
3359 node_txn.retain(|tx| {
3360 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
3361 check_spends!(tx, chan.3);
3362 if commitment_tx.is_none() {
3363 res.push(tx.clone());
3368 if let Some(explicit_tx) = commitment_tx {
3369 res.push(explicit_tx.clone());
3372 assert_eq!(res.len(), 1);
3374 if has_htlc_tx != HTLCType::NONE {
3375 node_txn.retain(|tx| {
3376 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
3377 check_spends!(tx, res[0]);
3378 if has_htlc_tx == HTLCType::TIMEOUT {
3379 assert_ne!(tx.lock_time, LockTime::ZERO);
3381 assert_eq!(tx.lock_time, LockTime::ZERO);
3383 res.push(tx.clone());
3387 assert!(res.len() == 2 || res.len() == 3);
3389 assert_eq!(res[1], res[2]);
3393 assert!(node_txn.is_empty());
3397 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3398 /// HTLC transaction.
3399 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
3400 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3401 // We may issue multiple claiming transaction on revoked outputs due to block rescan
3402 // for revoked htlc outputs
3403 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3404 node_txn.retain(|tx| {
3405 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3406 check_spends!(tx, revoked_tx);
3410 node_txn.retain(|tx| {
3411 check_spends!(tx, commitment_revoked_tx);
3414 assert!(node_txn.is_empty());
3417 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3418 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3419 let mut txn_seen = new_hash_set();
3420 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3422 let mut found_prev = false;
3423 for prev_tx in prev_txn {
3424 for tx in &*node_txn {
3425 if tx.input[0].previous_output.txid == prev_tx.txid() {
3426 check_spends!(tx, prev_tx);
3427 let mut iter = tx.input[0].witness.iter();
3428 iter.next().expect("expected 3 witness items");
3429 iter.next().expect("expected 3 witness items");
3430 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3431 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3438 assert!(found_prev);
3440 let mut res = Vec::new();
3441 mem::swap(&mut *node_txn, &mut res);
3445 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) {
3446 let mut dummy_connected = false;
3447 if !is_any_peer_connected(&nodes[a]) {
3448 connect_dummy_node(&nodes[a]);
3449 dummy_connected = true
3452 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3453 assert_eq!(events_1.len(), 2);
3454 let as_update = match events_1[1] {
3455 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3458 _ => panic!("Unexpected event"),
3461 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3462 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3463 assert_eq!(msg.data, expected_error);
3464 if needs_err_handle {
3465 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3468 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3469 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3470 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3471 if needs_err_handle {
3472 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3475 _ => panic!("Unexpected event"),
3477 if dummy_connected {
3478 disconnect_dummy_node(&nodes[a]);
3479 dummy_connected = false;
3481 if !is_any_peer_connected(&nodes[b]) {
3482 connect_dummy_node(&nodes[b]);
3483 dummy_connected = true;
3485 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3486 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3487 let bs_update = match events_2.last().unwrap() {
3488 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3491 _ => panic!("Unexpected event"),
3493 if !needs_err_handle {
3495 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3496 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3497 assert_eq!(msg.data, expected_error);
3499 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3500 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3501 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3503 _ => panic!("Unexpected event"),
3506 if dummy_connected {
3507 disconnect_dummy_node(&nodes[b]);
3510 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3511 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3515 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
3516 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3520 macro_rules! get_channel_value_stat {
3521 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3522 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3523 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3524 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3525 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3526 ).flatten().unwrap();
3527 chan.get_value_stat()
3531 macro_rules! get_chan_reestablish_msgs {
3532 ($src_node: expr, $dst_node: expr) => {
3534 let mut announcements = $crate::prelude::new_hash_set();
3535 let mut res = Vec::with_capacity(1);
3536 for msg in $src_node.node.get_and_clear_pending_msg_events() {
3537 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3538 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3539 res.push(msg.clone());
3540 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3541 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3542 announcements.insert(msg.contents.short_channel_id);
3544 panic!("Unexpected event")
3547 assert!(announcements.is_empty());
3553 macro_rules! handle_chan_reestablish_msgs {
3554 ($src_node: expr, $dst_node: expr) => {
3556 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3558 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3560 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3566 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3568 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3571 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3572 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3573 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3575 had_channel_update = true;
3578 let mut revoke_and_ack = None;
3579 let mut commitment_update = None;
3580 let order = if let Some(ev) = msg_events.get(idx) {
3582 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3583 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3584 revoke_and_ack = Some(msg.clone());
3586 RAACommitmentOrder::RevokeAndACKFirst
3588 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3589 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3590 commitment_update = Some(updates.clone());
3592 RAACommitmentOrder::CommitmentFirst
3594 _ => RAACommitmentOrder::CommitmentFirst,
3597 RAACommitmentOrder::CommitmentFirst
3600 if let Some(ev) = msg_events.get(idx) {
3602 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3603 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3604 assert!(revoke_and_ack.is_none());
3605 revoke_and_ack = Some(msg.clone());
3608 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3609 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3610 assert!(commitment_update.is_none());
3611 commitment_update = Some(updates.clone());
3618 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3619 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3621 assert!(!had_channel_update);
3624 assert_eq!(msg_events.len(), idx);
3626 (channel_ready, revoke_and_ack, commitment_update, order)
3631 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3632 pub node_a: &'a Node<'b, 'c, 'd>,
3633 pub node_b: &'a Node<'b, 'c, 'd>,
3634 pub send_channel_ready: (bool, bool),
3635 pub pending_responding_commitment_signed: (bool, bool),
3636 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3637 /// and no monitor update is expected
3638 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3639 pub pending_htlc_adds: (usize, usize),
3640 pub pending_htlc_claims: (usize, usize),
3641 pub pending_htlc_fails: (usize, usize),
3642 pub pending_cell_htlc_claims: (usize, usize),
3643 pub pending_cell_htlc_fails: (usize, usize),
3644 pub pending_raa: (bool, bool),
3647 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3648 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3652 send_channel_ready: (false, false),
3653 pending_responding_commitment_signed: (false, false),
3654 pending_responding_commitment_signed_dup_monitor: (false, false),
3655 pending_htlc_adds: (0, 0),
3656 pending_htlc_claims: (0, 0),
3657 pending_htlc_fails: (0, 0),
3658 pending_cell_htlc_claims: (0, 0),
3659 pending_cell_htlc_fails: (0, 0),
3660 pending_raa: (false, false),
3665 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3666 /// for claims/fails they are separated out.
3667 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3669 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3670 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3671 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3673 connect_nodes(node_a, node_b);
3674 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3675 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3677 if send_channel_ready.0 {
3678 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3680 for reestablish in reestablish_1.iter() {
3681 let n = reestablish.next_remote_commitment_number;
3682 assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3685 if send_channel_ready.1 {
3686 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3688 for reestablish in reestablish_2.iter() {
3689 let n = reestablish.next_remote_commitment_number;
3690 assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3693 if send_channel_ready.0 || send_channel_ready.1 {
3694 // If we expect any channel_ready's, both sides better have set
3695 // next_holder_commitment_number to 1
3696 for reestablish in reestablish_1.iter() {
3697 let n = reestablish.next_local_commitment_number;
3698 assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3700 for reestablish in reestablish_2.iter() {
3701 let n = reestablish.next_local_commitment_number;
3702 assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3706 let mut resp_1 = Vec::new();
3707 for msg in reestablish_1 {
3708 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3709 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3711 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3712 check_added_monitors!(node_b, 1);
3714 check_added_monitors!(node_b, 0);
3717 let mut resp_2 = Vec::new();
3718 for msg in reestablish_2 {
3719 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3720 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3722 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3723 check_added_monitors!(node_a, 1);
3725 check_added_monitors!(node_a, 0);
3728 // We don't yet support both needing updates, as that would require a different commitment dance:
3729 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3730 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3731 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3732 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3734 for chan_msgs in resp_1.drain(..) {
3735 if send_channel_ready.0 {
3736 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3737 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3738 if !announcement_event.is_empty() {
3739 assert_eq!(announcement_event.len(), 1);
3740 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3741 //TODO: Test announcement_sigs re-sending
3742 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3745 assert!(chan_msgs.0.is_none());
3748 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3749 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3750 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3751 check_added_monitors!(node_a, 1);
3753 assert!(chan_msgs.1.is_none());
3755 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3756 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3757 pending_responding_commitment_signed.0
3759 let commitment_update = chan_msgs.2.unwrap();
3760 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3761 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3762 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3763 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3764 for update_add in commitment_update.update_add_htlcs {
3765 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3767 for update_fulfill in commitment_update.update_fulfill_htlcs {
3768 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3770 for update_fail in commitment_update.update_fail_htlcs {
3771 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3774 if !pending_responding_commitment_signed.0 {
3775 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3777 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3778 check_added_monitors!(node_a, 1);
3779 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3780 // No commitment_signed so get_event_msg's assert(len == 1) passes
3781 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3782 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3783 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3786 assert!(chan_msgs.2.is_none());
3790 for chan_msgs in resp_2.drain(..) {
3791 if send_channel_ready.1 {
3792 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3793 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3794 if !announcement_event.is_empty() {
3795 assert_eq!(announcement_event.len(), 1);
3796 match announcement_event[0] {
3797 MessageSendEvent::SendChannelUpdate { .. } => {},
3798 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3799 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3803 assert!(chan_msgs.0.is_none());
3806 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3807 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3808 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3809 check_added_monitors!(node_b, 1);
3811 assert!(chan_msgs.1.is_none());
3813 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3814 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3815 pending_responding_commitment_signed.1
3817 let commitment_update = chan_msgs.2.unwrap();
3818 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3819 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3820 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3821 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3822 for update_add in commitment_update.update_add_htlcs {
3823 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3825 for update_fulfill in commitment_update.update_fulfill_htlcs {
3826 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3828 for update_fail in commitment_update.update_fail_htlcs {
3829 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3832 if !pending_responding_commitment_signed.1 {
3833 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3835 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3836 check_added_monitors!(node_b, 1);
3837 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3838 // No commitment_signed so get_event_msg's assert(len == 1) passes
3839 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3840 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3841 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3844 assert!(chan_msgs.2.is_none());
3849 /// Initiates channel opening and creates a single batch funding transaction.
3850 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3851 /// transaction with corresponding funding_created messages.
3852 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3853 funding_node: &Node<'a, 'b, 'c>,
3854 params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3855 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3856 let mut tx_outs = Vec::new();
3857 let mut temp_chan_ids = Vec::new();
3858 let mut funding_created_msgs = Vec::new();
3860 for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3861 // Initialize channel opening.
3862 let temp_chan_id = funding_node.node.create_channel(
3863 other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3867 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3868 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3869 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3870 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3872 // Create the corresponding funding output.
3873 let events = funding_node.node.get_and_clear_pending_events();
3874 assert_eq!(events.len(), 1);
3876 Event::FundingGenerationReady {
3877 ref temporary_channel_id,
3878 ref counterparty_node_id,
3879 channel_value_satoshis: ref event_channel_value_satoshis,
3881 user_channel_id: ref event_user_channel_id
3883 assert_eq!(temporary_channel_id, &temp_chan_id);
3884 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3885 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3886 assert_eq!(user_channel_id, event_user_channel_id);
3887 tx_outs.push(TxOut {
3888 value: Amount::from_sat(*channel_value_satoshis), script_pubkey: output_script.clone(),
3891 _ => panic!("Unexpected event"),
3893 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3896 // Compose the batch funding transaction and give it to the ChannelManager.
3897 let tx = Transaction {
3898 version: transaction::Version::TWO,
3899 lock_time: LockTime::ZERO,
3903 assert!(funding_node.node.batch_funding_transaction_generated(
3904 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3907 check_added_monitors!(funding_node, 0);
3908 let events = funding_node.node.get_and_clear_pending_msg_events();
3909 assert_eq!(events.len(), params.len());
3910 for (other_node, ..) in params {
3911 let funding_created = events
3913 .find_map(|event| match event {
3914 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3918 funding_created_msgs.push(funding_created);
3920 return (tx, funding_created_msgs);