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::{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;
34 use crate::util::test_utils;
35 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
36 use crate::util::ser::{ReadableArgs, Writeable};
38 use bitcoin::blockdata::block::{Block, Header, Version};
39 use bitcoin::blockdata::locktime::absolute::LockTime;
40 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut};
41 use bitcoin::hash_types::{BlockHash, TxMerkleNode};
42 use bitcoin::hashes::sha256::Hash as Sha256;
43 use bitcoin::hashes::Hash as _;
44 use bitcoin::network::constants::Network;
45 use bitcoin::pow::CompactTarget;
46 use bitcoin::secp256k1::{PublicKey, SecretKey};
49 use core::cell::RefCell;
50 use core::iter::repeat;
54 use crate::prelude::*;
55 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
57 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
59 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
60 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
62 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
63 /// output is the 1st output in the transaction.
64 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
65 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
66 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
69 /// Mine a single block containing the given transaction
71 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
72 /// output is the 1st output in the transaction.
73 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
74 let height = node.best_block_info().1 + 1;
75 confirm_transaction_at(node, tx, height)
77 /// Mine a single block containing the given transactions
78 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
79 let height = node.best_block_info().1 + 1;
80 confirm_transactions_at(node, txn, height);
82 /// Mine a single block containing the given transaction without extra consistency checks which may
83 /// impact ChannelManager state.
84 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
85 let height = node.best_block_info().1 + 1;
86 let mut block = Block {
88 version: Version::NO_SOFT_FORK_SIGNALLING,
89 prev_blockhash: node.best_block_hash(),
90 merkle_root: TxMerkleNode::all_zeros(),
92 bits: CompactTarget::from_consensus(42),
97 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
98 block.txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
100 block.txdata.push((*tx).clone());
101 do_connect_block_without_consistency_checks(node, block, false);
103 /// Mine the given transaction at the given height, mining blocks as required to build to that
106 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
107 /// output is the 1st output in the transaction.
108 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
109 let first_connect_height = node.best_block_info().1 + 1;
110 assert!(first_connect_height <= conf_height);
111 if conf_height > first_connect_height {
112 connect_blocks(node, conf_height - first_connect_height);
114 let mut txdata = Vec::new();
115 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
116 txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
119 txdata.push((*tx).clone());
121 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
122 connect_block(node, &block);
123 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
125 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
126 confirm_transactions_at(node, &[tx], conf_height)
129 /// The possible ways we may notify a ChannelManager of a new block
130 #[derive(Clone, Copy, Debug, PartialEq)]
131 pub enum ConnectStyle {
132 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
133 /// the header and height information.
135 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
136 /// make a single `best_block_updated` call.
137 BestBlockFirstSkippingBlocks,
138 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
139 /// `transaction_unconfirmed` is called.
140 BestBlockFirstReorgsOnlyTip,
141 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
142 /// the header and height information.
144 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
145 /// make a single `best_block_updated` call.
146 TransactionsFirstSkippingBlocks,
147 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
148 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
149 /// times to ensure it's idempotent.
150 TransactionsDuplicativelyFirstSkippingBlocks,
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 HighlyRedundantTransactionsFirstSkippingBlocks,
155 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
156 /// `transaction_unconfirmed` is called.
157 TransactionsFirstReorgsOnlyTip,
158 /// Provides the full block via the `chain::Listen` interface. In the current code this is
159 /// equivalent to `TransactionsFirst` with some additional assertions.
164 pub fn skips_blocks(&self) -> bool {
166 ConnectStyle::BestBlockFirst => false,
167 ConnectStyle::BestBlockFirstSkippingBlocks => true,
168 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
169 ConnectStyle::TransactionsFirst => false,
170 ConnectStyle::TransactionsFirstSkippingBlocks => true,
171 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
172 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
173 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
174 ConnectStyle::FullBlockViaListen => false,
178 pub fn updates_best_block_first(&self) -> bool {
180 ConnectStyle::BestBlockFirst => true,
181 ConnectStyle::BestBlockFirstSkippingBlocks => true,
182 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
183 ConnectStyle::TransactionsFirst => false,
184 ConnectStyle::TransactionsFirstSkippingBlocks => false,
185 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
186 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
187 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
188 ConnectStyle::FullBlockViaListen => false,
192 fn random_style() -> ConnectStyle {
193 #[cfg(feature = "std")] {
194 use core::hash::{BuildHasher, Hasher};
195 // Get a random value using the only std API to do so - the DefaultHasher
196 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
197 let res = match rand_val % 9 {
198 0 => ConnectStyle::BestBlockFirst,
199 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
200 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
201 3 => ConnectStyle::TransactionsFirst,
202 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
203 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
204 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
205 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
206 8 => ConnectStyle::FullBlockViaListen,
209 eprintln!("Using Block Connection Style: {:?}", res);
212 #[cfg(not(feature = "std"))] {
213 ConnectStyle::FullBlockViaListen
218 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> Header {
220 version: Version::NO_SOFT_FORK_SIGNALLING,
222 merkle_root: TxMerkleNode::all_zeros(),
224 bits: CompactTarget::from_consensus(42),
229 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
230 Block { header: create_dummy_header(prev_blockhash, time), txdata }
233 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
234 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
236 let height = node.best_block_info().1 + 1;
237 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
240 let prev_blockhash = block.header.block_hash();
241 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
242 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
244 let hash = block.header.block_hash();
245 do_connect_block_with_consistency_checks(node, block, false);
249 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
250 do_connect_block_with_consistency_checks(node, block.clone(), false);
253 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
254 // Ensure `get_claimable_balances`' self-tests never panic
255 for (funding_outpoint, _channel_id) in node.chain_monitor.chain_monitor.list_monitors() {
256 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
260 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
261 call_claimable_balances(node);
262 do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
263 call_claimable_balances(node);
264 node.node.test_process_background_events();
267 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
268 let height = node.best_block_info().1 + 1;
269 #[cfg(feature = "std")] {
270 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
272 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
273 // transaction broadcast are correct.
274 node.blocks.lock().unwrap().push((block.clone(), height));
275 if !skip_intermediaries {
276 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
277 match *node.connect_style.borrow() {
278 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
279 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
280 call_claimable_balances(node);
281 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
282 node.node.best_block_updated(&block.header, height);
283 node.node.transactions_confirmed(&block.header, &txdata, height);
285 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
286 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
287 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
288 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
289 let mut connections = Vec::new();
290 for (block, height) in node.blocks.lock().unwrap().iter() {
291 if !block.txdata.is_empty() {
292 // Reconnect all transactions we've ever seen to ensure transaction connection
293 // is *really* idempotent. This is a somewhat likely deployment for some
294 // esplora implementations of chain sync which try to reduce state and
295 // complexity as much as possible.
297 // Sadly we have to clone the block here to maintain lockorder. In the
298 // future we should consider Arc'ing the blocks to avoid this.
299 connections.push((block.clone(), *height));
302 for (old_block, height) in connections {
303 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
304 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
307 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
308 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
309 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
311 call_claimable_balances(node);
312 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
313 node.node.transactions_confirmed(&block.header, &txdata, height);
314 node.node.best_block_updated(&block.header, height);
316 ConnectStyle::FullBlockViaListen => {
317 node.chain_monitor.chain_monitor.block_connected(&block, height);
318 node.node.block_connected(&block, height);
323 for tx in &block.txdata {
324 for input in &tx.input {
325 node.wallet_source.remove_utxo(input.previous_output);
327 let wallet_script = node.wallet_source.get_change_script().unwrap();
328 for (idx, output) in tx.output.iter().enumerate() {
329 if output.script_pubkey == wallet_script {
330 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
331 node.wallet_source.add_utxo(outpoint, output.value);
337 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
338 call_claimable_balances(node);
339 #[cfg(feature = "std")] {
340 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
343 let orig = node.blocks.lock().unwrap().pop().unwrap();
344 assert!(orig.1 > 0); // Cannot disconnect genesis
345 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
347 match *node.connect_style.borrow() {
348 ConnectStyle::FullBlockViaListen => {
349 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
350 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
352 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
353 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
355 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
356 node.node.best_block_updated(&prev.0.header, prev.1);
359 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
360 for tx in orig.0.txdata {
361 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
362 node.node.transaction_unconfirmed(&tx.txid());
366 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
367 node.node.best_block_updated(&prev.0.header, prev.1);
370 call_claimable_balances(node);
374 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
375 let count = node.blocks.lock().unwrap().len() as u32 - 1;
376 disconnect_blocks(node, count);
379 pub struct TestChanMonCfg {
380 pub tx_broadcaster: test_utils::TestBroadcaster,
381 pub fee_estimator: test_utils::TestFeeEstimator,
382 pub chain_source: test_utils::TestChainSource,
383 pub persister: test_utils::TestPersister,
384 pub logger: test_utils::TestLogger,
385 pub keys_manager: test_utils::TestKeysInterface,
386 pub scorer: RwLock<test_utils::TestScorer>,
389 pub struct NodeCfg<'a> {
390 pub chain_source: &'a test_utils::TestChainSource,
391 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
392 pub fee_estimator: &'a test_utils::TestFeeEstimator,
393 pub router: test_utils::TestRouter<'a>,
394 pub message_router: test_utils::TestMessageRouter<'a>,
395 pub chain_monitor: test_utils::TestChainMonitor<'a>,
396 pub keys_manager: &'a test_utils::TestKeysInterface,
397 pub logger: &'a test_utils::TestLogger,
398 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
399 pub node_seed: [u8; 32],
400 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
403 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
404 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
405 &'chan_mon_cfg test_utils::TestBroadcaster,
406 &'node_cfg test_utils::TestKeysInterface,
407 &'node_cfg test_utils::TestKeysInterface,
408 &'node_cfg test_utils::TestKeysInterface,
409 &'chan_mon_cfg test_utils::TestFeeEstimator,
410 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
411 &'chan_mon_cfg test_utils::TestLogger,
414 type TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg> = OnionMessenger<
416 &'node_cfg test_utils::TestKeysInterface,
417 &'chan_mon_cfg test_utils::TestLogger,
418 &'node_cfg test_utils::TestMessageRouter<'chan_mon_cfg>,
419 &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
420 IgnoringMessageHandler,
423 /// For use with [`OnionMessenger`] otherwise `test_restored_packages_retry` will fail. This is
424 /// because that test uses older serialized data produced by calling [`EntropySource`] in a specific
425 /// manner. Using the same [`EntropySource`] with [`OnionMessenger`] would introduce another call,
426 /// causing the produced data to no longer match.
427 pub struct DedicatedEntropy(RandomBytes);
429 impl Deref for DedicatedEntropy {
430 type Target = RandomBytes;
431 fn deref(&self) -> &Self::Target { &self.0 }
434 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
435 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
436 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
437 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
438 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
439 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
440 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
441 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
442 pub onion_messenger: TestOnionMessenger<'chan_man, 'node_cfg, 'chan_mon_cfg>,
443 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
444 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>,
445 pub node_seed: [u8; 32],
446 pub network_payment_count: Rc<RefCell<u8>>,
447 pub network_chan_count: Rc<RefCell<u32>>,
448 pub logger: &'chan_mon_cfg test_utils::TestLogger,
449 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
450 pub connect_style: Rc<RefCell<ConnectStyle>>,
451 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
452 pub wallet_source: Arc<test_utils::TestWalletSource>,
453 pub bump_tx_handler: BumpTransactionEventHandler<
454 &'chan_mon_cfg test_utils::TestBroadcaster,
455 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
456 &'chan_mon_cfg test_utils::TestKeysInterface,
457 &'chan_mon_cfg test_utils::TestLogger,
461 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
462 pub fn init_features(&self, peer_node_id: &PublicKey) -> InitFeatures {
463 self.override_init_features.borrow().clone()
464 .unwrap_or_else(|| self.node.init_features() | self.onion_messenger.provided_init_features(peer_node_id))
468 #[cfg(feature = "std")]
469 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
470 #[cfg(feature = "std")]
471 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
472 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
473 pub fn best_block_hash(&self) -> BlockHash {
474 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
476 pub fn best_block_info(&self) -> (BlockHash, u32) {
477 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
479 pub fn get_block_header(&self, height: u32) -> Header {
480 self.blocks.lock().unwrap()[height as usize].0.header
482 /// Changes the channel signer's availability for the specified peer and channel.
484 /// When `available` is set to `true`, the channel signer will behave normally. When set to
485 /// `false`, the channel signer will act like an off-line remote signer and will return `Err` for
486 /// several of the signing methods. Currently, only `get_per_commitment_point` and
487 /// `release_commitment_secret` are affected by this setting.
489 pub fn set_channel_signer_available(&self, peer_id: &PublicKey, chan_id: &ChannelId, available: bool) {
490 use crate::sign::ChannelSigner;
491 log_debug!(self.logger, "Setting channel signer for {} as available={}", chan_id, available);
493 let per_peer_state = self.node.per_peer_state.read().unwrap();
494 let chan_lock = per_peer_state.get(peer_id).unwrap().lock().unwrap();
496 let mut channel_keys_id = None;
497 if let Some(chan) = chan_lock.channel_by_id.get(chan_id).map(|phase| phase.context()) {
498 chan.get_signer().as_ecdsa().unwrap().set_available(available);
499 channel_keys_id = Some(chan.channel_keys_id);
502 let mut monitor = None;
503 for (funding_txo, channel_id) in self.chain_monitor.chain_monitor.list_monitors() {
504 if *chan_id == channel_id {
505 monitor = self.chain_monitor.chain_monitor.get_monitor(funding_txo).ok();
508 if let Some(monitor) = monitor {
509 monitor.do_signer_call(|signer| {
510 channel_keys_id = channel_keys_id.or(Some(signer.inner.channel_keys_id()));
511 signer.set_available(available)
516 self.keys_manager.unavailable_signers.lock().unwrap()
517 .remove(channel_keys_id.as_ref().unwrap());
519 self.keys_manager.unavailable_signers.lock().unwrap()
520 .insert(channel_keys_id.unwrap());
525 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
526 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
527 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
529 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
531 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
532 Self((node as *const Node<'a, 'b, 'c>).cast())
535 unsafe impl Send for NodePtr {}
536 unsafe impl Sync for NodePtr {}
539 pub trait NodeHolder {
540 type CM: AChannelManager;
541 fn node(&self) -> &ChannelManager<
542 <Self::CM as AChannelManager>::M,
543 <Self::CM as AChannelManager>::T,
544 <Self::CM as AChannelManager>::ES,
545 <Self::CM as AChannelManager>::NS,
546 <Self::CM as AChannelManager>::SP,
547 <Self::CM as AChannelManager>::F,
548 <Self::CM as AChannelManager>::R,
549 <Self::CM as AChannelManager>::L>;
550 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
552 impl<H: NodeHolder> NodeHolder for &H {
554 fn node(&self) -> &ChannelManager<
555 <Self::CM as AChannelManager>::M,
556 <Self::CM as AChannelManager>::T,
557 <Self::CM as AChannelManager>::ES,
558 <Self::CM as AChannelManager>::NS,
559 <Self::CM as AChannelManager>::SP,
560 <Self::CM as AChannelManager>::F,
561 <Self::CM as AChannelManager>::R,
562 <Self::CM as AChannelManager>::L> { (*self).node() }
563 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
565 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
566 type CM = TestChannelManager<'b, 'c>;
567 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
568 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
571 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
574 // Check that we processed all pending events
575 let msg_events = self.node.get_and_clear_pending_msg_events();
576 if !msg_events.is_empty() {
577 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
579 let events = self.node.get_and_clear_pending_events();
580 if !events.is_empty() {
581 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
583 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
584 if !added_monitors.is_empty() {
585 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
588 // Check that if we serialize the network graph, we can deserialize it again.
589 let network_graph = {
590 let mut w = test_utils::TestVecWriter(Vec::new());
591 self.network_graph.write(&mut w).unwrap();
592 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
593 assert!(network_graph_deser == *self.network_graph);
594 let gossip_sync = P2PGossipSync::new(
595 &network_graph_deser, Some(self.chain_source), self.logger
597 let mut chan_progress = 0;
599 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
600 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
601 assert!(orig_announcements == deserialized_announcements);
602 chan_progress = match orig_announcements {
603 Some(announcement) => announcement.0.contents.short_channel_id + 1,
607 let mut node_progress = None;
609 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
610 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
611 assert!(orig_announcements == deserialized_announcements);
612 node_progress = match orig_announcements {
613 Some(announcement) => Some(announcement.contents.node_id),
620 // Check that if we serialize and then deserialize all our channel monitors we get the
621 // same set of outputs to watch for on chain as we have now. Note that if we write
622 // tests that fully close channels and remove the monitors at some point this may break.
623 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
624 let mut deserialized_monitors = Vec::new();
626 for (outpoint, _channel_id) in self.chain_monitor.chain_monitor.list_monitors() {
627 let mut w = test_utils::TestVecWriter(Vec::new());
628 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
629 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
630 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
631 deserialized_monitors.push(deserialized_monitor);
635 let broadcaster = test_utils::TestBroadcaster {
636 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
637 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
640 // Before using all the new monitors to check the watch outpoints, use the full set of
641 // them to ensure we can write and reload our ChannelManager.
643 let mut channel_monitors = new_hash_map();
644 for monitor in deserialized_monitors.iter_mut() {
645 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
648 let scorer = RwLock::new(test_utils::TestScorer::new());
649 let mut w = test_utils::TestVecWriter(Vec::new());
650 self.node.write(&mut w).unwrap();
651 <(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 {
652 default_config: *self.node.get_current_default_configuration(),
653 entropy_source: self.keys_manager,
654 node_signer: self.keys_manager,
655 signer_provider: self.keys_manager,
656 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
657 router: &test_utils::TestRouter::new(Arc::new(network_graph), &self.logger, &scorer),
658 chain_monitor: self.chain_monitor,
659 tx_broadcaster: &broadcaster,
660 logger: &self.logger,
665 let persister = test_utils::TestPersister::new();
666 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
667 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
668 for deserialized_monitor in deserialized_monitors.drain(..) {
669 let funding_outpoint = deserialized_monitor.get_funding_txo().0;
670 if chain_monitor.watch_channel(funding_outpoint, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
674 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
675 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
680 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) {
681 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
684 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) {
685 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
686 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
687 (announcement, as_update, bs_update, channel_id, tx)
690 /// Gets an RAA and CS which were sent in response to a commitment update
691 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
692 let events = node.node().get_and_clear_pending_msg_events();
693 assert_eq!(events.len(), 2);
695 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
696 assert_eq!(node_id, recipient);
699 _ => panic!("Unexpected event"),
701 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
702 assert_eq!(node_id, recipient);
703 assert!(updates.update_add_htlcs.is_empty());
704 assert!(updates.update_fulfill_htlcs.is_empty());
705 assert!(updates.update_fail_htlcs.is_empty());
706 assert!(updates.update_fail_malformed_htlcs.is_empty());
707 assert!(updates.update_fee.is_none());
708 updates.commitment_signed.clone()
710 _ => panic!("Unexpected event"),
715 /// Gets an RAA and CS which were sent in response to a commitment update
717 /// Don't use this, use the identically-named function instead.
718 macro_rules! get_revoke_commit_msgs {
719 ($node: expr, $node_id: expr) => {
720 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
724 /// Get an specific event message from the pending events queue.
726 macro_rules! get_event_msg {
727 ($node: expr, $event_type: path, $node_id: expr) => {
729 let events = $node.node.get_and_clear_pending_msg_events();
730 assert_eq!(events.len(), 1);
732 $event_type { ref node_id, ref msg } => {
733 assert_eq!(*node_id, $node_id);
736 _ => panic!("Unexpected event"),
742 /// Get an error message from the pending events queue.
743 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
744 let events = node.node.get_and_clear_pending_msg_events();
745 assert_eq!(events.len(), 1);
747 MessageSendEvent::HandleError {
748 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
750 assert_eq!(node_id, recipient);
753 MessageSendEvent::HandleError {
754 action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
756 assert_eq!(node_id, recipient);
757 msg.as_ref().unwrap().clone()
759 _ => panic!("Unexpected event"),
763 /// Get a specific event from the pending events queue.
765 macro_rules! get_event {
766 ($node: expr, $event_type: path) => {
768 let mut events = $node.node.get_and_clear_pending_events();
769 assert_eq!(events.len(), 1);
770 let ev = events.pop().unwrap();
772 $event_type { .. } => {
775 _ => panic!("Unexpected event"),
781 /// Gets an UpdateHTLCs MessageSendEvent
782 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
783 let events = node.node.get_and_clear_pending_msg_events();
784 assert_eq!(events.len(), 1);
786 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
787 assert_eq!(node_id, recipient);
790 _ => panic!("Unexpected event"),
795 /// Gets an UpdateHTLCs MessageSendEvent
797 /// Don't use this, use the identically-named function instead.
798 macro_rules! get_htlc_update_msgs {
799 ($node: expr, $node_id: expr) => {
800 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
804 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
805 /// Returns the `msg_event`.
807 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
808 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
809 /// such messages are intended to all peers.
810 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
811 let ev_index = msg_events.iter().position(|e| { match e {
812 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
813 node_id == msg_node_id
815 MessageSendEvent::SendOpenChannel { node_id, .. } => {
816 node_id == msg_node_id
818 MessageSendEvent::SendFundingCreated { node_id, .. } => {
819 node_id == msg_node_id
821 MessageSendEvent::SendFundingSigned { node_id, .. } => {
822 node_id == msg_node_id
824 MessageSendEvent::SendChannelReady { node_id, .. } => {
825 node_id == msg_node_id
827 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
828 node_id == msg_node_id
830 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
831 node_id == msg_node_id
833 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
834 node_id == msg_node_id
836 MessageSendEvent::SendClosingSigned { node_id, .. } => {
837 node_id == msg_node_id
839 MessageSendEvent::SendShutdown { node_id, .. } => {
840 node_id == msg_node_id
842 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
843 node_id == msg_node_id
845 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
846 node_id == msg_node_id
848 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
851 MessageSendEvent::BroadcastChannelUpdate { .. } => {
854 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
857 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
858 node_id == msg_node_id
860 MessageSendEvent::HandleError { node_id, .. } => {
861 node_id == msg_node_id
863 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
864 node_id == msg_node_id
866 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
867 node_id == msg_node_id
869 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
870 node_id == msg_node_id
872 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
873 node_id == msg_node_id
875 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
876 node_id == msg_node_id
878 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
879 node_id == msg_node_id
881 MessageSendEvent::SendStfu { node_id, .. } => {
882 node_id == msg_node_id
884 MessageSendEvent::SendSplice { node_id, .. } => {
885 node_id == msg_node_id
887 MessageSendEvent::SendSpliceAck { node_id, .. } => {
888 node_id == msg_node_id
890 MessageSendEvent::SendSpliceLocked { node_id, .. } => {
891 node_id == msg_node_id
893 MessageSendEvent::SendTxAddInput { node_id, .. } => {
894 node_id == msg_node_id
896 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
897 node_id == msg_node_id
899 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
900 node_id == msg_node_id
902 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
903 node_id == msg_node_id
905 MessageSendEvent::SendTxComplete { node_id, .. } => {
906 node_id == msg_node_id
908 MessageSendEvent::SendTxSignatures { node_id, .. } => {
909 node_id == msg_node_id
911 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
912 node_id == msg_node_id
914 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
915 node_id == msg_node_id
917 MessageSendEvent::SendTxAbort { node_id, .. } => {
918 node_id == msg_node_id
921 if ev_index.is_some() {
922 msg_events.remove(ev_index.unwrap())
924 panic!("Couldn't find any MessageSendEvent to the node!")
929 macro_rules! get_channel_ref {
930 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
932 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
933 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
934 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
940 macro_rules! get_feerate {
941 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
943 let mut per_peer_state_lock;
944 let mut peer_state_lock;
945 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
946 phase.context().get_feerate_sat_per_1000_weight()
952 macro_rules! get_channel_type_features {
953 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
955 let mut per_peer_state_lock;
956 let mut peer_state_lock;
957 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
958 chan.context().get_channel_type().clone()
963 /// Returns a channel monitor given a channel id, making some naive assumptions
965 macro_rules! get_monitor {
966 ($node: expr, $channel_id: expr) => {
968 use bitcoin::hashes::Hash;
969 let mut monitor = None;
970 // Assume funding vout is either 0 or 1 blindly
972 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
973 $crate::chain::transaction::OutPoint {
974 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
986 /// Returns any local commitment transactions for the channel.
988 macro_rules! get_local_commitment_txn {
989 ($node: expr, $channel_id: expr) => {
991 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
996 /// Check the error from attempting a payment.
998 macro_rules! unwrap_send_err {
999 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
1001 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
1002 assert_eq!(fails.len(), 1);
1004 $type => { $check },
1008 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
1009 assert_eq!(results.len(), 1);
1011 Err($type) => { $check },
1015 &Err(PaymentSendFailure::PathParameterError(ref result)) if !$all_failed => {
1016 assert_eq!(result.len(), 1);
1018 Err($type) => { $check },
1027 /// Check whether N channel monitor(s) have been added.
1028 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
1029 if let Some(chain_monitor) = node.chain_monitor() {
1030 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
1031 let n = added_monitors.len();
1032 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
1033 added_monitors.clear();
1037 /// Check whether N channel monitor(s) have been added.
1039 /// Don't use this, use the identically-named function instead.
1041 macro_rules! check_added_monitors {
1042 ($node: expr, $count: expr) => {
1043 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
1047 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
1049 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
1050 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
1051 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
1052 let mut nodes = path.iter().rev();
1053 let dest = nodes.next().expect("path should have a destination").node;
1054 let prev = nodes.next().unwrap_or(&origin_node).node;
1055 let dest_channels = dest.list_channels();
1056 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
1057 .expect("HTLC's channel should be one of destination node's channels");
1058 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
1059 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
1062 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> {
1063 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1064 for encoded in monitors_encoded {
1065 let mut monitor_read = &encoded[..];
1066 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1067 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1068 assert!(monitor_read.is_empty());
1069 monitors_read.push(monitor);
1072 let mut node_read = &chanman_encoded[..];
1073 let (_, node_deserialized) = {
1074 let mut channel_monitors = new_hash_map();
1075 for monitor in monitors_read.iter_mut() {
1076 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1078 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1080 entropy_source: node.keys_manager,
1081 node_signer: node.keys_manager,
1082 signer_provider: node.keys_manager,
1083 fee_estimator: node.fee_estimator,
1084 router: node.router,
1085 chain_monitor: node.chain_monitor,
1086 tx_broadcaster: node.tx_broadcaster,
1087 logger: node.logger,
1091 assert!(node_read.is_empty());
1093 for monitor in monitors_read.drain(..) {
1094 let funding_outpoint = monitor.get_funding_txo().0;
1095 assert_eq!(node.chain_monitor.watch_channel(funding_outpoint, monitor),
1096 Ok(ChannelMonitorUpdateStatus::Completed));
1097 check_added_monitors!(node, 1);
1104 macro_rules! reload_node {
1105 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1106 let chanman_encoded = $chanman_encoded;
1108 $persister = test_utils::TestPersister::new();
1109 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1110 $node.chain_monitor = &$new_chain_monitor;
1112 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1113 $node.node = &$new_channelmanager;
1114 $node.onion_messenger.set_offers_handler(&$new_channelmanager);
1116 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1117 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1121 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1122 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1123 -> (ChannelId, Transaction, OutPoint)
1125 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1128 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1129 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1130 -> (ChannelId, Transaction, OutPoint)
1132 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1135 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1136 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1137 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1138 let chan_id = *node.network_chan_count.borrow();
1140 let events = node.node.get_and_clear_pending_events();
1141 assert_eq!(events.len(), 1);
1143 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1144 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1145 assert_eq!(*channel_value_satoshis, expected_chan_value);
1146 assert_eq!(user_channel_id, expected_user_chan_id);
1148 let input = if coinbase {
1150 previous_output: bitcoin::OutPoint::null(),
1151 ..Default::default()
1157 let tx = Transaction { version: chan_id as i32, lock_time: LockTime::ZERO, input, output: vec![TxOut {
1158 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1160 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1161 (*temporary_channel_id, tx, funding_outpoint)
1163 _ => panic!("Unexpected event"),
1167 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 {
1168 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1169 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1171 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1172 check_added_monitors!(node_a, 0);
1174 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1175 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1176 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1178 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1179 assert_eq!(added_monitors.len(), 1);
1180 assert_eq!(added_monitors[0].0, funding_output);
1181 added_monitors.clear();
1183 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1185 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()));
1187 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1188 assert_eq!(added_monitors.len(), 1);
1189 assert_eq!(added_monitors[0].0, funding_output);
1190 added_monitors.clear();
1192 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1194 let events_4 = node_a.node.get_and_clear_pending_events();
1195 assert_eq!(events_4.len(), 0);
1197 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1198 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1199 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1201 // Ensure that funding_transaction_generated is idempotent.
1202 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1203 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1204 check_added_monitors!(node_a, 0);
1209 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1210 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) {
1211 let initiator_channels = initiator.node.list_usable_channels().len();
1212 let receiver_channels = receiver.node.list_usable_channels().len();
1214 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1215 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1217 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1218 let events = receiver.node.get_and_clear_pending_events();
1219 assert_eq!(events.len(), 1);
1221 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1222 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1224 _ => panic!("Unexpected event"),
1227 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1228 assert_eq!(accept_channel.common_fields.minimum_depth, 0);
1229 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1231 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1232 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1233 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1235 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1236 check_added_monitors!(receiver, 1);
1237 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1238 assert_eq!(bs_signed_locked.len(), 2);
1239 let as_channel_ready;
1240 match &bs_signed_locked[0] {
1241 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1242 assert_eq!(*node_id, initiator.node.get_our_node_id());
1243 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1244 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1245 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1246 check_added_monitors!(initiator, 1);
1248 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1249 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1251 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1253 _ => panic!("Unexpected event"),
1255 match &bs_signed_locked[1] {
1256 MessageSendEvent::SendChannelReady { node_id, msg } => {
1257 assert_eq!(*node_id, initiator.node.get_our_node_id());
1258 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1259 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1261 _ => panic!("Unexpected event"),
1264 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1265 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1267 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1268 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1270 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1271 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1273 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1274 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1276 (tx, as_channel_ready.channel_id)
1279 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 {
1280 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1281 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1282 assert_eq!(open_channel_msg.common_fields.temporary_channel_id, create_chan_id);
1283 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1284 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1285 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1286 let events = node_b.node.get_and_clear_pending_events();
1287 assert_eq!(events.len(), 1);
1289 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1290 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1291 _ => panic!("Unexpected event"),
1294 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1295 assert_eq!(accept_channel_msg.common_fields.temporary_channel_id, create_chan_id);
1296 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1297 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1302 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 {
1303 let create_chan_id = exchange_open_accept_chan(node_a, node_b, channel_value, push_msat);
1304 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1307 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) {
1308 confirm_transaction_at(node_conf, tx, conf_height);
1309 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1310 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()));
1313 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) {
1315 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1316 assert_eq!(events_6.len(), 3);
1317 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1318 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1320 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1321 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1323 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1324 ((match events_6[0] {
1325 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1326 channel_id = msg.channel_id.clone();
1327 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1330 _ => panic!("Unexpected event"),
1331 }, match events_6[announcement_sigs_idx] {
1332 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1333 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1336 _ => panic!("Unexpected event"),
1340 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) {
1341 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1342 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1343 confirm_transaction_at(node_a, tx, conf_height);
1344 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1345 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1346 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1349 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) {
1350 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1351 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1355 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) {
1356 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1357 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1358 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1360 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1361 assert_eq!(events_7.len(), 1);
1362 let (announcement, bs_update) = match events_7[0] {
1363 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1364 (msg, update_msg.clone().unwrap())
1366 _ => panic!("Unexpected event"),
1369 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1370 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1371 assert_eq!(events_8.len(), 1);
1372 let as_update = match events_8[0] {
1373 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1374 assert!(*announcement == *msg);
1375 let update_msg = update_msg.clone().unwrap();
1376 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1377 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1380 _ => panic!("Unexpected event"),
1383 *node_a.network_chan_count.borrow_mut() += 1;
1385 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1386 ((*announcement).clone(), as_update, bs_update)
1389 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) {
1390 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1393 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) {
1394 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1395 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1396 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1399 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) {
1400 let mut no_announce_cfg = test_default_channel_config();
1401 no_announce_cfg.channel_handshake_config.announced_channel = false;
1402 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1403 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1404 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1405 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1406 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1408 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1409 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1410 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()));
1411 check_added_monitors!(nodes[b], 1);
1413 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1414 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1416 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1417 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1418 check_added_monitors!(nodes[a], 1);
1420 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1421 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1422 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1424 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1425 confirm_transaction_at(&nodes[a], &tx, conf_height);
1426 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1427 confirm_transaction_at(&nodes[b], &tx, conf_height);
1428 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1429 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1430 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()));
1431 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1432 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1433 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1434 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1435 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1437 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1438 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1440 let mut found_a = false;
1441 for chan in nodes[a].node.list_usable_channels() {
1442 if chan.channel_id == as_channel_ready.channel_id {
1445 assert!(!chan.is_public);
1450 let mut found_b = false;
1451 for chan in nodes[b].node.list_usable_channels() {
1452 if chan.channel_id == as_channel_ready.channel_id {
1455 assert!(!chan.is_public);
1460 (as_channel_ready, tx)
1463 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) {
1465 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1466 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1467 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1469 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1470 // forwarding info for local channels even if its not accepted in the network graph.
1471 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1472 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1476 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1477 for outp in tx.output.iter() {
1478 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1480 let mut total_value_in = 0;
1481 for input in tx.input.iter() {
1482 total_value_in += get_output(&input.previous_output).unwrap().value;
1484 let mut total_value_out = 0;
1485 for output in tx.output.iter() {
1486 total_value_out += output.value;
1488 let min_fee = (tx.weight().to_wu() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1489 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1490 assert!(total_value_out + min_fee <= total_value_in);
1491 tx.verify(get_output).unwrap();
1495 macro_rules! check_spends {
1496 ($tx: expr, $($spends_txn: expr),*) => {
1499 for outp in $spends_txn.output.iter() {
1500 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1503 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1505 if out_point.txid == $spends_txn.txid() {
1506 return $spends_txn.output.get(out_point.vout as usize).cloned()
1511 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1516 macro_rules! get_closing_signed_broadcast {
1517 ($node: expr, $dest_pubkey: expr) => {
1519 let events = $node.get_and_clear_pending_msg_events();
1520 assert!(events.len() == 1 || events.len() == 2);
1521 (match events[events.len() - 1] {
1522 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1523 assert_eq!(msg.contents.flags & 2, 2);
1526 _ => panic!("Unexpected event"),
1527 }, if events.len() == 2 {
1529 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1530 assert_eq!(*node_id, $dest_pubkey);
1533 _ => panic!("Unexpected event"),
1541 macro_rules! check_warn_msg {
1542 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1543 let msg_events = $node.node.get_and_clear_pending_msg_events();
1544 assert_eq!(msg_events.len(), 1);
1545 match msg_events[0] {
1546 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1547 assert_eq!(node_id, $recipient_node_id);
1548 assert_eq!(msg.channel_id, $chan_id);
1551 _ => panic!("Unexpected event"),
1556 /// Checks if at least one peer is connected.
1557 fn is_any_peer_connected(node: &Node) -> bool {
1558 let peer_state = node.node.per_peer_state.read().unwrap();
1559 for (_, peer_mutex) in peer_state.iter() {
1560 let peer = peer_mutex.lock().unwrap();
1561 if peer.is_connected { return true; }
1566 /// Check that a channel's closing channel update has been broadcasted, and optionally
1567 /// check whether an error message event has occurred.
1568 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1569 let mut dummy_connected = false;
1570 if !is_any_peer_connected(node) {
1571 connect_dummy_node(&node);
1572 dummy_connected = true;
1574 let msg_events = node.node.get_and_clear_pending_msg_events();
1575 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1576 if dummy_connected {
1577 disconnect_dummy_node(&node);
1579 msg_events.into_iter().filter_map(|msg_event| {
1581 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1582 assert_eq!(msg.contents.flags & 2, 2);
1585 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1586 assert!(with_error_msg);
1587 // TODO: Check node_id
1590 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1591 assert!(with_error_msg);
1592 // TODO: Check node_id
1595 _ => panic!("Unexpected event"),
1600 /// Check that a channel's closing channel update has been broadcasted, and optionally
1601 /// check whether an error message event has occurred.
1603 /// Don't use this, use the identically-named function instead.
1605 macro_rules! check_closed_broadcast {
1606 ($node: expr, $with_error_msg: expr) => {
1607 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1612 pub struct ExpectedCloseEvent {
1613 pub channel_capacity_sats: Option<u64>,
1614 pub channel_id: Option<ChannelId>,
1615 pub counterparty_node_id: Option<PublicKey>,
1616 pub discard_funding: bool,
1617 pub reason: Option<ClosureReason>,
1618 pub channel_funding_txo: Option<OutPoint>,
1619 pub user_channel_id: Option<u128>,
1622 impl ExpectedCloseEvent {
1623 pub fn from_id_reason(channel_id: ChannelId, discard_funding: bool, reason: ClosureReason) -> Self {
1625 channel_capacity_sats: None,
1626 channel_id: Some(channel_id),
1627 counterparty_node_id: None,
1629 reason: Some(reason),
1630 channel_funding_txo: None,
1631 user_channel_id: None,
1636 /// Check that multiple channel closing events have been issued.
1637 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1638 let closed_events_count = expected_close_events.len();
1639 let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1640 let events = node.node.get_and_clear_pending_events();
1641 assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1642 for expected_event in expected_close_events {
1643 assert!(events.iter().any(|e| matches!(
1645 Event::ChannelClosed {
1648 counterparty_node_id,
1649 channel_capacity_sats,
1650 channel_funding_txo,
1654 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1655 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1657 counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1658 expected_event.channel_capacity_sats
1659 .map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true) &&
1660 expected_event.channel_funding_txo
1661 .map(|expected| *channel_funding_txo == Some(expected)).unwrap_or(true) &&
1662 expected_event.user_channel_id
1663 .map(|expected| *user_channel_id == expected).unwrap_or(true)
1667 assert_eq!(events.iter().filter(|e| matches!(
1669 Event::DiscardFunding { .. },
1670 )).count(), discard_events_count);
1673 /// Check that a channel's closing channel events has been issued
1674 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1675 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1676 let expected_events_count = if is_check_discard_funding {
1677 2 * expected_counterparty_node_ids.len()
1679 expected_counterparty_node_ids.len()
1681 assert_eq!(events_count, expected_events_count);
1682 let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1683 channel_capacity_sats: Some(expected_channel_capacity),
1685 counterparty_node_id: Some(*node_id),
1686 discard_funding: is_check_discard_funding,
1687 reason: Some(expected_reason.clone()),
1688 channel_funding_txo: None,
1689 user_channel_id: None,
1690 }).collect::<Vec<_>>();
1691 check_closed_events(node, expected_close_events.as_slice());
1694 /// Check that a channel's closing channel events has been issued
1696 /// Don't use this, use the identically-named function instead.
1698 macro_rules! check_closed_event {
1699 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1700 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1702 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1703 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1704 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1708 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1709 let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1710 assert_eq!(events.len(), count);
1711 for event in events {
1713 Event::BumpTransaction(bump_event) => {
1714 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1716 node.bump_tx_handler.handle_event(&bump_event);
1723 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) {
1724 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) };
1725 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) };
1728 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1729 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1731 let events_1 = node_b.get_and_clear_pending_msg_events();
1732 assert!(events_1.len() >= 1);
1733 let shutdown_b = match events_1[0] {
1734 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1735 assert_eq!(node_id, &node_a.get_our_node_id());
1738 _ => panic!("Unexpected event"),
1741 let closing_signed_b = if !close_inbound_first {
1742 assert_eq!(events_1.len(), 1);
1745 Some(match events_1[1] {
1746 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1747 assert_eq!(node_id, &node_a.get_our_node_id());
1750 _ => panic!("Unexpected event"),
1754 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1755 let (as_update, bs_update) = if close_inbound_first {
1756 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1757 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1759 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1760 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1761 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1762 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1764 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1765 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1766 assert!(none_a.is_none());
1767 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1768 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1769 (as_update, bs_update)
1771 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1773 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1774 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1776 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1777 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1778 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1780 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1781 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1782 assert!(none_b.is_none());
1783 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1784 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1785 (as_update, bs_update)
1787 assert_eq!(tx_a, tx_b);
1788 check_spends!(tx_a, funding_tx);
1790 (as_update, bs_update, tx_a)
1793 pub struct SendEvent {
1794 pub node_id: PublicKey,
1795 pub msgs: Vec<msgs::UpdateAddHTLC>,
1796 pub commitment_msg: msgs::CommitmentSigned,
1799 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1800 assert!(updates.update_fulfill_htlcs.is_empty());
1801 assert!(updates.update_fail_htlcs.is_empty());
1802 assert!(updates.update_fail_malformed_htlcs.is_empty());
1803 assert!(updates.update_fee.is_none());
1804 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1807 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1809 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1810 _ => panic!("Unexpected event type!"),
1814 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1815 let mut events = node.node.get_and_clear_pending_msg_events();
1816 assert_eq!(events.len(), 1);
1817 SendEvent::from_event(events.pop().unwrap())
1822 /// Don't use this, use the identically-named function instead.
1823 macro_rules! expect_pending_htlcs_forwardable_conditions {
1824 ($node: expr, $expected_failures: expr) => {
1825 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1830 macro_rules! expect_htlc_handling_failed_destinations {
1831 ($events: expr, $expected_failures: expr) => {{
1832 for event in $events {
1834 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1835 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1836 assert!($expected_failures.contains(&failed_next_destination))
1838 _ => panic!("Unexpected destination"),
1844 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1845 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1846 /// `expected_failures` set.
1847 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1848 let count = expected_failures.len() + 1;
1849 assert_eq!(events.len(), count);
1850 assert!(events.iter().find(|event| matches!(event, Event::PendingHTLCsForwardable { .. })).is_some());
1851 if expected_failures.len() > 0 {
1852 expect_htlc_handling_failed_destinations!(events, expected_failures)
1857 /// Clears (and ignores) a PendingHTLCsForwardable event
1859 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1861 macro_rules! expect_pending_htlcs_forwardable_ignore {
1863 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1868 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1870 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1871 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1872 ($node: expr, $expected_failures: expr) => {
1873 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1878 /// Handles a PendingHTLCsForwardable event
1879 macro_rules! expect_pending_htlcs_forwardable {
1881 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1882 $node.node.process_pending_htlc_forwards();
1884 // Ensure process_pending_htlc_forwards is idempotent.
1885 $node.node.process_pending_htlc_forwards();
1890 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1891 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1892 ($node: expr, $expected_failures: expr) => {{
1893 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1894 $node.node.process_pending_htlc_forwards();
1896 // Ensure process_pending_htlc_forwards is idempotent.
1897 $node.node.process_pending_htlc_forwards();
1902 macro_rules! expect_pending_htlcs_forwardable_from_events {
1903 ($node: expr, $events: expr, $ignore: expr) => {{
1904 assert_eq!($events.len(), 1);
1906 Event::PendingHTLCsForwardable { .. } => { },
1907 _ => panic!("Unexpected event"),
1910 $node.node.process_pending_htlc_forwards();
1912 // Ensure process_pending_htlc_forwards is idempotent.
1913 $node.node.process_pending_htlc_forwards();
1919 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1920 /// commitment update.
1921 macro_rules! commitment_signed_dance {
1922 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1923 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1925 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1926 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1928 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1930 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1931 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1932 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1933 check_added_monitors(&$node_a, 1);
1934 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1935 assert!(extra_msg_option.is_none());
1939 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1940 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1942 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1943 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1947 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1948 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1949 /// `revoke_and_ack` response to it.
1951 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1952 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1953 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1954 /// the commitment we're exchanging. `includes_claim` provides that information.
1956 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1957 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1958 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1959 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1960 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1964 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1965 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1966 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1968 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1969 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1970 check_added_monitors!(node_b, 0);
1971 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1972 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1973 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1974 check_added_monitors!(node_b, 1);
1975 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1976 let (bs_revoke_and_ack, extra_msg_option) = {
1977 let mut events = node_b.node.get_and_clear_pending_msg_events();
1978 assert!(events.len() <= 2);
1979 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1980 (match node_a_event {
1981 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1982 assert_eq!(*node_id, node_a.node.get_our_node_id());
1985 _ => panic!("Unexpected event"),
1986 }, events.get(0).map(|e| e.clone()))
1988 check_added_monitors!(node_b, 1);
1990 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1991 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1993 (extra_msg_option, bs_revoke_and_ack)
1996 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1997 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1999 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
2000 /// on failure or that no new messages are left over on success.
2001 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
2002 check_added_monitors!(node_a, 0);
2003 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2004 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
2005 check_added_monitors!(node_a, 1);
2007 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
2008 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
2009 if fail_backwards { assert!(!got_claim); }
2010 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
2012 if skip_last_step { return; }
2015 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
2016 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
2017 check_added_monitors!(node_a, 1);
2019 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
2020 let mut number_of_msg_events = 0;
2021 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
2022 let peer_state = peer_state_mutex.lock().unwrap();
2023 let cp_pending_msg_events = &peer_state.pending_msg_events;
2024 number_of_msg_events += cp_pending_msg_events.len();
2025 if cp_pending_msg_events.len() == 1 {
2026 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
2027 assert_ne!(*cp_id, node_b.node.get_our_node_id());
2028 } else { panic!("Unexpected event"); }
2031 // Expecting the failure backwards event to the previous hop (not `node_b`)
2032 assert_eq!(number_of_msg_events, 1);
2034 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2038 /// Get a payment preimage and hash.
2039 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2040 let mut payment_count = recipient.network_payment_count.borrow_mut();
2041 let payment_preimage = PaymentPreimage([*payment_count; 32]);
2042 *payment_count += 1;
2043 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
2044 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
2045 (payment_preimage, payment_hash, payment_secret)
2048 /// Get a payment preimage and hash.
2050 /// Don't use this, use the identically-named function instead.
2052 macro_rules! get_payment_preimage_hash {
2053 ($dest_node: expr) => {
2054 get_payment_preimage_hash!($dest_node, None)
2056 ($dest_node: expr, $min_value_msat: expr) => {
2057 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
2059 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
2060 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
2064 /// Gets a route from the given sender to the node described in `payment_params`.
2065 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2066 let scorer = TestScorer::new();
2067 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
2068 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2070 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
2071 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2072 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2076 /// Like `get_route` above, but adds a random CLTV offset to the final hop.
2077 pub fn find_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
2078 let scorer = TestScorer::new();
2079 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
2080 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2082 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph,
2083 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
2084 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
2088 /// Gets a route from the given sender to the node described in `payment_params`.
2090 /// Don't use this, use the identically-named function instead.
2092 macro_rules! get_route {
2093 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
2094 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2095 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
2101 macro_rules! get_route_and_payment_hash {
2102 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
2103 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
2104 .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
2105 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
2107 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
2108 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
2110 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
2111 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
2112 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
2113 let (payment_preimage, payment_hash, payment_secret) =
2114 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
2115 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
2116 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
2120 pub fn check_payment_claimable(
2121 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2122 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2123 expected_receiver_node_id: PublicKey,
2126 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2127 assert_eq!(expected_payment_hash, *payment_hash);
2128 assert_eq!(expected_recv_value, *amount_msat);
2129 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2131 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2132 assert_eq!(&expected_payment_preimage, payment_preimage);
2133 assert_eq!(expected_payment_secret, *payment_secret);
2138 _ => panic!("Unexpected event"),
2143 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2144 macro_rules! expect_payment_claimable {
2145 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2146 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2148 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2149 let events = $node.node.get_and_clear_pending_events();
2150 assert_eq!(events.len(), 1);
2151 $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)
2156 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2157 macro_rules! expect_payment_claimed {
2158 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2159 let events = $node.node.get_and_clear_pending_events();
2160 assert_eq!(events.len(), 1);
2162 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2163 assert_eq!($expected_payment_hash, *payment_hash);
2164 assert_eq!($expected_recv_value, amount_msat);
2166 _ => panic!("Unexpected event"),
2171 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2172 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2173 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2175 let events = node.node().get_and_clear_pending_events();
2176 let expected_payment_hash = PaymentHash(
2177 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array());
2178 if expect_per_path_claims {
2179 assert!(events.len() > 1);
2181 assert_eq!(events.len(), 1);
2183 if expect_post_ev_mon_update {
2184 check_added_monitors(node, 1);
2186 let expected_payment_id = match events[0] {
2187 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2188 assert_eq!(expected_payment_preimage, *payment_preimage);
2189 assert_eq!(expected_payment_hash, *payment_hash);
2190 if let Some(expected_fee_msat) = expected_fee_msat_opt {
2191 assert_eq!(*fee_paid_msat, expected_fee_msat);
2193 assert!(fee_paid_msat.is_some());
2197 _ => panic!("Unexpected event"),
2199 if expect_per_path_claims {
2200 for i in 1..events.len() {
2202 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2203 assert_eq!(payment_id, expected_payment_id);
2204 assert_eq!(payment_hash, Some(expected_payment_hash));
2206 _ => panic!("Unexpected event"),
2213 macro_rules! expect_payment_sent {
2214 ($node: expr, $expected_payment_preimage: expr) => {
2215 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2217 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2218 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2220 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2221 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2222 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2228 macro_rules! expect_payment_path_successful {
2230 let events = $node.node.get_and_clear_pending_events();
2231 assert_eq!(events.len(), 1);
2233 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2234 _ => panic!("Unexpected event"),
2239 /// Returns the total fee earned by this HTLC forward, in msat.
2240 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2241 event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2242 expected_extra_fees_msat: Option<u64>, upstream_force_closed: bool,
2243 downstream_force_closed: bool, allow_1_msat_fee_overpay: bool,
2246 Event::PaymentForwarded {
2247 prev_channel_id, next_channel_id, prev_user_channel_id, next_user_channel_id,
2248 total_fee_earned_msat, skimmed_fee_msat, claim_from_onchain_tx, ..
2250 if allow_1_msat_fee_overpay {
2251 // Aggregating fees for blinded paths may result in a rounding error, causing slight
2252 // overpayment in fees.
2253 let actual_fee = total_fee_earned_msat.unwrap();
2254 let expected_fee = expected_fee.unwrap();
2255 assert!(actual_fee == expected_fee || actual_fee == expected_fee + 1);
2257 assert_eq!(total_fee_earned_msat, expected_fee);
2260 // Check that the (knowingly) withheld amount is always less or equal to the expected
2262 assert!(skimmed_fee_msat == expected_extra_fees_msat);
2263 if !upstream_force_closed {
2264 // Is the event prev_channel_id in one of the channels between the two nodes?
2265 assert!(node.node().list_channels().iter().any(|x|
2266 x.counterparty.node_id == prev_node.node().get_our_node_id() &&
2267 x.channel_id == prev_channel_id.unwrap() &&
2268 x.user_channel_id == prev_user_channel_id.unwrap()
2271 // We check for force closures since a force closed channel is removed from the
2272 // node's channel list
2273 if !downstream_force_closed {
2274 // As documented, `next_user_channel_id` will only be `Some` if we didn't settle via an
2275 // onchain transaction, just as the `total_fee_earned_msat` field. Rather than
2276 // introducing yet another variable, we use the latter's state as a flag to detect
2277 // this and only check if it's `Some`.
2278 if total_fee_earned_msat.is_none() {
2279 assert!(node.node().list_channels().iter().any(|x|
2280 x.counterparty.node_id == next_node.node().get_our_node_id() &&
2281 x.channel_id == next_channel_id.unwrap()
2284 assert!(node.node().list_channels().iter().any(|x|
2285 x.counterparty.node_id == next_node.node().get_our_node_id() &&
2286 x.channel_id == next_channel_id.unwrap() &&
2287 x.user_channel_id == next_user_channel_id.unwrap()
2291 assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2292 total_fee_earned_msat
2294 _ => panic!("Unexpected event"),
2299 macro_rules! expect_payment_forwarded {
2300 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2301 let mut events = $node.node.get_and_clear_pending_events();
2302 assert_eq!(events.len(), 1);
2303 $crate::ln::functional_test_utils::expect_payment_forwarded(
2304 events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee, None,
2305 $upstream_force_closed, $downstream_force_closed, false
2312 macro_rules! expect_channel_shutdown_state {
2313 ($node: expr, $chan_id: expr, $state: path) => {
2314 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2315 assert_eq!(chan_details.len(), 1);
2316 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2320 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2321 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2322 let events = node.node.get_and_clear_pending_events();
2323 assert_eq!(events.len(), 1);
2325 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2326 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2329 _ => panic!("Unexpected event"),
2333 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2334 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2335 let events = node.node.get_and_clear_pending_events();
2336 assert_eq!(events.len(), 1);
2338 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2339 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2341 _ => panic!("Unexpected event"),
2345 #[cfg(any(test, feature = "_test_utils"))]
2346 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2347 let mut events = node.node.get_and_clear_pending_events();
2349 for event in events.drain(..) {
2351 Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2352 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2353 assert!(result_idx.is_some());
2355 probe_results.remove(result_idx.unwrap());
2361 // Ensure that we received a ProbeSuccessful event for each probe result.
2362 assert!(probe_results.is_empty());
2365 pub struct PaymentFailedConditions<'a> {
2366 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2367 pub(crate) expected_blamed_scid: Option<u64>,
2368 pub(crate) expected_blamed_chan_closed: Option<bool>,
2369 pub(crate) expected_mpp_parts_remain: bool,
2372 impl<'a> PaymentFailedConditions<'a> {
2373 pub fn new() -> Self {
2375 expected_htlc_error_data: None,
2376 expected_blamed_scid: None,
2377 expected_blamed_chan_closed: None,
2378 expected_mpp_parts_remain: false,
2381 pub fn mpp_parts_remain(mut self) -> Self {
2382 self.expected_mpp_parts_remain = true;
2385 pub fn blamed_scid(mut self, scid: u64) -> Self {
2386 self.expected_blamed_scid = Some(scid);
2389 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2390 self.expected_blamed_chan_closed = Some(closed);
2393 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2394 self.expected_htlc_error_data = Some((code, data));
2400 macro_rules! expect_payment_failed_with_update {
2401 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2402 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2403 &$node, $expected_payment_hash, $payment_failed_permanently,
2404 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2405 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2410 macro_rules! expect_payment_failed {
2411 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2412 #[allow(unused_mut)]
2413 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2415 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2417 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2421 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2422 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2423 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2425 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2426 let expected_payment_id = match &payment_failed_events[0] {
2427 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2431 error_data, .. } => {
2432 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2433 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2436 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2437 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2438 if let Some((code, data)) = conditions.expected_htlc_error_data {
2439 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2440 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2444 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2445 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2447 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2448 if let Some(scid) = conditions.expected_blamed_scid {
2449 assert_eq!(msg.contents.short_channel_id, scid);
2451 const CHAN_DISABLED_FLAG: u8 = 2;
2452 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2454 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2455 if let Some(scid) = conditions.expected_blamed_scid {
2456 assert_eq!(*short_channel_id, scid);
2458 assert!(is_permanent);
2460 _ => panic!("Unexpected update type"),
2462 } else { panic!("Expected network update"); }
2467 _ => panic!("Unexpected event"),
2469 if !conditions.expected_mpp_parts_remain {
2470 match &payment_failed_events[1] {
2471 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2472 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2473 assert_eq!(*payment_id, expected_payment_id);
2474 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2475 PaymentFailureReason::RecipientRejected
2477 PaymentFailureReason::RetriesExhausted
2480 _ => panic!("Unexpected second event"),
2485 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2486 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2487 conditions: PaymentFailedConditions<'e>
2489 let events = node.node.get_and_clear_pending_events();
2490 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2493 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 {
2494 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2495 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2496 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2497 check_added_monitors!(origin_node, expected_paths.len());
2498 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2502 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2503 let origin_node_id = expected_path[0].node.get_our_node_id();
2505 // iterate from the receiving node to the origin node and handle update fail htlc.
2506 for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2507 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2508 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2509 check_added_monitors!(prev_node, 0);
2511 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2512 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2513 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2517 pub struct PassAlongPathArgs<'a, 'b, 'c, 'd> {
2518 pub origin_node: &'a Node<'b, 'c, 'd>,
2519 pub expected_path: &'a [&'a Node<'b, 'c, 'd>],
2520 pub recv_value: u64,
2521 pub payment_hash: PaymentHash,
2522 pub payment_secret: Option<PaymentSecret>,
2523 pub event: MessageSendEvent,
2524 pub payment_claimable_expected: bool,
2525 pub clear_recipient_events: bool,
2526 pub expected_preimage: Option<PaymentPreimage>,
2528 pub custom_tlvs: Vec<(u64, Vec<u8>)>,
2531 impl<'a, 'b, 'c, 'd> PassAlongPathArgs<'a, 'b, 'c, 'd> {
2533 origin_node: &'a Node<'b, 'c, 'd>, expected_path: &'a [&'a Node<'b, 'c, 'd>], recv_value: u64,
2534 payment_hash: PaymentHash, event: MessageSendEvent,
2537 origin_node, expected_path, recv_value, payment_hash, payment_secret: None, event,
2538 payment_claimable_expected: true, clear_recipient_events: true, expected_preimage: None,
2539 is_probe: false, custom_tlvs: Vec::new(),
2542 pub fn without_clearing_recipient_events(mut self) -> Self {
2543 self.clear_recipient_events = false;
2546 pub fn is_probe(mut self) -> Self {
2547 self.payment_claimable_expected = false;
2548 self.is_probe = true;
2551 pub fn without_claimable_event(mut self) -> Self {
2552 self.payment_claimable_expected = false;
2555 pub fn with_payment_secret(mut self, payment_secret: PaymentSecret) -> Self {
2556 self.payment_secret = Some(payment_secret);
2559 pub fn with_payment_preimage(mut self, payment_preimage: PaymentPreimage) -> Self {
2560 self.expected_preimage = Some(payment_preimage);
2563 pub fn with_custom_tlvs(mut self, custom_tlvs: Vec<(u64, Vec<u8>)>) -> Self {
2564 self.custom_tlvs = custom_tlvs;
2569 pub fn do_pass_along_path<'a, 'b, 'c>(args: PassAlongPathArgs) -> Option<Event> {
2570 let PassAlongPathArgs {
2571 origin_node, expected_path, recv_value, payment_hash: our_payment_hash,
2572 payment_secret: our_payment_secret, event: ev, payment_claimable_expected,
2573 clear_recipient_events, expected_preimage, is_probe, custom_tlvs
2576 let mut payment_event = SendEvent::from_event(ev);
2577 let mut prev_node = origin_node;
2578 let mut event = None;
2580 for (idx, &node) in expected_path.iter().enumerate() {
2581 let is_last_hop = idx == expected_path.len() - 1;
2582 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2584 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2585 check_added_monitors!(node, 0);
2587 if is_last_hop && is_probe {
2588 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2590 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2591 expect_pending_htlcs_forwardable!(node);
2594 if is_last_hop && clear_recipient_events {
2595 let events_2 = node.node.get_and_clear_pending_events();
2596 if payment_claimable_expected {
2597 assert_eq!(events_2.len(), 1);
2598 match &events_2[0] {
2599 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2600 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2601 claim_deadline, onion_fields, ..
2603 assert_eq!(our_payment_hash, *payment_hash);
2604 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2605 assert!(onion_fields.is_some());
2606 assert_eq!(onion_fields.as_ref().unwrap().custom_tlvs, custom_tlvs);
2608 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2609 assert_eq!(expected_preimage, *payment_preimage);
2610 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2611 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2613 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2614 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2615 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2618 assert_eq!(*amount_msat, recv_value);
2619 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2620 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2621 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2623 _ => panic!("Unexpected event"),
2625 event = Some(events_2[0].clone());
2627 assert!(events_2.is_empty());
2629 } else if !is_last_hop {
2630 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2631 assert_eq!(events_2.len(), 1);
2632 check_added_monitors!(node, 1);
2633 payment_event = SendEvent::from_event(events_2.remove(0));
2634 assert_eq!(payment_event.msgs.len(), 1);
2642 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> {
2643 let mut args = PassAlongPathArgs::new(origin_node, expected_path, recv_value, our_payment_hash, ev);
2644 if !payment_claimable_expected {
2645 args = args.without_claimable_event();
2647 if let Some(payment_secret) = our_payment_secret {
2648 args = args.with_payment_secret(payment_secret);
2650 if let Some(payment_preimage) = expected_preimage {
2651 args = args.with_payment_preimage(payment_preimage);
2653 do_pass_along_path(args)
2656 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2657 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2658 assert_eq!(events.len(), expected_route.len());
2660 check_added_monitors!(origin_node, expected_route.len());
2662 for path in expected_route.iter() {
2663 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2665 do_pass_along_path(PassAlongPathArgs::new(origin_node, path, 0, PaymentHash([0_u8; 32]), ev)
2667 .without_clearing_recipient_events());
2669 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2671 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2675 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) {
2676 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2677 assert_eq!(events.len(), expected_route.len());
2679 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2680 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2681 // Once we've gotten through all the HTLCs, the last one should result in a
2682 // PaymentClaimable (but each previous one should not!).
2683 let expect_payment = path_idx == expected_route.len() - 1;
2684 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2688 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) {
2689 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2690 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2691 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2694 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2695 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2696 our_payment_preimage: PaymentPreimage
2698 for path in expected_paths.iter() {
2699 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2701 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2702 pass_claimed_payment_along_route(
2703 ClaimAlongRouteArgs::new(origin_node, expected_paths, our_payment_preimage)
2704 .skip_last(skip_last)
2708 pub struct ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2709 pub origin_node: &'a Node<'b, 'c, 'd>,
2710 pub expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2711 pub expected_extra_fees: Vec<u32>,
2712 pub expected_min_htlc_overpay: Vec<u32>,
2713 pub skip_last: bool,
2714 pub payment_preimage: PaymentPreimage,
2715 // Allow forwarding nodes to have taken 1 msat more fee than expected based on the downstream
2718 // Necessary because our test utils calculate the expected fee for an intermediate node based on
2719 // the amount was claimed in their downstream peer's fulfill, but blinded intermediate nodes
2720 // calculate their fee based on the inbound amount from their upstream peer, causing a difference
2722 pub allow_1_msat_fee_overpay: bool,
2725 impl<'a, 'b, 'c, 'd> ClaimAlongRouteArgs<'a, 'b, 'c, 'd> {
2727 origin_node: &'a Node<'b, 'c, 'd>, expected_paths: &'a [&'a [&'a Node<'b, 'c, 'd>]],
2728 payment_preimage: PaymentPreimage,
2731 origin_node, expected_paths, expected_extra_fees: vec![0; expected_paths.len()],
2732 expected_min_htlc_overpay: vec![0; expected_paths.len()], skip_last: false, payment_preimage,
2733 allow_1_msat_fee_overpay: false,
2736 pub fn skip_last(mut self, skip_last: bool) -> Self {
2737 self.skip_last = skip_last;
2740 pub fn with_expected_extra_fees(mut self, extra_fees: Vec<u32>) -> Self {
2741 self.expected_extra_fees = extra_fees;
2744 pub fn with_expected_min_htlc_overpay(mut self, extra_fees: Vec<u32>) -> Self {
2745 self.expected_min_htlc_overpay = extra_fees;
2748 pub fn allow_1_msat_fee_overpay(mut self) -> Self {
2749 self.allow_1_msat_fee_overpay = true;
2754 pub fn pass_claimed_payment_along_route<'a, 'b, 'c, 'd>(args: ClaimAlongRouteArgs) -> u64 {
2755 let ClaimAlongRouteArgs {
2756 origin_node, expected_paths, expected_extra_fees, expected_min_htlc_overpay, skip_last,
2757 payment_preimage: our_payment_preimage, allow_1_msat_fee_overpay,
2759 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2760 assert_eq!(claim_event.len(), 1);
2762 let mut fwd_amt_msat = 0;
2763 match claim_event[0] {
2764 Event::PaymentClaimed {
2765 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2769 | Event::PaymentClaimed {
2770 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2775 assert_eq!(preimage, our_payment_preimage);
2776 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2777 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2778 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2779 fwd_amt_msat = amount_msat;
2781 Event::PaymentClaimed {
2782 purpose: PaymentPurpose::InvoicePayment { .. },
2788 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2789 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2790 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2791 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2792 fwd_amt_msat = amount_msat;
2797 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2799 let mut expected_total_fee_msat = 0;
2801 macro_rules! msgs_from_ev {
2804 &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 } } => {
2805 assert!(update_add_htlcs.is_empty());
2806 assert_eq!(update_fulfill_htlcs.len(), 1);
2807 assert!(update_fail_htlcs.is_empty());
2808 assert!(update_fail_malformed_htlcs.is_empty());
2809 assert!(update_fee.is_none());
2810 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2812 _ => panic!("Unexpected event"),
2816 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2817 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2818 assert_eq!(events.len(), expected_paths.len());
2820 if events.len() == 1 {
2821 per_path_msgs.push(msgs_from_ev!(&events[0]));
2823 for expected_path in expected_paths.iter() {
2824 // For MPP payments, we want the fulfill message from the payee to the penultimate hop in the
2826 let penultimate_hop_node_id = expected_path.iter().rev().skip(1).next()
2827 .map(|n| n.node.get_our_node_id())
2828 .unwrap_or(origin_node.node.get_our_node_id());
2829 let ev = remove_first_msg_event_to_node(&penultimate_hop_node_id, &mut events);
2830 per_path_msgs.push(msgs_from_ev!(&ev));
2834 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2835 let mut next_msgs = Some(path_msgs);
2836 let mut expected_next_node = next_hop;
2838 macro_rules! last_update_fulfill_dance {
2839 ($node: expr, $prev_node: expr) => {
2841 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2842 check_added_monitors!($node, 0);
2843 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2844 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2848 macro_rules! mid_update_fulfill_dance {
2849 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2851 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2853 let (base_fee, prop_fee) = {
2854 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2855 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2856 .unwrap().lock().unwrap();
2857 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2858 if let Some(prev_config) = channel.context().prev_config() {
2859 (prev_config.forwarding_fee_base_msat as u64,
2860 prev_config.forwarding_fee_proportional_millionths as u64)
2862 (channel.context().config().forwarding_fee_base_msat as u64,
2863 channel.context().config().forwarding_fee_proportional_millionths as u64)
2866 ((fwd_amt_msat * prop_fee / 1_000_000) + base_fee) as u32
2869 let mut expected_extra_fee = None;
2871 fee += expected_extra_fees[i];
2872 fee += expected_min_htlc_overpay[i];
2873 expected_extra_fee = if expected_extra_fees[i] > 0 { Some(expected_extra_fees[i] as u64) } else { None };
2875 let mut events = $node.node.get_and_clear_pending_events();
2876 assert_eq!(events.len(), 1);
2877 let actual_fee = expect_payment_forwarded(events.pop().unwrap(), *$node, $next_node, $prev_node,
2878 Some(fee as u64), expected_extra_fee, false, false, allow_1_msat_fee_overpay);
2879 expected_total_fee_msat += actual_fee.unwrap();
2880 fwd_amt_msat += actual_fee.unwrap();
2881 check_added_monitors!($node, 1);
2882 let new_next_msgs = if $new_msgs {
2883 let events = $node.node.get_and_clear_pending_msg_events();
2884 assert_eq!(events.len(), 1);
2885 let (res, nexthop) = msgs_from_ev!(&events[0]);
2886 expected_next_node = nexthop;
2889 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2892 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2893 next_msgs = new_next_msgs;
2898 let mut prev_node = expected_route.last().unwrap();
2899 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2900 assert_eq!(expected_next_node, node.node.get_our_node_id());
2901 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2902 if next_msgs.is_some() {
2903 // Since we are traversing in reverse, next_node is actually the previous node
2904 let next_node: &Node;
2905 if idx == expected_route.len() - 1 {
2906 next_node = origin_node;
2908 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2910 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2912 assert!(!update_next_msgs);
2913 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2915 if !skip_last && idx == expected_route.len() - 1 {
2916 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2923 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2927 // Ensure that claim_funds is idempotent.
2928 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2929 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2930 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2932 expected_total_fee_msat
2934 pub fn claim_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_preimage: PaymentPreimage) {
2935 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2937 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2941 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2942 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2945 pub const TEST_FINAL_CLTV: u32 = 70;
2947 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) {
2948 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2949 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2950 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2951 let route = get_route(origin_node, &route_params).unwrap();
2952 assert_eq!(route.paths.len(), 1);
2953 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2954 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2955 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2958 let res = send_along_route(origin_node, route, expected_route, recv_value);
2959 (res.0, res.1, res.2, res.3)
2962 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2963 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2964 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2965 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2966 let network_graph = origin_node.network_graph.read_only();
2967 let scorer = test_utils::TestScorer::new();
2968 let seed = [0u8; 32];
2969 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2970 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2971 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2972 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2973 assert_eq!(route.paths.len(), 1);
2974 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2975 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2976 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2979 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2980 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2981 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2982 true, APIError::ChannelUnavailable { ref err },
2983 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2986 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) {
2987 let res = route_payment(&origin, expected_route, recv_value);
2988 claim_payment(&origin, expected_route, res.0);
2992 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) {
2993 for path in expected_paths.iter() {
2994 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2996 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2997 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2998 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
3000 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
3003 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) {
3004 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
3005 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
3007 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
3008 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
3009 assert_eq!(events.len(), expected_paths.len());
3010 for ev in events.iter() {
3011 let (update_fail, commitment_signed, node_id) = match ev {
3012 &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 } } => {
3013 assert!(update_add_htlcs.is_empty());
3014 assert!(update_fulfill_htlcs.is_empty());
3015 assert_eq!(update_fail_htlcs.len(), 1);
3016 assert!(update_fail_malformed_htlcs.is_empty());
3017 assert!(update_fee.is_none());
3018 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
3020 _ => panic!("Unexpected event"),
3022 per_path_msgs.push(((update_fail, commitment_signed), node_id));
3024 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
3025 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()));
3027 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
3028 let mut next_msgs = Some(path_msgs);
3029 let mut expected_next_node = next_hop;
3030 let mut prev_node = expected_route.last().unwrap();
3032 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
3033 assert_eq!(expected_next_node, node.node.get_our_node_id());
3034 let update_next_node = !skip_last || idx != expected_route.len() - 1;
3035 if next_msgs.is_some() {
3036 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
3037 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
3038 if !update_next_node {
3039 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 }]);
3042 let events = node.node.get_and_clear_pending_msg_events();
3043 if update_next_node {
3044 assert_eq!(events.len(), 1);
3046 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 } } => {
3047 assert!(update_add_htlcs.is_empty());
3048 assert!(update_fulfill_htlcs.is_empty());
3049 assert_eq!(update_fail_htlcs.len(), 1);
3050 assert!(update_fail_malformed_htlcs.is_empty());
3051 assert!(update_fee.is_none());
3052 expected_next_node = node_id.clone();
3053 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
3055 _ => panic!("Unexpected event"),
3058 assert!(events.is_empty());
3060 if !skip_last && idx == expected_route.len() - 1 {
3061 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3068 let prev_node = expected_route.first().unwrap();
3069 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
3070 check_added_monitors!(origin_node, 0);
3071 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
3072 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
3073 let events = origin_node.node.get_and_clear_pending_events();
3074 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
3076 let expected_payment_id = match events[0] {
3077 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
3078 assert_eq!(payment_hash, our_payment_hash);
3079 assert!(payment_failed_permanently);
3080 for (idx, hop) in expected_route.iter().enumerate() {
3081 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
3085 _ => panic!("Unexpected event"),
3087 if i == expected_paths.len() - 1 {
3089 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
3090 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
3091 assert_eq!(*payment_id, expected_payment_id);
3092 assert_eq!(reason.unwrap(), expected_fail_reason);
3094 _ => panic!("Unexpected second event"),
3100 // Ensure that fail_htlc_backwards is idempotent.
3101 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
3102 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
3103 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
3104 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
3107 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
3108 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
3111 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
3112 let mut chan_mon_cfgs = Vec::new();
3113 for i in 0..node_count {
3114 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
3115 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
3116 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
3117 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
3118 let persister = test_utils::TestPersister::new();
3119 let seed = [i as u8; 32];
3120 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
3121 let scorer = RwLock::new(test_utils::TestScorer::new());
3123 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
3129 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
3130 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
3133 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>> {
3134 let mut nodes = Vec::new();
3136 for i in 0..node_count {
3137 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);
3138 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
3139 let seed = [i as u8; 32];
3140 nodes.push(NodeCfg {
3141 chain_source: &chanmon_cfgs[i].chain_source,
3142 logger: &chanmon_cfgs[i].logger,
3143 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
3144 fee_estimator: &chanmon_cfgs[i].fee_estimator,
3145 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].logger, &chanmon_cfgs[i].scorer),
3146 message_router: test_utils::TestMessageRouter::new(network_graph.clone(), &chanmon_cfgs[i].keys_manager),
3148 keys_manager: &chanmon_cfgs[i].keys_manager,
3151 override_init_features: Rc::new(RefCell::new(None)),
3158 pub fn test_default_channel_config() -> UserConfig {
3159 let mut default_config = UserConfig::default();
3160 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
3161 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
3162 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
3163 default_config.channel_handshake_config.announced_channel = true;
3164 default_config.channel_handshake_limits.force_announced_channel_preference = false;
3165 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
3166 // It now defaults to 1, so we simply set it to the expected value here.
3167 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
3168 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
3169 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
3171 default_config.channel_config.max_dust_htlc_exposure =
3172 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
3176 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>> {
3177 let mut chanmgrs = Vec::new();
3178 for i in 0..node_count {
3179 let network = Network::Testnet;
3180 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
3181 let params = ChainParameters {
3183 best_block: BestBlock::from_network(network),
3185 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,
3186 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);
3187 chanmgrs.push(node);
3193 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>> {
3194 let mut nodes = Vec::new();
3195 let chan_count = Rc::new(RefCell::new(0));
3196 let payment_count = Rc::new(RefCell::new(0));
3197 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
3199 for i in 0..node_count {
3200 let dedicated_entropy = DedicatedEntropy(RandomBytes::new([i as u8; 32]));
3201 let onion_messenger = OnionMessenger::new(
3202 dedicated_entropy, cfgs[i].keys_manager, cfgs[i].logger, &cfgs[i].message_router,
3203 &chan_mgrs[i], IgnoringMessageHandler {},
3205 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
3206 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
3208 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
3209 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
3210 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
3211 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
3212 node_seed: cfgs[i].node_seed, onion_messenger, network_chan_count: chan_count.clone(),
3213 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
3214 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
3215 connect_style: Rc::clone(&connect_style),
3216 override_init_features: Rc::clone(&cfgs[i].override_init_features),
3217 wallet_source: Arc::clone(&wallet_source),
3218 bump_tx_handler: BumpTransactionEventHandler::new(
3219 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
3220 &cfgs[i].keys_manager, cfgs[i].logger,
3225 for i in 0..node_count {
3226 for j in (i+1)..node_count {
3227 let node_id_i = nodes[i].node.get_our_node_id();
3228 let node_id_j = nodes[j].node.get_our_node_id();
3230 let init_i = msgs::Init {
3231 features: nodes[i].init_features(&node_id_j),
3233 remote_network_address: None,
3235 let init_j = msgs::Init {
3236 features: nodes[j].init_features(&node_id_i),
3238 remote_network_address: None,
3241 nodes[i].node.peer_connected(&node_id_j, &init_j, true).unwrap();
3242 nodes[j].node.peer_connected(&node_id_i, &init_i, false).unwrap();
3243 nodes[i].onion_messenger.peer_connected(&node_id_j, &init_j, true).unwrap();
3244 nodes[j].onion_messenger.peer_connected(&node_id_i, &init_i, false).unwrap();
3251 pub fn connect_dummy_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) {
3252 let node_id_dummy = PublicKey::from_slice(&[2; 33]).unwrap();
3254 let mut dummy_init_features = InitFeatures::empty();
3255 dummy_init_features.set_static_remote_key_required();
3257 let init_dummy = msgs::Init {
3258 features: dummy_init_features,
3260 remote_network_address: None
3263 node.node.peer_connected(&node_id_dummy, &init_dummy, true).unwrap();
3264 node.onion_messenger.peer_connected(&node_id_dummy, &init_dummy, true).unwrap();
3267 pub fn disconnect_dummy_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) {
3268 let node_id_dummy = PublicKey::from_slice(&[2; 33]).unwrap();
3269 node.node.peer_disconnected(&node_id_dummy);
3270 node.onion_messenger.peer_disconnected(&node_id_dummy);
3273 // Note that the following only works for CLTV values up to 128
3274 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3275 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
3277 #[derive(PartialEq)]
3278 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
3279 /// Tests that the given node has broadcast transactions for the given Channel
3281 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
3282 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
3283 /// broadcast and the revoked outputs were claimed.
3285 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
3286 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
3288 /// All broadcast transactions must be accounted for in one of the above three types of we'll
3290 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> {
3291 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3292 let mut txn_seen = new_hash_set();
3293 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3294 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
3296 let mut res = Vec::with_capacity(2);
3297 node_txn.retain(|tx| {
3298 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
3299 check_spends!(tx, chan.3);
3300 if commitment_tx.is_none() {
3301 res.push(tx.clone());
3306 if let Some(explicit_tx) = commitment_tx {
3307 res.push(explicit_tx.clone());
3310 assert_eq!(res.len(), 1);
3312 if has_htlc_tx != HTLCType::NONE {
3313 node_txn.retain(|tx| {
3314 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
3315 check_spends!(tx, res[0]);
3316 if has_htlc_tx == HTLCType::TIMEOUT {
3317 assert_ne!(tx.lock_time, LockTime::ZERO);
3319 assert_eq!(tx.lock_time, LockTime::ZERO);
3321 res.push(tx.clone());
3325 assert!(res.len() == 2 || res.len() == 3);
3327 assert_eq!(res[1], res[2]);
3331 assert!(node_txn.is_empty());
3335 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3336 /// HTLC transaction.
3337 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
3338 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3339 // We may issue multiple claiming transaction on revoked outputs due to block rescan
3340 // for revoked htlc outputs
3341 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3342 node_txn.retain(|tx| {
3343 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3344 check_spends!(tx, revoked_tx);
3348 node_txn.retain(|tx| {
3349 check_spends!(tx, commitment_revoked_tx);
3352 assert!(node_txn.is_empty());
3355 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3356 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3357 let mut txn_seen = new_hash_set();
3358 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3360 let mut found_prev = false;
3361 for prev_tx in prev_txn {
3362 for tx in &*node_txn {
3363 if tx.input[0].previous_output.txid == prev_tx.txid() {
3364 check_spends!(tx, prev_tx);
3365 let mut iter = tx.input[0].witness.iter();
3366 iter.next().expect("expected 3 witness items");
3367 iter.next().expect("expected 3 witness items");
3368 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3369 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3376 assert!(found_prev);
3378 let mut res = Vec::new();
3379 mem::swap(&mut *node_txn, &mut res);
3383 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) {
3384 let mut dummy_connected = false;
3385 if !is_any_peer_connected(&nodes[a]) {
3386 connect_dummy_node(&nodes[a]);
3387 dummy_connected = true
3390 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3391 assert_eq!(events_1.len(), 2);
3392 let as_update = match events_1[1] {
3393 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3396 _ => panic!("Unexpected event"),
3399 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3400 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3401 assert_eq!(msg.data, expected_error);
3402 if needs_err_handle {
3403 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3406 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3407 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3408 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3409 if needs_err_handle {
3410 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3413 _ => panic!("Unexpected event"),
3415 if dummy_connected {
3416 disconnect_dummy_node(&nodes[a]);
3417 dummy_connected = false;
3419 if !is_any_peer_connected(&nodes[b]) {
3420 connect_dummy_node(&nodes[b]);
3421 dummy_connected = true;
3423 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3424 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3425 let bs_update = match events_2.last().unwrap() {
3426 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3429 _ => panic!("Unexpected event"),
3431 if !needs_err_handle {
3433 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3434 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3435 assert_eq!(msg.data, expected_error);
3437 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3438 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3439 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3441 _ => panic!("Unexpected event"),
3444 if dummy_connected {
3445 disconnect_dummy_node(&nodes[b]);
3448 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3449 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3453 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
3454 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3458 macro_rules! get_channel_value_stat {
3459 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3460 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3461 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3462 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3463 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3464 ).flatten().unwrap();
3465 chan.get_value_stat()
3469 macro_rules! get_chan_reestablish_msgs {
3470 ($src_node: expr, $dst_node: expr) => {
3472 let mut announcements = $crate::prelude::new_hash_set();
3473 let mut res = Vec::with_capacity(1);
3474 for msg in $src_node.node.get_and_clear_pending_msg_events() {
3475 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3476 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3477 res.push(msg.clone());
3478 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3479 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3480 announcements.insert(msg.contents.short_channel_id);
3482 panic!("Unexpected event")
3485 assert!(announcements.is_empty());
3491 macro_rules! handle_chan_reestablish_msgs {
3492 ($src_node: expr, $dst_node: expr) => {
3494 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3496 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3498 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3504 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3506 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3509 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3510 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3511 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3513 had_channel_update = true;
3516 let mut revoke_and_ack = None;
3517 let mut commitment_update = None;
3518 let order = if let Some(ev) = msg_events.get(idx) {
3520 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3521 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3522 revoke_and_ack = Some(msg.clone());
3524 RAACommitmentOrder::RevokeAndACKFirst
3526 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3527 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3528 commitment_update = Some(updates.clone());
3530 RAACommitmentOrder::CommitmentFirst
3532 _ => RAACommitmentOrder::CommitmentFirst,
3535 RAACommitmentOrder::CommitmentFirst
3538 if let Some(ev) = msg_events.get(idx) {
3540 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3541 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3542 assert!(revoke_and_ack.is_none());
3543 revoke_and_ack = Some(msg.clone());
3546 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3547 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3548 assert!(commitment_update.is_none());
3549 commitment_update = Some(updates.clone());
3556 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3557 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3559 assert!(!had_channel_update);
3562 assert_eq!(msg_events.len(), idx);
3564 (channel_ready, revoke_and_ack, commitment_update, order)
3569 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3570 pub node_a: &'a Node<'b, 'c, 'd>,
3571 pub node_b: &'a Node<'b, 'c, 'd>,
3572 pub send_channel_ready: (bool, bool),
3573 pub pending_responding_commitment_signed: (bool, bool),
3574 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3575 /// and no monitor update is expected
3576 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3577 pub pending_htlc_adds: (usize, usize),
3578 pub pending_htlc_claims: (usize, usize),
3579 pub pending_htlc_fails: (usize, usize),
3580 pub pending_cell_htlc_claims: (usize, usize),
3581 pub pending_cell_htlc_fails: (usize, usize),
3582 pub pending_raa: (bool, bool),
3585 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3586 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3590 send_channel_ready: (false, false),
3591 pending_responding_commitment_signed: (false, false),
3592 pending_responding_commitment_signed_dup_monitor: (false, false),
3593 pending_htlc_adds: (0, 0),
3594 pending_htlc_claims: (0, 0),
3595 pending_htlc_fails: (0, 0),
3596 pending_cell_htlc_claims: (0, 0),
3597 pending_cell_htlc_fails: (0, 0),
3598 pending_raa: (false, false),
3603 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3604 /// for claims/fails they are separated out.
3605 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3607 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3608 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3609 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3611 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3612 features: node_b.node.init_features(), networks: None, remote_network_address: None
3614 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3615 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3616 features: node_a.node.init_features(), networks: None, remote_network_address: None
3618 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3620 if send_channel_ready.0 {
3621 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3623 for reestablish in reestablish_1.iter() {
3624 let n = reestablish.next_remote_commitment_number;
3625 assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3628 if send_channel_ready.1 {
3629 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3631 for reestablish in reestablish_2.iter() {
3632 let n = reestablish.next_remote_commitment_number;
3633 assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3636 if send_channel_ready.0 || send_channel_ready.1 {
3637 // If we expect any channel_ready's, both sides better have set
3638 // next_holder_commitment_number to 1
3639 for reestablish in reestablish_1.iter() {
3640 let n = reestablish.next_local_commitment_number;
3641 assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3643 for reestablish in reestablish_2.iter() {
3644 let n = reestablish.next_local_commitment_number;
3645 assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3649 let mut resp_1 = Vec::new();
3650 for msg in reestablish_1 {
3651 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3652 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3654 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3655 check_added_monitors!(node_b, 1);
3657 check_added_monitors!(node_b, 0);
3660 let mut resp_2 = Vec::new();
3661 for msg in reestablish_2 {
3662 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3663 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3665 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3666 check_added_monitors!(node_a, 1);
3668 check_added_monitors!(node_a, 0);
3671 // We don't yet support both needing updates, as that would require a different commitment dance:
3672 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3673 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3674 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3675 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3677 for chan_msgs in resp_1.drain(..) {
3678 if send_channel_ready.0 {
3679 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3680 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3681 if !announcement_event.is_empty() {
3682 assert_eq!(announcement_event.len(), 1);
3683 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3684 //TODO: Test announcement_sigs re-sending
3685 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3688 assert!(chan_msgs.0.is_none());
3691 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3692 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3693 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3694 check_added_monitors!(node_a, 1);
3696 assert!(chan_msgs.1.is_none());
3698 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3699 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3700 pending_responding_commitment_signed.0
3702 let commitment_update = chan_msgs.2.unwrap();
3703 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3704 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3705 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3706 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3707 for update_add in commitment_update.update_add_htlcs {
3708 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3710 for update_fulfill in commitment_update.update_fulfill_htlcs {
3711 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3713 for update_fail in commitment_update.update_fail_htlcs {
3714 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3717 if !pending_responding_commitment_signed.0 {
3718 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3720 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3721 check_added_monitors!(node_a, 1);
3722 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3723 // No commitment_signed so get_event_msg's assert(len == 1) passes
3724 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3725 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3726 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3729 assert!(chan_msgs.2.is_none());
3733 for chan_msgs in resp_2.drain(..) {
3734 if send_channel_ready.1 {
3735 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3736 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3737 if !announcement_event.is_empty() {
3738 assert_eq!(announcement_event.len(), 1);
3739 match announcement_event[0] {
3740 MessageSendEvent::SendChannelUpdate { .. } => {},
3741 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3742 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3746 assert!(chan_msgs.0.is_none());
3749 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3750 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3751 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3752 check_added_monitors!(node_b, 1);
3754 assert!(chan_msgs.1.is_none());
3756 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3757 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3758 pending_responding_commitment_signed.1
3760 let commitment_update = chan_msgs.2.unwrap();
3761 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3762 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3763 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3764 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3765 for update_add in commitment_update.update_add_htlcs {
3766 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3768 for update_fulfill in commitment_update.update_fulfill_htlcs {
3769 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3771 for update_fail in commitment_update.update_fail_htlcs {
3772 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3775 if !pending_responding_commitment_signed.1 {
3776 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3778 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3779 check_added_monitors!(node_b, 1);
3780 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3781 // No commitment_signed so get_event_msg's assert(len == 1) passes
3782 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3783 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3784 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3787 assert!(chan_msgs.2.is_none());
3792 /// Initiates channel opening and creates a single batch funding transaction.
3793 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3794 /// transaction with corresponding funding_created messages.
3795 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3796 funding_node: &Node<'a, 'b, 'c>,
3797 params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3798 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3799 let mut tx_outs = Vec::new();
3800 let mut temp_chan_ids = Vec::new();
3801 let mut funding_created_msgs = Vec::new();
3803 for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3804 // Initialize channel opening.
3805 let temp_chan_id = funding_node.node.create_channel(
3806 other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3810 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3811 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3812 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3813 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3815 // Create the corresponding funding output.
3816 let events = funding_node.node.get_and_clear_pending_events();
3817 assert_eq!(events.len(), 1);
3819 Event::FundingGenerationReady {
3820 ref temporary_channel_id,
3821 ref counterparty_node_id,
3822 channel_value_satoshis: ref event_channel_value_satoshis,
3824 user_channel_id: ref event_user_channel_id
3826 assert_eq!(temporary_channel_id, &temp_chan_id);
3827 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3828 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3829 assert_eq!(user_channel_id, event_user_channel_id);
3830 tx_outs.push(TxOut {
3831 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3834 _ => panic!("Unexpected event"),
3836 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3839 // Compose the batch funding transaction and give it to the ChannelManager.
3840 let tx = Transaction {
3842 lock_time: LockTime::ZERO,
3846 assert!(funding_node.node.batch_funding_transaction_generated(
3847 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3850 check_added_monitors!(funding_node, 0);
3851 let events = funding_node.node.get_and_clear_pending_msg_events();
3852 assert_eq!(events.len(), params.len());
3853 for (other_node, ..) in params {
3854 let funding_created = events
3856 .find_map(|event| match event {
3857 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3861 funding_created_msgs.push(funding_created);
3863 return (tx, funding_created_msgs);