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::sign::EntropySource;
15 use crate::chain::channelmonitor::ChannelMonitor;
16 use crate::chain::transaction::OutPoint;
17 use crate::events::{ClaimedHTLC, ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
18 use crate::events::bump_transaction::{BumpTransactionEvent, BumpTransactionEventHandler, Wallet, WalletSource};
19 use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
20 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
21 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
22 use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
23 use crate::ln::features::InitFeatures;
25 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
26 use crate::util::test_channel_signer::TestChannelSigner;
27 use crate::util::scid_utils;
28 use crate::util::test_utils;
29 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
30 use crate::util::errors::APIError;
31 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
32 use crate::util::ser::{ReadableArgs, Writeable};
34 use bitcoin::blockdata::block::{Block, BlockHeader};
35 use bitcoin::blockdata::transaction::{Transaction, TxOut};
36 use bitcoin::hash_types::BlockHash;
37 use bitcoin::hashes::sha256::Hash as Sha256;
38 use bitcoin::hashes::Hash as _;
39 use bitcoin::network::constants::Network;
40 use bitcoin::secp256k1::{PublicKey, SecretKey};
43 use crate::prelude::*;
44 use core::cell::RefCell;
46 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
48 use core::iter::repeat;
49 use bitcoin::{PackedLockTime, TxIn, TxMerkleNode};
51 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
53 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
54 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
56 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
57 /// output is the 1st output in the transaction.
58 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
59 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
60 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
63 /// Mine a single block containing the given transaction
65 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
66 /// output is the 1st output in the transaction.
67 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
68 let height = node.best_block_info().1 + 1;
69 confirm_transaction_at(node, tx, height)
71 /// Mine a single block containing the given transactions
72 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
73 let height = node.best_block_info().1 + 1;
74 confirm_transactions_at(node, txn, height);
76 /// Mine a single block containing the given transaction without extra consistency checks which may
77 /// impact ChannelManager state.
78 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
79 let height = node.best_block_info().1 + 1;
80 let mut block = Block {
81 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
84 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
85 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
87 block.txdata.push((*tx).clone());
88 do_connect_block_without_consistency_checks(node, block, false);
90 /// Mine the given transaction at the given height, mining blocks as required to build to that
93 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
94 /// output is the 1st output in the transaction.
95 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
96 let first_connect_height = node.best_block_info().1 + 1;
97 assert!(first_connect_height <= conf_height);
98 if conf_height > first_connect_height {
99 connect_blocks(node, conf_height - first_connect_height);
101 let mut txdata = Vec::new();
102 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
103 txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
106 txdata.push((*tx).clone());
108 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
109 connect_block(node, &block);
110 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
112 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
113 confirm_transactions_at(node, &[tx], conf_height)
116 /// The possible ways we may notify a ChannelManager of a new block
117 #[derive(Clone, Copy, Debug, PartialEq)]
118 pub enum ConnectStyle {
119 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
120 /// the header and height information.
122 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
123 /// make a single `best_block_updated` call.
124 BestBlockFirstSkippingBlocks,
125 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
126 /// `transaction_unconfirmed` is called.
127 BestBlockFirstReorgsOnlyTip,
128 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
129 /// the header and height information.
131 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
132 /// make a single `best_block_updated` call.
133 TransactionsFirstSkippingBlocks,
134 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
135 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
136 /// times to ensure it's idempotent.
137 TransactionsDuplicativelyFirstSkippingBlocks,
138 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
139 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
140 /// times to ensure it's idempotent.
141 HighlyRedundantTransactionsFirstSkippingBlocks,
142 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
143 /// `transaction_unconfirmed` is called.
144 TransactionsFirstReorgsOnlyTip,
145 /// Provides the full block via the `chain::Listen` interface. In the current code this is
146 /// equivalent to `TransactionsFirst` with some additional assertions.
151 pub fn skips_blocks(&self) -> bool {
153 ConnectStyle::BestBlockFirst => false,
154 ConnectStyle::BestBlockFirstSkippingBlocks => true,
155 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
156 ConnectStyle::TransactionsFirst => false,
157 ConnectStyle::TransactionsFirstSkippingBlocks => true,
158 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
159 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
160 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
161 ConnectStyle::FullBlockViaListen => false,
165 pub fn updates_best_block_first(&self) -> bool {
167 ConnectStyle::BestBlockFirst => true,
168 ConnectStyle::BestBlockFirstSkippingBlocks => true,
169 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
170 ConnectStyle::TransactionsFirst => false,
171 ConnectStyle::TransactionsFirstSkippingBlocks => false,
172 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
173 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
174 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
175 ConnectStyle::FullBlockViaListen => false,
179 fn random_style() -> ConnectStyle {
180 #[cfg(feature = "std")] {
181 use core::hash::{BuildHasher, Hasher};
182 // Get a random value using the only std API to do so - the DefaultHasher
183 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
184 let res = match rand_val % 9 {
185 0 => ConnectStyle::BestBlockFirst,
186 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
187 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
188 3 => ConnectStyle::TransactionsFirst,
189 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
190 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
191 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
192 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
193 8 => ConnectStyle::FullBlockViaListen,
196 eprintln!("Using Block Connection Style: {:?}", res);
199 #[cfg(not(feature = "std"))] {
200 ConnectStyle::FullBlockViaListen
205 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> BlockHeader {
207 version: 0x2000_0000,
209 merkle_root: TxMerkleNode::all_zeros(),
216 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
217 Block { header: create_dummy_header(prev_blockhash, time), txdata }
220 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
221 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
223 let height = node.best_block_info().1 + 1;
224 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
227 let prev_blockhash = block.header.block_hash();
228 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
229 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
231 let hash = block.header.block_hash();
232 do_connect_block_with_consistency_checks(node, block, false);
236 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
237 do_connect_block_with_consistency_checks(node, block.clone(), false);
240 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
241 // Ensure `get_claimable_balances`' self-tests never panic
242 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
243 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
247 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
248 call_claimable_balances(node);
249 do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
250 call_claimable_balances(node);
251 node.node.test_process_background_events();
254 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
255 let height = node.best_block_info().1 + 1;
256 #[cfg(feature = "std")] {
257 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
259 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
260 // transaction broadcast are correct.
261 node.blocks.lock().unwrap().push((block.clone(), height));
262 if !skip_intermediaries {
263 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
264 match *node.connect_style.borrow() {
265 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
266 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
267 call_claimable_balances(node);
268 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
269 node.node.best_block_updated(&block.header, height);
270 node.node.transactions_confirmed(&block.header, &txdata, height);
272 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
273 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
274 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
275 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
276 let mut connections = Vec::new();
277 for (block, height) in node.blocks.lock().unwrap().iter() {
278 if !block.txdata.is_empty() {
279 // Reconnect all transactions we've ever seen to ensure transaction connection
280 // is *really* idempotent. This is a somewhat likely deployment for some
281 // esplora implementations of chain sync which try to reduce state and
282 // complexity as much as possible.
284 // Sadly we have to clone the block here to maintain lockorder. In the
285 // future we should consider Arc'ing the blocks to avoid this.
286 connections.push((block.clone(), *height));
289 for (old_block, height) in connections {
290 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
291 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
294 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
295 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
296 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
298 call_claimable_balances(node);
299 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
300 node.node.transactions_confirmed(&block.header, &txdata, height);
301 node.node.best_block_updated(&block.header, height);
303 ConnectStyle::FullBlockViaListen => {
304 node.chain_monitor.chain_monitor.block_connected(&block, height);
305 node.node.block_connected(&block, height);
310 for tx in &block.txdata {
311 for input in &tx.input {
312 node.wallet_source.remove_utxo(input.previous_output);
314 let wallet_script = node.wallet_source.get_change_script().unwrap();
315 for (idx, output) in tx.output.iter().enumerate() {
316 if output.script_pubkey == wallet_script {
317 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
318 node.wallet_source.add_utxo(outpoint, output.value);
324 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
325 call_claimable_balances(node);
326 #[cfg(feature = "std")] {
327 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
330 let orig = node.blocks.lock().unwrap().pop().unwrap();
331 assert!(orig.1 > 0); // Cannot disconnect genesis
332 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
334 match *node.connect_style.borrow() {
335 ConnectStyle::FullBlockViaListen => {
336 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
337 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
339 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
340 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
342 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
343 node.node.best_block_updated(&prev.0.header, prev.1);
346 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
347 for tx in orig.0.txdata {
348 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
349 node.node.transaction_unconfirmed(&tx.txid());
353 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
354 node.node.best_block_updated(&prev.0.header, prev.1);
357 call_claimable_balances(node);
361 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
362 let count = node.blocks.lock().unwrap().len() as u32 - 1;
363 disconnect_blocks(node, count);
366 pub struct TestChanMonCfg {
367 pub tx_broadcaster: test_utils::TestBroadcaster,
368 pub fee_estimator: test_utils::TestFeeEstimator,
369 pub chain_source: test_utils::TestChainSource,
370 pub persister: test_utils::TestPersister,
371 pub logger: test_utils::TestLogger,
372 pub keys_manager: test_utils::TestKeysInterface,
373 pub scorer: RwLock<test_utils::TestScorer>,
376 pub struct NodeCfg<'a> {
377 pub chain_source: &'a test_utils::TestChainSource,
378 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
379 pub fee_estimator: &'a test_utils::TestFeeEstimator,
380 pub router: test_utils::TestRouter<'a>,
381 pub chain_monitor: test_utils::TestChainMonitor<'a>,
382 pub keys_manager: &'a test_utils::TestKeysInterface,
383 pub logger: &'a test_utils::TestLogger,
384 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
385 pub node_seed: [u8; 32],
386 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
389 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
390 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
391 &'chan_mon_cfg test_utils::TestBroadcaster,
392 &'node_cfg test_utils::TestKeysInterface,
393 &'node_cfg test_utils::TestKeysInterface,
394 &'node_cfg test_utils::TestKeysInterface,
395 &'chan_mon_cfg test_utils::TestFeeEstimator,
396 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
397 &'chan_mon_cfg test_utils::TestLogger,
400 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
401 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
402 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
403 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
404 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
405 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
406 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
407 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
408 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
409 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>,
410 pub node_seed: [u8; 32],
411 pub network_payment_count: Rc<RefCell<u8>>,
412 pub network_chan_count: Rc<RefCell<u32>>,
413 pub logger: &'chan_mon_cfg test_utils::TestLogger,
414 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
415 pub connect_style: Rc<RefCell<ConnectStyle>>,
416 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
417 pub wallet_source: Arc<test_utils::TestWalletSource>,
418 pub bump_tx_handler: BumpTransactionEventHandler<
419 &'chan_mon_cfg test_utils::TestBroadcaster,
420 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
421 &'chan_mon_cfg test_utils::TestKeysInterface,
422 &'chan_mon_cfg test_utils::TestLogger,
425 #[cfg(feature = "std")]
426 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
427 #[cfg(feature = "std")]
428 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
429 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
430 pub fn best_block_hash(&self) -> BlockHash {
431 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
433 pub fn best_block_info(&self) -> (BlockHash, u32) {
434 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
436 pub fn get_block_header(&self, height: u32) -> BlockHeader {
437 self.blocks.lock().unwrap()[height as usize].0.header
441 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
442 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
443 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
445 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
447 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
448 Self((node as *const Node<'a, 'b, 'c>).cast())
451 unsafe impl Send for NodePtr {}
452 unsafe impl Sync for NodePtr {}
455 pub trait NodeHolder {
456 type CM: AChannelManager;
457 fn node(&self) -> &ChannelManager<
458 <Self::CM as AChannelManager>::M,
459 <Self::CM as AChannelManager>::T,
460 <Self::CM as AChannelManager>::ES,
461 <Self::CM as AChannelManager>::NS,
462 <Self::CM as AChannelManager>::SP,
463 <Self::CM as AChannelManager>::F,
464 <Self::CM as AChannelManager>::R,
465 <Self::CM as AChannelManager>::L>;
466 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
468 impl<H: NodeHolder> NodeHolder for &H {
470 fn node(&self) -> &ChannelManager<
471 <Self::CM as AChannelManager>::M,
472 <Self::CM as AChannelManager>::T,
473 <Self::CM as AChannelManager>::ES,
474 <Self::CM as AChannelManager>::NS,
475 <Self::CM as AChannelManager>::SP,
476 <Self::CM as AChannelManager>::F,
477 <Self::CM as AChannelManager>::R,
478 <Self::CM as AChannelManager>::L> { (*self).node() }
479 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
481 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
482 type CM = TestChannelManager<'b, 'c>;
483 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
484 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
487 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
490 // Check that we processed all pending events
491 let msg_events = self.node.get_and_clear_pending_msg_events();
492 if !msg_events.is_empty() {
493 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
495 let events = self.node.get_and_clear_pending_events();
496 if !events.is_empty() {
497 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
499 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
500 if !added_monitors.is_empty() {
501 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
504 // Check that if we serialize the network graph, we can deserialize it again.
505 let network_graph = {
506 let mut w = test_utils::TestVecWriter(Vec::new());
507 self.network_graph.write(&mut w).unwrap();
508 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
509 assert!(network_graph_deser == *self.network_graph);
510 let gossip_sync = P2PGossipSync::new(
511 &network_graph_deser, Some(self.chain_source), self.logger
513 let mut chan_progress = 0;
515 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
516 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
517 assert!(orig_announcements == deserialized_announcements);
518 chan_progress = match orig_announcements {
519 Some(announcement) => announcement.0.contents.short_channel_id + 1,
523 let mut node_progress = None;
525 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
526 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
527 assert!(orig_announcements == deserialized_announcements);
528 node_progress = match orig_announcements {
529 Some(announcement) => Some(announcement.contents.node_id),
536 // Check that if we serialize and then deserialize all our channel monitors we get the
537 // same set of outputs to watch for on chain as we have now. Note that if we write
538 // tests that fully close channels and remove the monitors at some point this may break.
539 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
540 let mut deserialized_monitors = Vec::new();
542 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
543 let mut w = test_utils::TestVecWriter(Vec::new());
544 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
545 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
546 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
547 deserialized_monitors.push(deserialized_monitor);
551 let broadcaster = test_utils::TestBroadcaster {
552 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
553 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
556 // Before using all the new monitors to check the watch outpoints, use the full set of
557 // them to ensure we can write and reload our ChannelManager.
559 let mut channel_monitors = HashMap::new();
560 for monitor in deserialized_monitors.iter_mut() {
561 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
564 let scorer = RwLock::new(test_utils::TestScorer::new());
565 let mut w = test_utils::TestVecWriter(Vec::new());
566 self.node.write(&mut w).unwrap();
567 <(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 {
568 default_config: *self.node.get_current_default_configuration(),
569 entropy_source: self.keys_manager,
570 node_signer: self.keys_manager,
571 signer_provider: self.keys_manager,
572 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
573 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
574 chain_monitor: self.chain_monitor,
575 tx_broadcaster: &broadcaster,
576 logger: &self.logger,
581 let persister = test_utils::TestPersister::new();
582 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
583 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
584 for deserialized_monitor in deserialized_monitors.drain(..) {
585 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
589 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
590 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
595 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) {
596 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
599 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) {
600 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
601 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
602 (announcement, as_update, bs_update, channel_id, tx)
605 /// Gets an RAA and CS which were sent in response to a commitment update
606 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
607 let events = node.node().get_and_clear_pending_msg_events();
608 assert_eq!(events.len(), 2);
610 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
611 assert_eq!(node_id, recipient);
614 _ => panic!("Unexpected event"),
616 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
617 assert_eq!(node_id, recipient);
618 assert!(updates.update_add_htlcs.is_empty());
619 assert!(updates.update_fulfill_htlcs.is_empty());
620 assert!(updates.update_fail_htlcs.is_empty());
621 assert!(updates.update_fail_malformed_htlcs.is_empty());
622 assert!(updates.update_fee.is_none());
623 updates.commitment_signed.clone()
625 _ => panic!("Unexpected event"),
630 /// Gets an RAA and CS which were sent in response to a commitment update
632 /// Don't use this, use the identically-named function instead.
633 macro_rules! get_revoke_commit_msgs {
634 ($node: expr, $node_id: expr) => {
635 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
639 /// Get an specific event message from the pending events queue.
641 macro_rules! get_event_msg {
642 ($node: expr, $event_type: path, $node_id: expr) => {
644 let events = $node.node.get_and_clear_pending_msg_events();
645 assert_eq!(events.len(), 1);
647 $event_type { ref node_id, ref msg } => {
648 assert_eq!(*node_id, $node_id);
651 _ => panic!("Unexpected event"),
657 /// Get an error message from the pending events queue.
658 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
659 let events = node.node.get_and_clear_pending_msg_events();
660 assert_eq!(events.len(), 1);
662 MessageSendEvent::HandleError {
663 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
665 assert_eq!(node_id, recipient);
668 MessageSendEvent::HandleError {
669 action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
671 assert_eq!(node_id, recipient);
672 msg.as_ref().unwrap().clone()
674 _ => panic!("Unexpected event"),
678 /// Get a specific event from the pending events queue.
680 macro_rules! get_event {
681 ($node: expr, $event_type: path) => {
683 let mut events = $node.node.get_and_clear_pending_events();
684 assert_eq!(events.len(), 1);
685 let ev = events.pop().unwrap();
687 $event_type { .. } => {
690 _ => panic!("Unexpected event"),
696 /// Gets an UpdateHTLCs MessageSendEvent
697 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
698 let events = node.node.get_and_clear_pending_msg_events();
699 assert_eq!(events.len(), 1);
701 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
702 assert_eq!(node_id, recipient);
705 _ => panic!("Unexpected event"),
710 /// Gets an UpdateHTLCs MessageSendEvent
712 /// Don't use this, use the identically-named function instead.
713 macro_rules! get_htlc_update_msgs {
714 ($node: expr, $node_id: expr) => {
715 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
719 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
720 /// Returns the `msg_event`.
722 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
723 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
724 /// such messages are intended to all peers.
725 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
726 let ev_index = msg_events.iter().position(|e| { match e {
727 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
728 node_id == msg_node_id
730 MessageSendEvent::SendOpenChannel { node_id, .. } => {
731 node_id == msg_node_id
733 MessageSendEvent::SendFundingCreated { node_id, .. } => {
734 node_id == msg_node_id
736 MessageSendEvent::SendFundingSigned { node_id, .. } => {
737 node_id == msg_node_id
739 MessageSendEvent::SendChannelReady { node_id, .. } => {
740 node_id == msg_node_id
742 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
743 node_id == msg_node_id
745 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
746 node_id == msg_node_id
748 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
749 node_id == msg_node_id
751 MessageSendEvent::SendClosingSigned { node_id, .. } => {
752 node_id == msg_node_id
754 MessageSendEvent::SendShutdown { node_id, .. } => {
755 node_id == msg_node_id
757 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
758 node_id == msg_node_id
760 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
761 node_id == msg_node_id
763 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
766 MessageSendEvent::BroadcastChannelUpdate { .. } => {
769 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
772 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
773 node_id == msg_node_id
775 MessageSendEvent::HandleError { node_id, .. } => {
776 node_id == msg_node_id
778 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
779 node_id == msg_node_id
781 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
782 node_id == msg_node_id
784 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
785 node_id == msg_node_id
787 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
788 node_id == msg_node_id
790 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
791 node_id == msg_node_id
793 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
794 node_id == msg_node_id
796 MessageSendEvent::SendTxAddInput { node_id, .. } => {
797 node_id == msg_node_id
799 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
800 node_id == msg_node_id
802 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
803 node_id == msg_node_id
805 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
806 node_id == msg_node_id
808 MessageSendEvent::SendTxComplete { node_id, .. } => {
809 node_id == msg_node_id
811 MessageSendEvent::SendTxSignatures { node_id, .. } => {
812 node_id == msg_node_id
814 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
815 node_id == msg_node_id
817 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
818 node_id == msg_node_id
820 MessageSendEvent::SendTxAbort { node_id, .. } => {
821 node_id == msg_node_id
824 if ev_index.is_some() {
825 msg_events.remove(ev_index.unwrap())
827 panic!("Couldn't find any MessageSendEvent to the node!")
832 macro_rules! get_channel_ref {
833 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
835 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
836 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
837 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
843 macro_rules! get_feerate {
844 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
846 let mut per_peer_state_lock;
847 let mut peer_state_lock;
848 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
849 phase.context().get_feerate_sat_per_1000_weight()
855 macro_rules! get_channel_type_features {
856 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
858 let mut per_peer_state_lock;
859 let mut peer_state_lock;
860 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
861 chan.context().get_channel_type().clone()
866 /// Returns a channel monitor given a channel id, making some naive assumptions
868 macro_rules! get_monitor {
869 ($node: expr, $channel_id: expr) => {
871 use bitcoin::hashes::Hash;
872 let mut monitor = None;
873 // Assume funding vout is either 0 or 1 blindly
875 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
876 $crate::chain::transaction::OutPoint {
877 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
889 /// Returns any local commitment transactions for the channel.
891 macro_rules! get_local_commitment_txn {
892 ($node: expr, $channel_id: expr) => {
894 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
899 /// Check the error from attempting a payment.
901 macro_rules! unwrap_send_err {
902 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
904 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
905 assert_eq!(fails.len(), 1);
911 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
912 assert_eq!(results.len(), 1);
914 Err($type) => { $check },
923 /// Check whether N channel monitor(s) have been added.
924 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
925 if let Some(chain_monitor) = node.chain_monitor() {
926 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
927 assert_eq!(added_monitors.len(), count);
928 added_monitors.clear();
932 /// Check whether N channel monitor(s) have been added.
934 /// Don't use this, use the identically-named function instead.
936 macro_rules! check_added_monitors {
937 ($node: expr, $count: expr) => {
938 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
942 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
944 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
945 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
946 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
947 let mut nodes = path.iter().rev();
948 let dest = nodes.next().expect("path should have a destination").node;
949 let prev = nodes.next().unwrap_or(&origin_node).node;
950 let dest_channels = dest.list_channels();
951 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
952 .expect("HTLC's channel should be one of destination node's channels");
953 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
954 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
957 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> {
958 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
959 for encoded in monitors_encoded {
960 let mut monitor_read = &encoded[..];
961 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
962 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
963 assert!(monitor_read.is_empty());
964 monitors_read.push(monitor);
967 let mut node_read = &chanman_encoded[..];
968 let (_, node_deserialized) = {
969 let mut channel_monitors = HashMap::new();
970 for monitor in monitors_read.iter_mut() {
971 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
973 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
975 entropy_source: node.keys_manager,
976 node_signer: node.keys_manager,
977 signer_provider: node.keys_manager,
978 fee_estimator: node.fee_estimator,
980 chain_monitor: node.chain_monitor,
981 tx_broadcaster: node.tx_broadcaster,
986 assert!(node_read.is_empty());
988 for monitor in monitors_read.drain(..) {
989 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
990 Ok(ChannelMonitorUpdateStatus::Completed));
991 check_added_monitors!(node, 1);
998 macro_rules! reload_node {
999 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1000 let chanman_encoded = $chanman_encoded;
1002 $persister = test_utils::TestPersister::new();
1003 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1004 $node.chain_monitor = &$new_chain_monitor;
1006 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1007 $node.node = &$new_channelmanager;
1009 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1010 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1014 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1015 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1016 -> (ChannelId, Transaction, OutPoint)
1018 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1021 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1022 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1023 -> (ChannelId, Transaction, OutPoint)
1025 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1028 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1029 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1030 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1031 let chan_id = *node.network_chan_count.borrow();
1033 let events = node.node.get_and_clear_pending_events();
1034 assert_eq!(events.len(), 1);
1036 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1037 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1038 assert_eq!(*channel_value_satoshis, expected_chan_value);
1039 assert_eq!(user_channel_id, expected_user_chan_id);
1041 let input = if coinbase {
1043 previous_output: bitcoin::OutPoint::null(),
1044 ..Default::default()
1050 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1051 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1053 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1054 (*temporary_channel_id, tx, funding_outpoint)
1056 _ => panic!("Unexpected event"),
1060 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 {
1061 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1062 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1064 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1065 check_added_monitors!(node_a, 0);
1067 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1068 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1069 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1071 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1072 assert_eq!(added_monitors.len(), 1);
1073 assert_eq!(added_monitors[0].0, funding_output);
1074 added_monitors.clear();
1076 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1078 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()));
1080 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1081 assert_eq!(added_monitors.len(), 1);
1082 assert_eq!(added_monitors[0].0, funding_output);
1083 added_monitors.clear();
1085 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1087 let events_4 = node_a.node.get_and_clear_pending_events();
1088 assert_eq!(events_4.len(), 0);
1090 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1091 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1092 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1094 // Ensure that funding_transaction_generated is idempotent.
1095 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1096 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1097 check_added_monitors!(node_a, 0);
1102 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1103 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) {
1104 let initiator_channels = initiator.node.list_usable_channels().len();
1105 let receiver_channels = receiver.node.list_usable_channels().len();
1107 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1108 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1110 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1111 let events = receiver.node.get_and_clear_pending_events();
1112 assert_eq!(events.len(), 1);
1114 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1115 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1117 _ => panic!("Unexpected event"),
1120 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1121 assert_eq!(accept_channel.minimum_depth, 0);
1122 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1124 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1125 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1126 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1128 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1129 check_added_monitors!(receiver, 1);
1130 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1131 assert_eq!(bs_signed_locked.len(), 2);
1132 let as_channel_ready;
1133 match &bs_signed_locked[0] {
1134 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1135 assert_eq!(*node_id, initiator.node.get_our_node_id());
1136 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1137 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1138 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1139 check_added_monitors!(initiator, 1);
1141 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1142 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1144 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1146 _ => panic!("Unexpected event"),
1148 match &bs_signed_locked[1] {
1149 MessageSendEvent::SendChannelReady { node_id, msg } => {
1150 assert_eq!(*node_id, initiator.node.get_our_node_id());
1151 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1152 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1154 _ => panic!("Unexpected event"),
1157 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1158 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1160 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1161 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1163 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1164 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1166 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1167 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1169 (tx, as_channel_ready.channel_id)
1172 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 {
1173 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1174 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1175 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1176 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1177 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1178 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1179 let events = node_b.node.get_and_clear_pending_events();
1180 assert_eq!(events.len(), 1);
1182 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1183 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1184 _ => panic!("Unexpected event"),
1187 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1188 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1189 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1190 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1192 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1195 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) {
1196 confirm_transaction_at(node_conf, tx, conf_height);
1197 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1198 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()));
1201 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) {
1203 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1204 assert_eq!(events_6.len(), 3);
1205 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1206 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1208 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1209 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1211 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1212 ((match events_6[0] {
1213 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1214 channel_id = msg.channel_id.clone();
1215 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1218 _ => panic!("Unexpected event"),
1219 }, match events_6[announcement_sigs_idx] {
1220 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1221 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1224 _ => panic!("Unexpected event"),
1228 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) {
1229 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1230 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1231 confirm_transaction_at(node_a, tx, conf_height);
1232 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1233 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1234 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1237 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) {
1238 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1239 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1243 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) {
1244 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1245 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1246 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1248 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1249 assert_eq!(events_7.len(), 1);
1250 let (announcement, bs_update) = match events_7[0] {
1251 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1252 (msg, update_msg.clone().unwrap())
1254 _ => panic!("Unexpected event"),
1257 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1258 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1259 assert_eq!(events_8.len(), 1);
1260 let as_update = match events_8[0] {
1261 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1262 assert!(*announcement == *msg);
1263 let update_msg = update_msg.clone().unwrap();
1264 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1265 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1268 _ => panic!("Unexpected event"),
1271 *node_a.network_chan_count.borrow_mut() += 1;
1273 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1274 ((*announcement).clone(), as_update, bs_update)
1277 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) {
1278 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1281 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) {
1282 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1283 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1284 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1287 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) {
1288 let mut no_announce_cfg = test_default_channel_config();
1289 no_announce_cfg.channel_handshake_config.announced_channel = false;
1290 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1291 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1292 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1293 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1294 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1296 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1297 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1298 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()));
1299 check_added_monitors!(nodes[b], 1);
1301 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1302 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1304 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1305 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1306 check_added_monitors!(nodes[a], 1);
1308 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1309 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1310 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1312 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1313 confirm_transaction_at(&nodes[a], &tx, conf_height);
1314 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1315 confirm_transaction_at(&nodes[b], &tx, conf_height);
1316 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1317 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1318 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()));
1319 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1320 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1321 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1322 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1323 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1325 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1326 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1328 let mut found_a = false;
1329 for chan in nodes[a].node.list_usable_channels() {
1330 if chan.channel_id == as_channel_ready.channel_id {
1333 assert!(!chan.is_public);
1338 let mut found_b = false;
1339 for chan in nodes[b].node.list_usable_channels() {
1340 if chan.channel_id == as_channel_ready.channel_id {
1343 assert!(!chan.is_public);
1348 (as_channel_ready, tx)
1351 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) {
1353 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1354 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1355 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1357 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1358 // forwarding info for local channels even if its not accepted in the network graph.
1359 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1360 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1364 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1365 for outp in tx.output.iter() {
1366 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1368 let mut total_value_in = 0;
1369 for input in tx.input.iter() {
1370 total_value_in += get_output(&input.previous_output).unwrap().value;
1372 let mut total_value_out = 0;
1373 for output in tx.output.iter() {
1374 total_value_out += output.value;
1376 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1377 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1378 assert!(total_value_out + min_fee <= total_value_in);
1379 tx.verify(get_output).unwrap();
1383 macro_rules! check_spends {
1384 ($tx: expr, $($spends_txn: expr),*) => {
1387 for outp in $spends_txn.output.iter() {
1388 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1391 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1393 if out_point.txid == $spends_txn.txid() {
1394 return $spends_txn.output.get(out_point.vout as usize).cloned()
1399 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1404 macro_rules! get_closing_signed_broadcast {
1405 ($node: expr, $dest_pubkey: expr) => {
1407 let events = $node.get_and_clear_pending_msg_events();
1408 assert!(events.len() == 1 || events.len() == 2);
1409 (match events[events.len() - 1] {
1410 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1411 assert_eq!(msg.contents.flags & 2, 2);
1414 _ => panic!("Unexpected event"),
1415 }, if events.len() == 2 {
1417 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1418 assert_eq!(*node_id, $dest_pubkey);
1421 _ => panic!("Unexpected event"),
1429 macro_rules! check_warn_msg {
1430 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1431 let msg_events = $node.node.get_and_clear_pending_msg_events();
1432 assert_eq!(msg_events.len(), 1);
1433 match msg_events[0] {
1434 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1435 assert_eq!(node_id, $recipient_node_id);
1436 assert_eq!(msg.channel_id, $chan_id);
1439 _ => panic!("Unexpected event"),
1444 /// Check that a channel's closing channel update has been broadcasted, and optionally
1445 /// check whether an error message event has occurred.
1446 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1447 let msg_events = node.node.get_and_clear_pending_msg_events();
1448 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1449 msg_events.into_iter().filter_map(|msg_event| {
1451 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1452 assert_eq!(msg.contents.flags & 2, 2);
1455 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1456 assert!(with_error_msg);
1457 // TODO: Check node_id
1460 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1461 assert!(with_error_msg);
1462 // TODO: Check node_id
1465 _ => panic!("Unexpected event"),
1470 /// Check that a channel's closing channel update has been broadcasted, and optionally
1471 /// check whether an error message event has occurred.
1473 /// Don't use this, use the identically-named function instead.
1475 macro_rules! check_closed_broadcast {
1476 ($node: expr, $with_error_msg: expr) => {
1477 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1481 /// Check that a channel's closing channel events has been issued
1482 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1483 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1484 let events = node.node.get_and_clear_pending_events();
1485 assert_eq!(events.len(), events_count, "{:?}", events);
1486 let mut issues_discard_funding = false;
1487 for event in events {
1489 Event::ChannelClosed { ref reason, counterparty_node_id,
1490 channel_capacity_sats, .. } => {
1491 assert_eq!(*reason, expected_reason);
1492 assert!(expected_counterparty_node_ids.iter().any(|id| id == &counterparty_node_id.unwrap()));
1493 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1495 Event::DiscardFunding { .. } => {
1496 issues_discard_funding = true;
1498 _ => panic!("Unexpected event"),
1501 assert_eq!(is_check_discard_funding, issues_discard_funding);
1504 /// Check that a channel's closing channel events has been issued
1506 /// Don't use this, use the identically-named function instead.
1508 macro_rules! check_closed_event {
1509 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1510 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1512 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1513 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1514 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1518 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1519 let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1520 assert_eq!(events.len(), count);
1521 for event in events {
1523 Event::BumpTransaction(bump_event) => {
1524 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1526 node.bump_tx_handler.handle_event(&bump_event);
1533 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) {
1534 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) };
1535 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) };
1538 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1539 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1541 let events_1 = node_b.get_and_clear_pending_msg_events();
1542 assert!(events_1.len() >= 1);
1543 let shutdown_b = match events_1[0] {
1544 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1545 assert_eq!(node_id, &node_a.get_our_node_id());
1548 _ => panic!("Unexpected event"),
1551 let closing_signed_b = if !close_inbound_first {
1552 assert_eq!(events_1.len(), 1);
1555 Some(match events_1[1] {
1556 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1557 assert_eq!(node_id, &node_a.get_our_node_id());
1560 _ => panic!("Unexpected event"),
1564 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1565 let (as_update, bs_update) = if close_inbound_first {
1566 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1567 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1569 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1570 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1571 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1572 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1574 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1575 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1576 assert!(none_a.is_none());
1577 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1578 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1579 (as_update, bs_update)
1581 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1583 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1584 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1586 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1587 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1588 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1590 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1591 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1592 assert!(none_b.is_none());
1593 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1594 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1595 (as_update, bs_update)
1597 assert_eq!(tx_a, tx_b);
1598 check_spends!(tx_a, funding_tx);
1600 (as_update, bs_update, tx_a)
1603 pub struct SendEvent {
1604 pub node_id: PublicKey,
1605 pub msgs: Vec<msgs::UpdateAddHTLC>,
1606 pub commitment_msg: msgs::CommitmentSigned,
1609 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1610 assert!(updates.update_fulfill_htlcs.is_empty());
1611 assert!(updates.update_fail_htlcs.is_empty());
1612 assert!(updates.update_fail_malformed_htlcs.is_empty());
1613 assert!(updates.update_fee.is_none());
1614 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1617 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1619 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1620 _ => panic!("Unexpected event type!"),
1624 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1625 let mut events = node.node.get_and_clear_pending_msg_events();
1626 assert_eq!(events.len(), 1);
1627 SendEvent::from_event(events.pop().unwrap())
1632 /// Don't use this, use the identically-named function instead.
1633 macro_rules! expect_pending_htlcs_forwardable_conditions {
1634 ($node: expr, $expected_failures: expr) => {
1635 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1640 macro_rules! expect_htlc_handling_failed_destinations {
1641 ($events: expr, $expected_failures: expr) => {{
1642 for event in $events {
1644 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1645 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1646 assert!($expected_failures.contains(&failed_next_destination))
1648 _ => panic!("Unexpected destination"),
1654 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1655 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1656 /// `expected_failures` set.
1657 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1659 Event::PendingHTLCsForwardable { .. } => { },
1660 _ => panic!("Unexpected event {:?}", events),
1663 let count = expected_failures.len() + 1;
1664 assert_eq!(events.len(), count);
1666 if expected_failures.len() > 0 {
1667 expect_htlc_handling_failed_destinations!(events, expected_failures)
1672 /// Clears (and ignores) a PendingHTLCsForwardable event
1674 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1676 macro_rules! expect_pending_htlcs_forwardable_ignore {
1678 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1683 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1685 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1686 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1687 ($node: expr, $expected_failures: expr) => {
1688 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1693 /// Handles a PendingHTLCsForwardable event
1694 macro_rules! expect_pending_htlcs_forwardable {
1696 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1697 $node.node.process_pending_htlc_forwards();
1699 // Ensure process_pending_htlc_forwards is idempotent.
1700 $node.node.process_pending_htlc_forwards();
1705 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1706 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1707 ($node: expr, $expected_failures: expr) => {{
1708 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1709 $node.node.process_pending_htlc_forwards();
1711 // Ensure process_pending_htlc_forwards is idempotent.
1712 $node.node.process_pending_htlc_forwards();
1717 macro_rules! expect_pending_htlcs_forwardable_from_events {
1718 ($node: expr, $events: expr, $ignore: expr) => {{
1719 assert_eq!($events.len(), 1);
1721 Event::PendingHTLCsForwardable { .. } => { },
1722 _ => panic!("Unexpected event"),
1725 $node.node.process_pending_htlc_forwards();
1727 // Ensure process_pending_htlc_forwards is idempotent.
1728 $node.node.process_pending_htlc_forwards();
1734 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1735 /// commitment update.
1736 macro_rules! commitment_signed_dance {
1737 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1738 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1740 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1741 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1743 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1745 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1746 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1747 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1748 check_added_monitors(&$node_a, 1);
1749 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1750 assert!(extra_msg_option.is_none());
1754 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1755 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1757 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1758 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1762 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1763 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1764 /// `revoke_and_ack` response to it.
1766 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1767 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1768 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1769 /// the commitment we're exchanging. `includes_claim` provides that information.
1771 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1772 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1773 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1774 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1775 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1779 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1780 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1781 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1783 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1784 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1785 check_added_monitors!(node_b, 0);
1786 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1787 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1788 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1789 check_added_monitors!(node_b, 1);
1790 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1791 let (bs_revoke_and_ack, extra_msg_option) = {
1792 let mut events = node_b.node.get_and_clear_pending_msg_events();
1793 assert!(events.len() <= 2);
1794 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1795 (match node_a_event {
1796 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1797 assert_eq!(*node_id, node_a.node.get_our_node_id());
1800 _ => panic!("Unexpected event"),
1801 }, events.get(0).map(|e| e.clone()))
1803 check_added_monitors!(node_b, 1);
1805 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1806 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1808 (extra_msg_option, bs_revoke_and_ack)
1811 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1812 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1814 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1815 /// on failure or that no new messages are left over on success.
1816 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1817 check_added_monitors!(node_a, 0);
1818 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1819 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1820 check_added_monitors!(node_a, 1);
1822 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1823 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1824 if fail_backwards { assert!(!got_claim); }
1825 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1827 if skip_last_step { return; }
1830 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1831 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1832 check_added_monitors!(node_a, 1);
1834 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1835 let mut number_of_msg_events = 0;
1836 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1837 let peer_state = peer_state_mutex.lock().unwrap();
1838 let cp_pending_msg_events = &peer_state.pending_msg_events;
1839 number_of_msg_events += cp_pending_msg_events.len();
1840 if cp_pending_msg_events.len() == 1 {
1841 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1842 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1843 } else { panic!("Unexpected event"); }
1846 // Expecting the failure backwards event to the previous hop (not `node_b`)
1847 assert_eq!(number_of_msg_events, 1);
1849 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1853 /// Get a payment preimage and hash.
1854 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1855 let mut payment_count = recipient.network_payment_count.borrow_mut();
1856 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1857 *payment_count += 1;
1858 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1859 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1860 (payment_preimage, payment_hash, payment_secret)
1863 /// Get a payment preimage and hash.
1865 /// Don't use this, use the identically-named function instead.
1867 macro_rules! get_payment_preimage_hash {
1868 ($dest_node: expr) => {
1869 get_payment_preimage_hash!($dest_node, None)
1871 ($dest_node: expr, $min_value_msat: expr) => {
1872 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1874 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1875 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1879 /// Gets a route from the given sender to the node described in `payment_params`.
1880 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1881 let scorer = TestScorer::new();
1882 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1883 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1885 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1886 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1887 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
1891 /// Gets a route from the given sender to the node described in `payment_params`.
1893 /// Don't use this, use the identically-named function instead.
1895 macro_rules! get_route {
1896 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1897 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1898 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1904 macro_rules! get_route_and_payment_hash {
1905 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1906 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1907 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1908 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1910 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1911 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
1913 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
1914 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1915 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
1916 let (payment_preimage, payment_hash, payment_secret) =
1917 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1918 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1919 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1923 pub fn check_payment_claimable(
1924 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1925 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1926 expected_receiver_node_id: PublicKey,
1929 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1930 assert_eq!(expected_payment_hash, *payment_hash);
1931 assert_eq!(expected_recv_value, *amount_msat);
1932 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1934 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1935 assert_eq!(&expected_payment_preimage, payment_preimage);
1936 assert_eq!(expected_payment_secret, *payment_secret);
1941 _ => panic!("Unexpected event"),
1946 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1947 macro_rules! expect_payment_claimable {
1948 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1949 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1951 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1952 let events = $node.node.get_and_clear_pending_events();
1953 assert_eq!(events.len(), 1);
1954 $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)
1959 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1960 macro_rules! expect_payment_claimed {
1961 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1962 let events = $node.node.get_and_clear_pending_events();
1963 assert_eq!(events.len(), 1);
1965 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1966 assert_eq!($expected_payment_hash, *payment_hash);
1967 assert_eq!($expected_recv_value, amount_msat);
1969 _ => panic!("Unexpected event"),
1974 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1975 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1976 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
1978 let events = node.node().get_and_clear_pending_events();
1979 let expected_payment_hash = PaymentHash(
1980 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1981 if expect_per_path_claims {
1982 assert!(events.len() > 1);
1984 assert_eq!(events.len(), 1);
1986 if expect_post_ev_mon_update {
1987 check_added_monitors(node, 1);
1989 let expected_payment_id = match events[0] {
1990 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1991 assert_eq!(expected_payment_preimage, *payment_preimage);
1992 assert_eq!(expected_payment_hash, *payment_hash);
1993 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1994 assert_eq!(*fee_paid_msat, expected_fee_msat);
1996 assert!(fee_paid_msat.is_some());
2000 _ => panic!("Unexpected event"),
2002 if expect_per_path_claims {
2003 for i in 1..events.len() {
2005 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2006 assert_eq!(payment_id, expected_payment_id);
2007 assert_eq!(payment_hash, Some(expected_payment_hash));
2009 _ => panic!("Unexpected event"),
2016 macro_rules! expect_payment_sent {
2017 ($node: expr, $expected_payment_preimage: expr) => {
2018 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2020 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2021 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2023 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2024 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2025 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2031 macro_rules! expect_payment_path_successful {
2033 let events = $node.node.get_and_clear_pending_events();
2034 assert_eq!(events.len(), 1);
2036 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2037 _ => panic!("Unexpected event"),
2042 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2043 event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2044 upstream_force_closed: bool, downstream_force_closed: bool
2047 Event::PaymentForwarded {
2048 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2049 outbound_amount_forwarded_msat: _
2051 assert_eq!(fee_earned_msat, expected_fee);
2052 if !upstream_force_closed {
2053 // Is the event prev_channel_id in one of the channels between the two nodes?
2054 assert!(node.node().list_channels().iter().any(|x| x.counterparty.node_id == prev_node.node().get_our_node_id() && x.channel_id == prev_channel_id.unwrap()));
2056 // We check for force closures since a force closed channel is removed from the
2057 // node's channel list
2058 if !downstream_force_closed {
2059 assert!(node.node().list_channels().iter().any(|x| x.counterparty.node_id == next_node.node().get_our_node_id() && x.channel_id == next_channel_id.unwrap()));
2061 assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2063 _ => panic!("Unexpected event"),
2067 macro_rules! expect_payment_forwarded {
2068 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2069 let mut events = $node.node.get_and_clear_pending_events();
2070 assert_eq!(events.len(), 1);
2071 $crate::ln::functional_test_utils::expect_payment_forwarded(
2072 events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee,
2073 $upstream_force_closed, $downstream_force_closed);
2079 macro_rules! expect_channel_shutdown_state {
2080 ($node: expr, $chan_id: expr, $state: path) => {
2081 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2082 assert_eq!(chan_details.len(), 1);
2083 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2087 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2088 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2089 let events = node.node.get_and_clear_pending_events();
2090 assert_eq!(events.len(), 1);
2092 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2093 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2095 _ => panic!("Unexpected event"),
2099 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2100 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2101 let events = node.node.get_and_clear_pending_events();
2102 assert_eq!(events.len(), 1);
2104 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2105 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2107 _ => panic!("Unexpected event"),
2111 pub struct PaymentFailedConditions<'a> {
2112 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2113 pub(crate) expected_blamed_scid: Option<u64>,
2114 pub(crate) expected_blamed_chan_closed: Option<bool>,
2115 pub(crate) expected_mpp_parts_remain: bool,
2118 impl<'a> PaymentFailedConditions<'a> {
2119 pub fn new() -> Self {
2121 expected_htlc_error_data: None,
2122 expected_blamed_scid: None,
2123 expected_blamed_chan_closed: None,
2124 expected_mpp_parts_remain: false,
2127 pub fn mpp_parts_remain(mut self) -> Self {
2128 self.expected_mpp_parts_remain = true;
2131 pub fn blamed_scid(mut self, scid: u64) -> Self {
2132 self.expected_blamed_scid = Some(scid);
2135 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2136 self.expected_blamed_chan_closed = Some(closed);
2139 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2140 self.expected_htlc_error_data = Some((code, data));
2146 macro_rules! expect_payment_failed_with_update {
2147 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2148 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2149 &$node, $expected_payment_hash, $payment_failed_permanently,
2150 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2151 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2156 macro_rules! expect_payment_failed {
2157 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2158 #[allow(unused_mut)]
2159 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2161 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2163 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2167 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2168 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2169 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2171 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2172 let expected_payment_id = match &payment_failed_events[0] {
2173 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2177 error_data, .. } => {
2178 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2179 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2182 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2183 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2184 if let Some((code, data)) = conditions.expected_htlc_error_data {
2185 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2186 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2190 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2191 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2193 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2194 if let Some(scid) = conditions.expected_blamed_scid {
2195 assert_eq!(msg.contents.short_channel_id, scid);
2197 const CHAN_DISABLED_FLAG: u8 = 2;
2198 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2200 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2201 if let Some(scid) = conditions.expected_blamed_scid {
2202 assert_eq!(*short_channel_id, scid);
2204 assert!(is_permanent);
2206 _ => panic!("Unexpected update type"),
2208 } else { panic!("Expected network update"); }
2213 _ => panic!("Unexpected event"),
2215 if !conditions.expected_mpp_parts_remain {
2216 match &payment_failed_events[1] {
2217 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2218 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2219 assert_eq!(*payment_id, expected_payment_id);
2220 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2221 PaymentFailureReason::RecipientRejected
2223 PaymentFailureReason::RetriesExhausted
2226 _ => panic!("Unexpected second event"),
2231 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2232 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2233 conditions: PaymentFailedConditions<'e>
2235 let events = node.node.get_and_clear_pending_events();
2236 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2239 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 {
2240 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2241 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2242 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2243 check_added_monitors!(origin_node, expected_paths.len());
2244 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2248 pub fn do_pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: Option<PaymentSecret>, ev: MessageSendEvent, payment_claimable_expected: bool, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) -> Option<Event> {
2249 let mut payment_event = SendEvent::from_event(ev);
2250 let mut prev_node = origin_node;
2251 let mut event = None;
2253 for (idx, &node) in expected_path.iter().enumerate() {
2254 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2256 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2257 check_added_monitors!(node, 0);
2258 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2260 expect_pending_htlcs_forwardable!(node);
2262 if idx == expected_path.len() - 1 && clear_recipient_events {
2263 let events_2 = node.node.get_and_clear_pending_events();
2264 if payment_claimable_expected {
2265 assert_eq!(events_2.len(), 1);
2266 match &events_2[0] {
2267 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2268 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2269 claim_deadline, onion_fields, ..
2271 assert_eq!(our_payment_hash, *payment_hash);
2272 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2273 assert!(onion_fields.is_some());
2275 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2276 assert_eq!(expected_preimage, *payment_preimage);
2277 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2278 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2280 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2281 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2282 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2285 assert_eq!(*amount_msat, recv_value);
2286 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2287 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2288 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2290 _ => panic!("Unexpected event"),
2292 event = Some(events_2[0].clone());
2294 assert!(events_2.is_empty());
2296 } else if idx != expected_path.len() - 1 {
2297 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2298 assert_eq!(events_2.len(), 1);
2299 check_added_monitors!(node, 1);
2300 payment_event = SendEvent::from_event(events_2.remove(0));
2301 assert_eq!(payment_event.msgs.len(), 1);
2309 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> {
2310 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2313 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) {
2314 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2315 assert_eq!(events.len(), expected_route.len());
2316 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2317 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2318 // Once we've gotten through all the HTLCs, the last one should result in a
2319 // PaymentClaimable (but each previous one should not!), .
2320 let expect_payment = path_idx == expected_route.len() - 1;
2321 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2325 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) {
2326 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2327 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2328 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2331 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2332 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2333 our_payment_preimage: PaymentPreimage
2335 let extra_fees = vec![0; expected_paths.len()];
2336 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2337 &extra_fees[..], skip_last, our_payment_preimage)
2340 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2341 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2342 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2344 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2345 for path in expected_paths.iter() {
2346 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2348 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2349 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2352 pub fn pass_claimed_payment_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees: &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage) -> u64 {
2353 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2354 assert_eq!(claim_event.len(), 1);
2355 match claim_event[0] {
2356 Event::PaymentClaimed {
2357 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2361 | Event::PaymentClaimed {
2362 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2367 assert_eq!(preimage, our_payment_preimage);
2368 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2369 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2370 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2372 Event::PaymentClaimed {
2373 purpose: PaymentPurpose::InvoicePayment { .. },
2379 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2380 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2381 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2382 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2387 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2389 let mut expected_total_fee_msat = 0;
2391 macro_rules! msgs_from_ev {
2394 &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 } } => {
2395 assert!(update_add_htlcs.is_empty());
2396 assert_eq!(update_fulfill_htlcs.len(), 1);
2397 assert!(update_fail_htlcs.is_empty());
2398 assert!(update_fail_malformed_htlcs.is_empty());
2399 assert!(update_fee.is_none());
2400 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2402 _ => panic!("Unexpected event"),
2406 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2407 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2408 assert_eq!(events.len(), expected_paths.len());
2410 if events.len() == 1 {
2411 per_path_msgs.push(msgs_from_ev!(&events[0]));
2413 for expected_path in expected_paths.iter() {
2414 // For MPP payments, we always want the message to the first node in the path.
2415 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2416 per_path_msgs.push(msgs_from_ev!(&ev));
2420 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2421 let mut next_msgs = Some(path_msgs);
2422 let mut expected_next_node = next_hop;
2424 macro_rules! last_update_fulfill_dance {
2425 ($node: expr, $prev_node: expr) => {
2427 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2428 check_added_monitors!($node, 0);
2429 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2430 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2434 macro_rules! mid_update_fulfill_dance {
2435 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2437 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2439 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2440 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2441 .unwrap().lock().unwrap();
2442 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2443 if let Some(prev_config) = channel.context().prev_config() {
2444 prev_config.forwarding_fee_base_msat
2446 channel.context().config().forwarding_fee_base_msat
2449 if $idx == 1 { fee += expected_extra_fees[i]; }
2450 expect_payment_forwarded!(*$node, $next_node, $prev_node, Some(fee as u64), false, false);
2451 expected_total_fee_msat += fee as u64;
2452 check_added_monitors!($node, 1);
2453 let new_next_msgs = if $new_msgs {
2454 let events = $node.node.get_and_clear_pending_msg_events();
2455 assert_eq!(events.len(), 1);
2456 let (res, nexthop) = msgs_from_ev!(&events[0]);
2457 expected_next_node = nexthop;
2460 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2463 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2464 next_msgs = new_next_msgs;
2469 let mut prev_node = expected_route.last().unwrap();
2470 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2471 assert_eq!(expected_next_node, node.node.get_our_node_id());
2472 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2473 if next_msgs.is_some() {
2474 // Since we are traversing in reverse, next_node is actually the previous node
2475 let next_node: &Node;
2476 if idx == expected_route.len() - 1 {
2477 next_node = origin_node;
2479 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2481 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2483 assert!(!update_next_msgs);
2484 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2486 if !skip_last && idx == expected_route.len() - 1 {
2487 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2494 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2498 // Ensure that claim_funds is idempotent.
2499 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2500 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2501 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2503 expected_total_fee_msat
2505 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) {
2506 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2508 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2512 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2513 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2516 pub const TEST_FINAL_CLTV: u32 = 70;
2518 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) {
2519 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2520 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2521 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2522 let route = get_route(origin_node, &route_params).unwrap();
2523 assert_eq!(route.paths.len(), 1);
2524 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2525 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2526 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2529 let res = send_along_route(origin_node, route, expected_route, recv_value);
2530 (res.0, res.1, res.2, res.3)
2533 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2534 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2535 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2536 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2537 let network_graph = origin_node.network_graph.read_only();
2538 let scorer = test_utils::TestScorer::new();
2539 let seed = [0u8; 32];
2540 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2541 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2542 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2543 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2544 assert_eq!(route.paths.len(), 1);
2545 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2546 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2547 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2550 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2551 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2552 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2553 true, APIError::ChannelUnavailable { ref err },
2554 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2557 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) {
2558 let res = route_payment(&origin, expected_route, recv_value);
2559 claim_payment(&origin, expected_route, res.0);
2563 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) {
2564 for path in expected_paths.iter() {
2565 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2567 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2568 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2569 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2571 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2574 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) {
2575 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2576 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2578 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2579 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2580 assert_eq!(events.len(), expected_paths.len());
2581 for ev in events.iter() {
2582 let (update_fail, commitment_signed, node_id) = match ev {
2583 &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 } } => {
2584 assert!(update_add_htlcs.is_empty());
2585 assert!(update_fulfill_htlcs.is_empty());
2586 assert_eq!(update_fail_htlcs.len(), 1);
2587 assert!(update_fail_malformed_htlcs.is_empty());
2588 assert!(update_fee.is_none());
2589 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2591 _ => panic!("Unexpected event"),
2593 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2595 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2596 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()));
2598 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2599 let mut next_msgs = Some(path_msgs);
2600 let mut expected_next_node = next_hop;
2601 let mut prev_node = expected_route.last().unwrap();
2603 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2604 assert_eq!(expected_next_node, node.node.get_our_node_id());
2605 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2606 if next_msgs.is_some() {
2607 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2608 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2609 if !update_next_node {
2610 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 }]);
2613 let events = node.node.get_and_clear_pending_msg_events();
2614 if update_next_node {
2615 assert_eq!(events.len(), 1);
2617 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 } } => {
2618 assert!(update_add_htlcs.is_empty());
2619 assert!(update_fulfill_htlcs.is_empty());
2620 assert_eq!(update_fail_htlcs.len(), 1);
2621 assert!(update_fail_malformed_htlcs.is_empty());
2622 assert!(update_fee.is_none());
2623 expected_next_node = node_id.clone();
2624 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2626 _ => panic!("Unexpected event"),
2629 assert!(events.is_empty());
2631 if !skip_last && idx == expected_route.len() - 1 {
2632 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2639 let prev_node = expected_route.first().unwrap();
2640 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2641 check_added_monitors!(origin_node, 0);
2642 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2643 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2644 let events = origin_node.node.get_and_clear_pending_events();
2645 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2647 let expected_payment_id = match events[0] {
2648 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2649 assert_eq!(payment_hash, our_payment_hash);
2650 assert!(payment_failed_permanently);
2651 for (idx, hop) in expected_route.iter().enumerate() {
2652 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2656 _ => panic!("Unexpected event"),
2658 if i == expected_paths.len() - 1 {
2660 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2661 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2662 assert_eq!(*payment_id, expected_payment_id);
2663 assert_eq!(reason.unwrap(), expected_fail_reason);
2665 _ => panic!("Unexpected second event"),
2671 // Ensure that fail_htlc_backwards is idempotent.
2672 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2673 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2674 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2675 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2678 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2679 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2682 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2683 let mut chan_mon_cfgs = Vec::new();
2684 for i in 0..node_count {
2685 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2686 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2687 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2688 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2689 let persister = test_utils::TestPersister::new();
2690 let seed = [i as u8; 32];
2691 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2692 let scorer = RwLock::new(test_utils::TestScorer::new());
2694 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2700 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2701 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2704 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>> {
2705 let mut nodes = Vec::new();
2707 for i in 0..node_count {
2708 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);
2709 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2710 let seed = [i as u8; 32];
2711 nodes.push(NodeCfg {
2712 chain_source: &chanmon_cfgs[i].chain_source,
2713 logger: &chanmon_cfgs[i].logger,
2714 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2715 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2716 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2718 keys_manager: &chanmon_cfgs[i].keys_manager,
2721 override_init_features: Rc::new(RefCell::new(None)),
2728 pub fn test_default_channel_config() -> UserConfig {
2729 let mut default_config = UserConfig::default();
2730 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2731 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2732 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2733 default_config.channel_handshake_config.announced_channel = true;
2734 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2735 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2736 // It now defaults to 1, so we simply set it to the expected value here.
2737 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2738 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2739 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2741 default_config.channel_config.max_dust_htlc_exposure =
2742 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2746 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>> {
2747 let mut chanmgrs = Vec::new();
2748 for i in 0..node_count {
2749 let network = Network::Testnet;
2750 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2751 let params = ChainParameters {
2753 best_block: BestBlock::from_network(network),
2755 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,
2756 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);
2757 chanmgrs.push(node);
2763 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>> {
2764 let mut nodes = Vec::new();
2765 let chan_count = Rc::new(RefCell::new(0));
2766 let payment_count = Rc::new(RefCell::new(0));
2767 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2769 for i in 0..node_count {
2770 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2771 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2773 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2774 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2775 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2776 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2777 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2778 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2779 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2780 connect_style: Rc::clone(&connect_style),
2781 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2782 wallet_source: Arc::clone(&wallet_source),
2783 bump_tx_handler: BumpTransactionEventHandler::new(
2784 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2785 &cfgs[i].keys_manager, cfgs[i].logger,
2790 for i in 0..node_count {
2791 for j in (i+1)..node_count {
2792 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2793 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2795 remote_network_address: None,
2797 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2798 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2800 remote_network_address: None,
2808 // Note that the following only works for CLTV values up to 128
2809 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2810 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2812 #[derive(PartialEq)]
2813 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2814 /// Tests that the given node has broadcast transactions for the given Channel
2816 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2817 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2818 /// broadcast and the revoked outputs were claimed.
2820 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2821 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2823 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2825 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> {
2826 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2827 let mut txn_seen = HashSet::new();
2828 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2829 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2831 let mut res = Vec::with_capacity(2);
2832 node_txn.retain(|tx| {
2833 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2834 check_spends!(tx, chan.3);
2835 if commitment_tx.is_none() {
2836 res.push(tx.clone());
2841 if let Some(explicit_tx) = commitment_tx {
2842 res.push(explicit_tx.clone());
2845 assert_eq!(res.len(), 1);
2847 if has_htlc_tx != HTLCType::NONE {
2848 node_txn.retain(|tx| {
2849 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2850 check_spends!(tx, res[0]);
2851 if has_htlc_tx == HTLCType::TIMEOUT {
2852 assert!(tx.lock_time.0 != 0);
2854 assert!(tx.lock_time.0 == 0);
2856 res.push(tx.clone());
2860 assert!(res.len() == 2 || res.len() == 3);
2862 assert_eq!(res[1], res[2]);
2866 assert!(node_txn.is_empty());
2870 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2871 /// HTLC transaction.
2872 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2873 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2874 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2875 // for revoked htlc outputs
2876 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2877 node_txn.retain(|tx| {
2878 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2879 check_spends!(tx, revoked_tx);
2883 node_txn.retain(|tx| {
2884 check_spends!(tx, commitment_revoked_tx);
2887 assert!(node_txn.is_empty());
2890 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2891 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2892 let mut txn_seen = HashSet::new();
2893 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2895 let mut found_prev = false;
2896 for prev_tx in prev_txn {
2897 for tx in &*node_txn {
2898 if tx.input[0].previous_output.txid == prev_tx.txid() {
2899 check_spends!(tx, prev_tx);
2900 let mut iter = tx.input[0].witness.iter();
2901 iter.next().expect("expected 3 witness items");
2902 iter.next().expect("expected 3 witness items");
2903 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2904 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2911 assert!(found_prev);
2913 let mut res = Vec::new();
2914 mem::swap(&mut *node_txn, &mut res);
2918 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) {
2919 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2920 assert_eq!(events_1.len(), 2);
2921 let as_update = match events_1[0] {
2922 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2925 _ => panic!("Unexpected event"),
2928 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2929 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2930 assert_eq!(msg.data, expected_error);
2931 if needs_err_handle {
2932 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2935 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
2936 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2937 assert_eq!(msg.as_ref().unwrap().data, expected_error);
2938 if needs_err_handle {
2939 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
2942 _ => panic!("Unexpected event"),
2945 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2946 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2947 let bs_update = match events_2[0] {
2948 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2951 _ => panic!("Unexpected event"),
2953 if !needs_err_handle {
2955 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2956 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2957 assert_eq!(msg.data, expected_error);
2959 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
2960 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2961 assert_eq!(msg.as_ref().unwrap().data, expected_error);
2963 _ => panic!("Unexpected event"),
2968 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2969 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2973 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2974 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2978 macro_rules! get_channel_value_stat {
2979 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2980 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2981 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2982 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
2983 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
2984 ).flatten().unwrap();
2985 chan.get_value_stat()
2989 macro_rules! get_chan_reestablish_msgs {
2990 ($src_node: expr, $dst_node: expr) => {
2992 let mut announcements = $crate::prelude::HashSet::new();
2993 let mut res = Vec::with_capacity(1);
2994 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2995 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2996 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2997 res.push(msg.clone());
2998 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2999 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3000 announcements.insert(msg.contents.short_channel_id);
3002 panic!("Unexpected event")
3005 assert!(announcements.is_empty());
3011 macro_rules! handle_chan_reestablish_msgs {
3012 ($src_node: expr, $dst_node: expr) => {
3014 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3016 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3018 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3024 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3026 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3029 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3030 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3031 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3033 had_channel_update = true;
3036 let mut revoke_and_ack = None;
3037 let mut commitment_update = None;
3038 let order = if let Some(ev) = msg_events.get(idx) {
3040 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3041 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3042 revoke_and_ack = Some(msg.clone());
3044 RAACommitmentOrder::RevokeAndACKFirst
3046 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3047 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3048 commitment_update = Some(updates.clone());
3050 RAACommitmentOrder::CommitmentFirst
3052 _ => RAACommitmentOrder::CommitmentFirst,
3055 RAACommitmentOrder::CommitmentFirst
3058 if let Some(ev) = msg_events.get(idx) {
3060 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3061 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3062 assert!(revoke_and_ack.is_none());
3063 revoke_and_ack = Some(msg.clone());
3066 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3067 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3068 assert!(commitment_update.is_none());
3069 commitment_update = Some(updates.clone());
3076 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3077 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3079 assert!(!had_channel_update);
3082 assert_eq!(msg_events.len(), idx);
3084 (channel_ready, revoke_and_ack, commitment_update, order)
3089 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3090 pub node_a: &'a Node<'b, 'c, 'd>,
3091 pub node_b: &'a Node<'b, 'c, 'd>,
3092 pub send_channel_ready: (bool, bool),
3093 pub pending_responding_commitment_signed: (bool, bool),
3094 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3095 /// and no monitor update is expected
3096 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3097 pub pending_htlc_adds: (usize, usize),
3098 pub pending_htlc_claims: (usize, usize),
3099 pub pending_htlc_fails: (usize, usize),
3100 pub pending_cell_htlc_claims: (usize, usize),
3101 pub pending_cell_htlc_fails: (usize, usize),
3102 pub pending_raa: (bool, bool),
3105 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3106 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3110 send_channel_ready: (false, false),
3111 pending_responding_commitment_signed: (false, false),
3112 pending_responding_commitment_signed_dup_monitor: (false, false),
3113 pending_htlc_adds: (0, 0),
3114 pending_htlc_claims: (0, 0),
3115 pending_htlc_fails: (0, 0),
3116 pending_cell_htlc_claims: (0, 0),
3117 pending_cell_htlc_fails: (0, 0),
3118 pending_raa: (false, false),
3123 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3124 /// for claims/fails they are separated out.
3125 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3127 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3128 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3129 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3131 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3132 features: node_b.node.init_features(), networks: None, remote_network_address: None
3134 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3135 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3136 features: node_a.node.init_features(), networks: None, remote_network_address: None
3138 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3140 if send_channel_ready.0 {
3141 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3143 for reestablish in reestablish_1.iter() {
3144 assert_eq!(reestablish.next_remote_commitment_number, 0);
3147 if send_channel_ready.1 {
3148 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3150 for reestablish in reestablish_2.iter() {
3151 assert_eq!(reestablish.next_remote_commitment_number, 0);
3154 if send_channel_ready.0 || send_channel_ready.1 {
3155 // If we expect any channel_ready's, both sides better have set
3156 // next_holder_commitment_number to 1
3157 for reestablish in reestablish_1.iter() {
3158 assert_eq!(reestablish.next_local_commitment_number, 1);
3160 for reestablish in reestablish_2.iter() {
3161 assert_eq!(reestablish.next_local_commitment_number, 1);
3165 let mut resp_1 = Vec::new();
3166 for msg in reestablish_1 {
3167 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3168 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3170 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3171 check_added_monitors!(node_b, 1);
3173 check_added_monitors!(node_b, 0);
3176 let mut resp_2 = Vec::new();
3177 for msg in reestablish_2 {
3178 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3179 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3181 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3182 check_added_monitors!(node_a, 1);
3184 check_added_monitors!(node_a, 0);
3187 // We don't yet support both needing updates, as that would require a different commitment dance:
3188 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3189 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3190 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3191 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3193 for chan_msgs in resp_1.drain(..) {
3194 if send_channel_ready.0 {
3195 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3196 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3197 if !announcement_event.is_empty() {
3198 assert_eq!(announcement_event.len(), 1);
3199 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3200 //TODO: Test announcement_sigs re-sending
3201 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3204 assert!(chan_msgs.0.is_none());
3207 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3208 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3209 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3210 check_added_monitors!(node_a, 1);
3212 assert!(chan_msgs.1.is_none());
3214 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3215 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3216 pending_responding_commitment_signed.0
3218 let commitment_update = chan_msgs.2.unwrap();
3219 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3220 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3221 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3222 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3223 for update_add in commitment_update.update_add_htlcs {
3224 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3226 for update_fulfill in commitment_update.update_fulfill_htlcs {
3227 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3229 for update_fail in commitment_update.update_fail_htlcs {
3230 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3233 if !pending_responding_commitment_signed.0 {
3234 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3236 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3237 check_added_monitors!(node_a, 1);
3238 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3239 // No commitment_signed so get_event_msg's assert(len == 1) passes
3240 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3241 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3242 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3245 assert!(chan_msgs.2.is_none());
3249 for chan_msgs in resp_2.drain(..) {
3250 if send_channel_ready.1 {
3251 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3252 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3253 if !announcement_event.is_empty() {
3254 assert_eq!(announcement_event.len(), 1);
3255 match announcement_event[0] {
3256 MessageSendEvent::SendChannelUpdate { .. } => {},
3257 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3258 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3262 assert!(chan_msgs.0.is_none());
3265 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3266 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3267 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3268 check_added_monitors!(node_b, 1);
3270 assert!(chan_msgs.1.is_none());
3272 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3273 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3274 pending_responding_commitment_signed.1
3276 let commitment_update = chan_msgs.2.unwrap();
3277 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3278 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3279 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3280 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3281 for update_add in commitment_update.update_add_htlcs {
3282 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3284 for update_fulfill in commitment_update.update_fulfill_htlcs {
3285 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3287 for update_fail in commitment_update.update_fail_htlcs {
3288 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3291 if !pending_responding_commitment_signed.1 {
3292 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3294 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3295 check_added_monitors!(node_b, 1);
3296 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3297 // No commitment_signed so get_event_msg's assert(len == 1) passes
3298 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3299 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3300 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3303 assert!(chan_msgs.2.is_none());
3308 /// Initiates channel opening and creates a single batch funding transaction.
3309 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3310 /// transaction with corresponding funding_created messages.
3311 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3312 funding_node: &Node<'a, 'b, 'c>,
3313 params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3314 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3315 let mut tx_outs = Vec::new();
3316 let mut temp_chan_ids = Vec::new();
3317 let mut funding_created_msgs = Vec::new();
3319 for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3320 // Initialize channel opening.
3321 let temp_chan_id = funding_node.node.create_channel(
3322 other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3325 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3326 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3327 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3328 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3330 // Create the corresponding funding output.
3331 let events = funding_node.node.get_and_clear_pending_events();
3332 assert_eq!(events.len(), 1);
3334 Event::FundingGenerationReady {
3335 ref temporary_channel_id,
3336 ref counterparty_node_id,
3337 channel_value_satoshis: ref event_channel_value_satoshis,
3339 user_channel_id: ref event_user_channel_id
3341 assert_eq!(temporary_channel_id, &temp_chan_id);
3342 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3343 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3344 assert_eq!(user_channel_id, event_user_channel_id);
3345 tx_outs.push(TxOut {
3346 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3349 _ => panic!("Unexpected event"),
3351 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3354 // Compose the batch funding transaction and give it to the ChannelManager.
3355 let tx = Transaction {
3357 lock_time: PackedLockTime::ZERO,
3361 assert!(funding_node.node.batch_funding_transaction_generated(
3362 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3365 check_added_monitors!(funding_node, 0);
3366 let events = funding_node.node.get_and_clear_pending_msg_events();
3367 assert_eq!(events.len(), params.len());
3368 for (other_node, ..) in params {
3369 let funding_created = events
3371 .find_map(|event| match event {
3372 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3376 funding_created_msgs.push(funding_created);
3378 return (tx, funding_created_msgs);