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::{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 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
426 pub fn best_block_hash(&self) -> BlockHash {
427 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
429 pub fn best_block_info(&self) -> (BlockHash, u32) {
430 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
432 pub fn get_block_header(&self, height: u32) -> BlockHeader {
433 self.blocks.lock().unwrap()[height as usize].0.header
437 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
438 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
439 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
441 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
443 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
444 Self((node as *const Node<'a, 'b, 'c>).cast())
447 unsafe impl Send for NodePtr {}
448 unsafe impl Sync for NodePtr {}
451 pub trait NodeHolder {
452 type CM: AChannelManager;
453 fn node(&self) -> &ChannelManager<
454 <Self::CM as AChannelManager>::M,
455 <Self::CM as AChannelManager>::T,
456 <Self::CM as AChannelManager>::ES,
457 <Self::CM as AChannelManager>::NS,
458 <Self::CM as AChannelManager>::SP,
459 <Self::CM as AChannelManager>::F,
460 <Self::CM as AChannelManager>::R,
461 <Self::CM as AChannelManager>::L>;
462 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
464 impl<H: NodeHolder> NodeHolder for &H {
466 fn node(&self) -> &ChannelManager<
467 <Self::CM as AChannelManager>::M,
468 <Self::CM as AChannelManager>::T,
469 <Self::CM as AChannelManager>::ES,
470 <Self::CM as AChannelManager>::NS,
471 <Self::CM as AChannelManager>::SP,
472 <Self::CM as AChannelManager>::F,
473 <Self::CM as AChannelManager>::R,
474 <Self::CM as AChannelManager>::L> { (*self).node() }
475 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
477 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
478 type CM = TestChannelManager<'b, 'c>;
479 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
480 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
483 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
486 // Check that we processed all pending events
487 let msg_events = self.node.get_and_clear_pending_msg_events();
488 if !msg_events.is_empty() {
489 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
491 let events = self.node.get_and_clear_pending_events();
492 if !events.is_empty() {
493 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
495 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
496 if !added_monitors.is_empty() {
497 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
500 // Check that if we serialize the network graph, we can deserialize it again.
501 let network_graph = {
502 let mut w = test_utils::TestVecWriter(Vec::new());
503 self.network_graph.write(&mut w).unwrap();
504 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
505 assert!(network_graph_deser == *self.network_graph);
506 let gossip_sync = P2PGossipSync::new(
507 &network_graph_deser, Some(self.chain_source), self.logger
509 let mut chan_progress = 0;
511 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
512 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
513 assert!(orig_announcements == deserialized_announcements);
514 chan_progress = match orig_announcements {
515 Some(announcement) => announcement.0.contents.short_channel_id + 1,
519 let mut node_progress = None;
521 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
522 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
523 assert!(orig_announcements == deserialized_announcements);
524 node_progress = match orig_announcements {
525 Some(announcement) => Some(announcement.contents.node_id),
532 // Check that if we serialize and then deserialize all our channel monitors we get the
533 // same set of outputs to watch for on chain as we have now. Note that if we write
534 // tests that fully close channels and remove the monitors at some point this may break.
535 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
536 let mut deserialized_monitors = Vec::new();
538 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
539 let mut w = test_utils::TestVecWriter(Vec::new());
540 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
541 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
542 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
543 deserialized_monitors.push(deserialized_monitor);
547 let broadcaster = test_utils::TestBroadcaster {
548 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
549 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
552 // Before using all the new monitors to check the watch outpoints, use the full set of
553 // them to ensure we can write and reload our ChannelManager.
555 let mut channel_monitors = HashMap::new();
556 for monitor in deserialized_monitors.iter_mut() {
557 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
560 let scorer = RwLock::new(test_utils::TestScorer::new());
561 let mut w = test_utils::TestVecWriter(Vec::new());
562 self.node.write(&mut w).unwrap();
563 <(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 {
564 default_config: *self.node.get_current_default_configuration(),
565 entropy_source: self.keys_manager,
566 node_signer: self.keys_manager,
567 signer_provider: self.keys_manager,
568 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
569 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
570 chain_monitor: self.chain_monitor,
571 tx_broadcaster: &broadcaster,
572 logger: &self.logger,
577 let persister = test_utils::TestPersister::new();
578 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
579 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
580 for deserialized_monitor in deserialized_monitors.drain(..) {
581 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
585 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
586 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
591 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) {
592 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
595 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) {
596 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
597 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
598 (announcement, as_update, bs_update, channel_id, tx)
601 /// Gets an RAA and CS which were sent in response to a commitment update
602 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
603 let events = node.node().get_and_clear_pending_msg_events();
604 assert_eq!(events.len(), 2);
606 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
607 assert_eq!(node_id, recipient);
610 _ => panic!("Unexpected event"),
612 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
613 assert_eq!(node_id, recipient);
614 assert!(updates.update_add_htlcs.is_empty());
615 assert!(updates.update_fulfill_htlcs.is_empty());
616 assert!(updates.update_fail_htlcs.is_empty());
617 assert!(updates.update_fail_malformed_htlcs.is_empty());
618 assert!(updates.update_fee.is_none());
619 updates.commitment_signed.clone()
621 _ => panic!("Unexpected event"),
626 /// Gets an RAA and CS which were sent in response to a commitment update
628 /// Don't use this, use the identically-named function instead.
629 macro_rules! get_revoke_commit_msgs {
630 ($node: expr, $node_id: expr) => {
631 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
635 /// Get an specific event message from the pending events queue.
637 macro_rules! get_event_msg {
638 ($node: expr, $event_type: path, $node_id: expr) => {
640 let events = $node.node.get_and_clear_pending_msg_events();
641 assert_eq!(events.len(), 1);
643 $event_type { ref node_id, ref msg } => {
644 assert_eq!(*node_id, $node_id);
647 _ => panic!("Unexpected event"),
653 /// Get an error message from the pending events queue.
654 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
655 let events = node.node.get_and_clear_pending_msg_events();
656 assert_eq!(events.len(), 1);
658 MessageSendEvent::HandleError {
659 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
661 assert_eq!(node_id, recipient);
664 _ => panic!("Unexpected event"),
668 /// Get a specific event from the pending events queue.
670 macro_rules! get_event {
671 ($node: expr, $event_type: path) => {
673 let mut events = $node.node.get_and_clear_pending_events();
674 assert_eq!(events.len(), 1);
675 let ev = events.pop().unwrap();
677 $event_type { .. } => {
680 _ => panic!("Unexpected event"),
686 /// Gets an UpdateHTLCs MessageSendEvent
687 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
688 let events = node.node.get_and_clear_pending_msg_events();
689 assert_eq!(events.len(), 1);
691 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
692 assert_eq!(node_id, recipient);
695 _ => panic!("Unexpected event"),
700 /// Gets an UpdateHTLCs MessageSendEvent
702 /// Don't use this, use the identically-named function instead.
703 macro_rules! get_htlc_update_msgs {
704 ($node: expr, $node_id: expr) => {
705 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
709 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
710 /// Returns the `msg_event`.
712 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
713 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
714 /// such messages are intended to all peers.
715 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
716 let ev_index = msg_events.iter().position(|e| { match e {
717 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
718 node_id == msg_node_id
720 MessageSendEvent::SendOpenChannel { node_id, .. } => {
721 node_id == msg_node_id
723 MessageSendEvent::SendFundingCreated { node_id, .. } => {
724 node_id == msg_node_id
726 MessageSendEvent::SendFundingSigned { node_id, .. } => {
727 node_id == msg_node_id
729 MessageSendEvent::SendChannelReady { node_id, .. } => {
730 node_id == msg_node_id
732 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
733 node_id == msg_node_id
735 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
736 node_id == msg_node_id
738 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
739 node_id == msg_node_id
741 MessageSendEvent::SendClosingSigned { node_id, .. } => {
742 node_id == msg_node_id
744 MessageSendEvent::SendShutdown { node_id, .. } => {
745 node_id == msg_node_id
747 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
748 node_id == msg_node_id
750 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
751 node_id == msg_node_id
753 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
756 MessageSendEvent::BroadcastChannelUpdate { .. } => {
759 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
762 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
763 node_id == msg_node_id
765 MessageSendEvent::HandleError { node_id, .. } => {
766 node_id == msg_node_id
768 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
769 node_id == msg_node_id
771 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
772 node_id == msg_node_id
774 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
775 node_id == msg_node_id
777 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
778 node_id == msg_node_id
780 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
781 node_id == msg_node_id
783 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
784 node_id == msg_node_id
786 MessageSendEvent::SendTxAddInput { node_id, .. } => {
787 node_id == msg_node_id
789 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
790 node_id == msg_node_id
792 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
793 node_id == msg_node_id
795 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
796 node_id == msg_node_id
798 MessageSendEvent::SendTxComplete { node_id, .. } => {
799 node_id == msg_node_id
801 MessageSendEvent::SendTxSignatures { node_id, .. } => {
802 node_id == msg_node_id
804 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
805 node_id == msg_node_id
807 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
808 node_id == msg_node_id
810 MessageSendEvent::SendTxAbort { node_id, .. } => {
811 node_id == msg_node_id
814 if ev_index.is_some() {
815 msg_events.remove(ev_index.unwrap())
817 panic!("Couldn't find any MessageSendEvent to the node!")
822 macro_rules! get_channel_ref {
823 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
825 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
826 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
827 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
833 macro_rules! get_feerate {
834 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
836 let mut per_peer_state_lock;
837 let mut peer_state_lock;
838 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
839 phase.context().get_feerate_sat_per_1000_weight()
845 macro_rules! get_channel_type_features {
846 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
848 let mut per_peer_state_lock;
849 let mut peer_state_lock;
850 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
851 chan.context().get_channel_type().clone()
856 /// Returns a channel monitor given a channel id, making some naive assumptions
858 macro_rules! get_monitor {
859 ($node: expr, $channel_id: expr) => {
861 use bitcoin::hashes::Hash;
862 let mut monitor = None;
863 // Assume funding vout is either 0 or 1 blindly
865 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
866 $crate::chain::transaction::OutPoint {
867 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
879 /// Returns any local commitment transactions for the channel.
881 macro_rules! get_local_commitment_txn {
882 ($node: expr, $channel_id: expr) => {
884 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
889 /// Check the error from attempting a payment.
891 macro_rules! unwrap_send_err {
892 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
894 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
895 assert_eq!(fails.len(), 1);
901 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
902 assert_eq!(results.len(), 1);
904 Err($type) => { $check },
913 /// Check whether N channel monitor(s) have been added.
914 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
915 if let Some(chain_monitor) = node.chain_monitor() {
916 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
917 assert_eq!(added_monitors.len(), count);
918 added_monitors.clear();
922 /// Check whether N channel monitor(s) have been added.
924 /// Don't use this, use the identically-named function instead.
926 macro_rules! check_added_monitors {
927 ($node: expr, $count: expr) => {
928 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
932 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
934 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
935 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
936 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
937 let mut nodes = path.iter().rev();
938 let dest = nodes.next().expect("path should have a destination").node;
939 let prev = nodes.next().unwrap_or(&origin_node).node;
940 let dest_channels = dest.list_channels();
941 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
942 .expect("HTLC's channel should be one of destination node's channels");
943 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
944 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
947 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> {
948 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
949 for encoded in monitors_encoded {
950 let mut monitor_read = &encoded[..];
951 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
952 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
953 assert!(monitor_read.is_empty());
954 monitors_read.push(monitor);
957 let mut node_read = &chanman_encoded[..];
958 let (_, node_deserialized) = {
959 let mut channel_monitors = HashMap::new();
960 for monitor in monitors_read.iter_mut() {
961 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
963 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
965 entropy_source: node.keys_manager,
966 node_signer: node.keys_manager,
967 signer_provider: node.keys_manager,
968 fee_estimator: node.fee_estimator,
970 chain_monitor: node.chain_monitor,
971 tx_broadcaster: node.tx_broadcaster,
976 assert!(node_read.is_empty());
978 for monitor in monitors_read.drain(..) {
979 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
980 ChannelMonitorUpdateStatus::Completed);
981 check_added_monitors!(node, 1);
988 macro_rules! reload_node {
989 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
990 let chanman_encoded = $chanman_encoded;
992 $persister = test_utils::TestPersister::new();
993 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
994 $node.chain_monitor = &$new_chain_monitor;
996 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
997 $node.node = &$new_channelmanager;
999 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1000 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1004 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1005 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1006 -> (ChannelId, Transaction, OutPoint)
1008 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1011 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1012 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1013 -> (ChannelId, Transaction, OutPoint)
1015 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1018 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1019 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1020 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1021 let chan_id = *node.network_chan_count.borrow();
1023 let events = node.node.get_and_clear_pending_events();
1024 assert_eq!(events.len(), 1);
1026 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1027 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1028 assert_eq!(*channel_value_satoshis, expected_chan_value);
1029 assert_eq!(user_channel_id, expected_user_chan_id);
1031 let input = if coinbase {
1033 previous_output: bitcoin::OutPoint::null(),
1034 ..Default::default()
1040 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1041 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1043 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1044 (*temporary_channel_id, tx, funding_outpoint)
1046 _ => panic!("Unexpected event"),
1050 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 {
1051 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1052 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1054 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1055 check_added_monitors!(node_a, 0);
1057 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1058 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1059 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1061 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1062 assert_eq!(added_monitors.len(), 1);
1063 assert_eq!(added_monitors[0].0, funding_output);
1064 added_monitors.clear();
1066 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1068 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()));
1070 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1071 assert_eq!(added_monitors.len(), 1);
1072 assert_eq!(added_monitors[0].0, funding_output);
1073 added_monitors.clear();
1075 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1077 let events_4 = node_a.node.get_and_clear_pending_events();
1078 assert_eq!(events_4.len(), 0);
1080 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1081 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1082 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1084 // Ensure that funding_transaction_generated is idempotent.
1085 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1086 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1087 check_added_monitors!(node_a, 0);
1092 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1093 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) {
1094 let initiator_channels = initiator.node.list_usable_channels().len();
1095 let receiver_channels = receiver.node.list_usable_channels().len();
1097 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1098 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1100 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1101 let events = receiver.node.get_and_clear_pending_events();
1102 assert_eq!(events.len(), 1);
1104 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1105 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1107 _ => panic!("Unexpected event"),
1110 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1111 assert_eq!(accept_channel.minimum_depth, 0);
1112 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1114 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1115 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1116 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1118 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1119 check_added_monitors!(receiver, 1);
1120 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1121 assert_eq!(bs_signed_locked.len(), 2);
1122 let as_channel_ready;
1123 match &bs_signed_locked[0] {
1124 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1125 assert_eq!(*node_id, initiator.node.get_our_node_id());
1126 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1127 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1128 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1129 check_added_monitors!(initiator, 1);
1131 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1132 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1134 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1136 _ => panic!("Unexpected event"),
1138 match &bs_signed_locked[1] {
1139 MessageSendEvent::SendChannelReady { node_id, msg } => {
1140 assert_eq!(*node_id, initiator.node.get_our_node_id());
1141 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1142 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1144 _ => panic!("Unexpected event"),
1147 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1148 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1150 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1151 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1153 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1154 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1156 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1157 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1159 (tx, as_channel_ready.channel_id)
1162 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 {
1163 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1164 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1165 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1166 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1167 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1168 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1169 let events = node_b.node.get_and_clear_pending_events();
1170 assert_eq!(events.len(), 1);
1172 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1173 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1174 _ => panic!("Unexpected event"),
1177 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1178 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1179 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1180 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1182 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1185 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) {
1186 confirm_transaction_at(node_conf, tx, conf_height);
1187 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1188 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()));
1191 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) {
1193 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1194 assert_eq!(events_6.len(), 3);
1195 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1196 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1198 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1199 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1201 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1202 ((match events_6[0] {
1203 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1204 channel_id = msg.channel_id.clone();
1205 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1208 _ => panic!("Unexpected event"),
1209 }, match events_6[announcement_sigs_idx] {
1210 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1211 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1214 _ => panic!("Unexpected event"),
1218 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) {
1219 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1220 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1221 confirm_transaction_at(node_a, tx, conf_height);
1222 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1223 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1224 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1227 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) {
1228 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1229 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1233 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) {
1234 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1235 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1236 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1238 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1239 assert_eq!(events_7.len(), 1);
1240 let (announcement, bs_update) = match events_7[0] {
1241 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1242 (msg, update_msg.clone().unwrap())
1244 _ => panic!("Unexpected event"),
1247 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1248 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1249 assert_eq!(events_8.len(), 1);
1250 let as_update = match events_8[0] {
1251 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1252 assert!(*announcement == *msg);
1253 let update_msg = update_msg.clone().unwrap();
1254 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1255 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1258 _ => panic!("Unexpected event"),
1261 *node_a.network_chan_count.borrow_mut() += 1;
1263 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1264 ((*announcement).clone(), as_update, bs_update)
1267 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) {
1268 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1271 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) {
1272 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1273 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1274 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1277 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) {
1278 let mut no_announce_cfg = test_default_channel_config();
1279 no_announce_cfg.channel_handshake_config.announced_channel = false;
1280 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1281 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1282 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1283 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1284 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1286 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1287 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1288 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()));
1289 check_added_monitors!(nodes[b], 1);
1291 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1292 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1294 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1295 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1296 check_added_monitors!(nodes[a], 1);
1298 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1299 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1300 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1302 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1303 confirm_transaction_at(&nodes[a], &tx, conf_height);
1304 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1305 confirm_transaction_at(&nodes[b], &tx, conf_height);
1306 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1307 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1308 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()));
1309 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1310 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1311 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1312 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1313 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1315 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1316 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1318 let mut found_a = false;
1319 for chan in nodes[a].node.list_usable_channels() {
1320 if chan.channel_id == as_channel_ready.channel_id {
1323 assert!(!chan.is_public);
1328 let mut found_b = false;
1329 for chan in nodes[b].node.list_usable_channels() {
1330 if chan.channel_id == as_channel_ready.channel_id {
1333 assert!(!chan.is_public);
1338 (as_channel_ready, tx)
1341 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) {
1343 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1344 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1345 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1347 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1348 // forwarding info for local channels even if its not accepted in the network graph.
1349 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1350 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1354 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1355 for outp in tx.output.iter() {
1356 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1358 let mut total_value_in = 0;
1359 for input in tx.input.iter() {
1360 total_value_in += get_output(&input.previous_output).unwrap().value;
1362 let mut total_value_out = 0;
1363 for output in tx.output.iter() {
1364 total_value_out += output.value;
1366 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1367 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1368 assert!(total_value_out + min_fee <= total_value_in);
1369 tx.verify(get_output).unwrap();
1373 macro_rules! check_spends {
1374 ($tx: expr, $($spends_txn: expr),*) => {
1377 for outp in $spends_txn.output.iter() {
1378 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1381 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1383 if out_point.txid == $spends_txn.txid() {
1384 return $spends_txn.output.get(out_point.vout as usize).cloned()
1389 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1394 macro_rules! get_closing_signed_broadcast {
1395 ($node: expr, $dest_pubkey: expr) => {
1397 let events = $node.get_and_clear_pending_msg_events();
1398 assert!(events.len() == 1 || events.len() == 2);
1399 (match events[events.len() - 1] {
1400 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1401 assert_eq!(msg.contents.flags & 2, 2);
1404 _ => panic!("Unexpected event"),
1405 }, if events.len() == 2 {
1407 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1408 assert_eq!(*node_id, $dest_pubkey);
1411 _ => panic!("Unexpected event"),
1419 macro_rules! check_warn_msg {
1420 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1421 let msg_events = $node.node.get_and_clear_pending_msg_events();
1422 assert_eq!(msg_events.len(), 1);
1423 match msg_events[0] {
1424 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1425 assert_eq!(node_id, $recipient_node_id);
1426 assert_eq!(msg.channel_id, $chan_id);
1429 _ => panic!("Unexpected event"),
1434 /// Check that a channel's closing channel update has been broadcasted, and optionally
1435 /// check whether an error message event has occurred.
1436 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1437 let msg_events = node.node.get_and_clear_pending_msg_events();
1438 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1439 msg_events.into_iter().filter_map(|msg_event| {
1441 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1442 assert_eq!(msg.contents.flags & 2, 2);
1445 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1446 assert!(with_error_msg);
1447 // TODO: Check node_id
1450 _ => panic!("Unexpected event"),
1455 /// Check that a channel's closing channel update has been broadcasted, and optionally
1456 /// check whether an error message event has occurred.
1458 /// Don't use this, use the identically-named function instead.
1460 macro_rules! check_closed_broadcast {
1461 ($node: expr, $with_error_msg: expr) => {
1462 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1466 /// Check that a channel's closing channel events has been issued
1467 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1468 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1469 let events = node.node.get_and_clear_pending_events();
1470 assert_eq!(events.len(), events_count, "{:?}", events);
1471 let mut issues_discard_funding = false;
1472 for (idx, event) in events.into_iter().enumerate() {
1474 Event::ChannelClosed { ref reason, counterparty_node_id,
1475 channel_capacity_sats, .. } => {
1476 assert_eq!(*reason, expected_reason);
1477 assert_eq!(counterparty_node_id.unwrap(), expected_counterparty_node_ids[idx]);
1478 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1480 Event::DiscardFunding { .. } => {
1481 issues_discard_funding = true;
1483 _ => panic!("Unexpected event"),
1486 assert_eq!(is_check_discard_funding, issues_discard_funding);
1489 /// Check that a channel's closing channel events has been issued
1491 /// Don't use this, use the identically-named function instead.
1493 macro_rules! check_closed_event {
1494 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1495 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1497 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1498 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1499 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1503 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) {
1504 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) };
1505 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) };
1508 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1509 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1511 let events_1 = node_b.get_and_clear_pending_msg_events();
1512 assert!(events_1.len() >= 1);
1513 let shutdown_b = match events_1[0] {
1514 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1515 assert_eq!(node_id, &node_a.get_our_node_id());
1518 _ => panic!("Unexpected event"),
1521 let closing_signed_b = if !close_inbound_first {
1522 assert_eq!(events_1.len(), 1);
1525 Some(match events_1[1] {
1526 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1527 assert_eq!(node_id, &node_a.get_our_node_id());
1530 _ => panic!("Unexpected event"),
1534 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1535 let (as_update, bs_update) = if close_inbound_first {
1536 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1537 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1539 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1540 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1541 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1542 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1544 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1545 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1546 assert!(none_a.is_none());
1547 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1548 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1549 (as_update, bs_update)
1551 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1553 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1554 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1556 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1557 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1558 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1560 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1561 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1562 assert!(none_b.is_none());
1563 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1564 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1565 (as_update, bs_update)
1567 assert_eq!(tx_a, tx_b);
1568 check_spends!(tx_a, funding_tx);
1570 (as_update, bs_update, tx_a)
1573 pub struct SendEvent {
1574 pub node_id: PublicKey,
1575 pub msgs: Vec<msgs::UpdateAddHTLC>,
1576 pub commitment_msg: msgs::CommitmentSigned,
1579 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1580 assert!(updates.update_fulfill_htlcs.is_empty());
1581 assert!(updates.update_fail_htlcs.is_empty());
1582 assert!(updates.update_fail_malformed_htlcs.is_empty());
1583 assert!(updates.update_fee.is_none());
1584 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1587 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1589 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1590 _ => panic!("Unexpected event type!"),
1594 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1595 let mut events = node.node.get_and_clear_pending_msg_events();
1596 assert_eq!(events.len(), 1);
1597 SendEvent::from_event(events.pop().unwrap())
1602 /// Don't use this, use the identically-named function instead.
1603 macro_rules! expect_pending_htlcs_forwardable_conditions {
1604 ($node: expr, $expected_failures: expr) => {
1605 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1610 macro_rules! expect_htlc_handling_failed_destinations {
1611 ($events: expr, $expected_failures: expr) => {{
1612 for event in $events {
1614 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1615 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1616 assert!($expected_failures.contains(&failed_next_destination))
1618 _ => panic!("Unexpected destination"),
1624 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1625 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1626 /// `expected_failures` set.
1627 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1629 Event::PendingHTLCsForwardable { .. } => { },
1630 _ => panic!("Unexpected event {:?}", events),
1633 let count = expected_failures.len() + 1;
1634 assert_eq!(events.len(), count);
1636 if expected_failures.len() > 0 {
1637 expect_htlc_handling_failed_destinations!(events, expected_failures)
1642 /// Clears (and ignores) a PendingHTLCsForwardable event
1644 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1646 macro_rules! expect_pending_htlcs_forwardable_ignore {
1648 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1653 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1655 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1656 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1657 ($node: expr, $expected_failures: expr) => {
1658 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1663 /// Handles a PendingHTLCsForwardable event
1664 macro_rules! expect_pending_htlcs_forwardable {
1666 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1667 $node.node.process_pending_htlc_forwards();
1669 // Ensure process_pending_htlc_forwards is idempotent.
1670 $node.node.process_pending_htlc_forwards();
1675 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1676 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1677 ($node: expr, $expected_failures: expr) => {{
1678 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1679 $node.node.process_pending_htlc_forwards();
1681 // Ensure process_pending_htlc_forwards is idempotent.
1682 $node.node.process_pending_htlc_forwards();
1687 macro_rules! expect_pending_htlcs_forwardable_from_events {
1688 ($node: expr, $events: expr, $ignore: expr) => {{
1689 assert_eq!($events.len(), 1);
1691 Event::PendingHTLCsForwardable { .. } => { },
1692 _ => panic!("Unexpected event"),
1695 $node.node.process_pending_htlc_forwards();
1697 // Ensure process_pending_htlc_forwards is idempotent.
1698 $node.node.process_pending_htlc_forwards();
1704 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1705 /// commitment update.
1706 macro_rules! commitment_signed_dance {
1707 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1708 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1710 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1711 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1713 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1715 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1716 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1717 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1718 check_added_monitors(&$node_a, 1);
1719 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1720 assert!(extra_msg_option.is_none());
1724 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1725 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1727 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1728 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1732 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1733 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1734 /// `revoke_and_ack` response to it.
1736 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1737 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1738 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1739 /// the commitment we're exchanging. `includes_claim` provides that information.
1741 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1742 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1743 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1744 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1745 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1749 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1750 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1751 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1753 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1754 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1755 check_added_monitors!(node_b, 0);
1756 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1757 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1758 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1759 check_added_monitors!(node_b, 1);
1760 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1761 let (bs_revoke_and_ack, extra_msg_option) = {
1762 let mut events = node_b.node.get_and_clear_pending_msg_events();
1763 assert!(events.len() <= 2);
1764 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1765 (match node_a_event {
1766 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1767 assert_eq!(*node_id, node_a.node.get_our_node_id());
1770 _ => panic!("Unexpected event"),
1771 }, events.get(0).map(|e| e.clone()))
1773 check_added_monitors!(node_b, 1);
1775 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1776 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1778 (extra_msg_option, bs_revoke_and_ack)
1781 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1782 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1784 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1785 /// on failure or that no new messages are left over on success.
1786 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1787 check_added_monitors!(node_a, 0);
1788 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1789 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1790 check_added_monitors!(node_a, 1);
1792 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1793 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1794 if fail_backwards { assert!(!got_claim); }
1795 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1797 if skip_last_step { return; }
1800 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1801 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1802 check_added_monitors!(node_a, 1);
1804 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1805 let mut number_of_msg_events = 0;
1806 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1807 let peer_state = peer_state_mutex.lock().unwrap();
1808 let cp_pending_msg_events = &peer_state.pending_msg_events;
1809 number_of_msg_events += cp_pending_msg_events.len();
1810 if cp_pending_msg_events.len() == 1 {
1811 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1812 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1813 } else { panic!("Unexpected event"); }
1816 // Expecting the failure backwards event to the previous hop (not `node_b`)
1817 assert_eq!(number_of_msg_events, 1);
1819 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1823 /// Get a payment preimage and hash.
1824 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1825 let mut payment_count = recipient.network_payment_count.borrow_mut();
1826 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1827 *payment_count += 1;
1828 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1829 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1830 (payment_preimage, payment_hash, payment_secret)
1833 /// Get a payment preimage and hash.
1835 /// Don't use this, use the identically-named function instead.
1837 macro_rules! get_payment_preimage_hash {
1838 ($dest_node: expr) => {
1839 get_payment_preimage_hash!($dest_node, None)
1841 ($dest_node: expr, $min_value_msat: expr) => {
1842 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1844 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1845 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1849 /// Gets a route from the given sender to the node described in `payment_params`.
1850 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1851 let scorer = TestScorer::new();
1852 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1853 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1855 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1856 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1857 send_node.logger, &scorer, &(), &random_seed_bytes
1861 /// Gets a route from the given sender to the node described in `payment_params`.
1863 /// Don't use this, use the identically-named function instead.
1865 macro_rules! get_route {
1866 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1867 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1868 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1874 macro_rules! get_route_and_payment_hash {
1875 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1876 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1877 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1878 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1880 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1881 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1882 let (payment_preimage, payment_hash, payment_secret) =
1883 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1884 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1885 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1889 pub fn check_payment_claimable(
1890 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1891 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1892 expected_receiver_node_id: PublicKey,
1895 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1896 assert_eq!(expected_payment_hash, *payment_hash);
1897 assert_eq!(expected_recv_value, *amount_msat);
1898 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1900 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1901 assert_eq!(&expected_payment_preimage, payment_preimage);
1902 assert_eq!(expected_payment_secret, *payment_secret);
1907 _ => panic!("Unexpected event"),
1912 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1913 macro_rules! expect_payment_claimable {
1914 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1915 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1917 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1918 let events = $node.node.get_and_clear_pending_events();
1919 assert_eq!(events.len(), 1);
1920 $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)
1925 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1926 macro_rules! expect_payment_claimed {
1927 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1928 let events = $node.node.get_and_clear_pending_events();
1929 assert_eq!(events.len(), 1);
1931 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1932 assert_eq!($expected_payment_hash, *payment_hash);
1933 assert_eq!($expected_recv_value, amount_msat);
1935 _ => panic!("Unexpected event"),
1940 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1941 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1942 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
1944 let events = node.node().get_and_clear_pending_events();
1945 let expected_payment_hash = PaymentHash(
1946 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1947 if expect_per_path_claims {
1948 assert!(events.len() > 1);
1950 assert_eq!(events.len(), 1);
1952 if expect_post_ev_mon_update {
1953 check_added_monitors(node, 1);
1955 let expected_payment_id = match events[0] {
1956 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1957 assert_eq!(expected_payment_preimage, *payment_preimage);
1958 assert_eq!(expected_payment_hash, *payment_hash);
1959 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1960 assert_eq!(*fee_paid_msat, expected_fee_msat);
1962 assert!(fee_paid_msat.is_some());
1966 _ => panic!("Unexpected event"),
1968 if expect_per_path_claims {
1969 for i in 1..events.len() {
1971 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1972 assert_eq!(payment_id, expected_payment_id);
1973 assert_eq!(payment_hash, Some(expected_payment_hash));
1975 _ => panic!("Unexpected event"),
1982 macro_rules! expect_payment_sent {
1983 ($node: expr, $expected_payment_preimage: expr) => {
1984 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1986 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1987 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1989 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1990 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1991 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
1997 macro_rules! expect_payment_path_successful {
1999 let events = $node.node.get_and_clear_pending_events();
2000 assert_eq!(events.len(), 1);
2002 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2003 _ => panic!("Unexpected event"),
2008 macro_rules! expect_payment_forwarded {
2009 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2010 let events = $node.node.get_and_clear_pending_events();
2011 assert_eq!(events.len(), 1);
2013 Event::PaymentForwarded {
2014 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2015 outbound_amount_forwarded_msat: _
2017 assert_eq!(fee_earned_msat, $expected_fee);
2018 if !$upstream_force_closed {
2019 // Is the event prev_channel_id in one of the channels between the two nodes?
2020 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()));
2022 // We check for force closures since a force closed channel is removed from the
2023 // node's channel list
2024 if !$downstream_force_closed {
2025 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()));
2027 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
2029 _ => panic!("Unexpected event"),
2036 macro_rules! expect_channel_shutdown_state {
2037 ($node: expr, $chan_id: expr, $state: path) => {
2038 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2039 assert_eq!(chan_details.len(), 1);
2040 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2044 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2045 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2046 let events = node.node.get_and_clear_pending_events();
2047 assert_eq!(events.len(), 1);
2049 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2050 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2052 _ => panic!("Unexpected event"),
2056 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2057 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2058 let events = node.node.get_and_clear_pending_events();
2059 assert_eq!(events.len(), 1);
2061 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2062 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2064 _ => panic!("Unexpected event"),
2068 pub struct PaymentFailedConditions<'a> {
2069 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2070 pub(crate) expected_blamed_scid: Option<u64>,
2071 pub(crate) expected_blamed_chan_closed: Option<bool>,
2072 pub(crate) expected_mpp_parts_remain: bool,
2075 impl<'a> PaymentFailedConditions<'a> {
2076 pub fn new() -> Self {
2078 expected_htlc_error_data: None,
2079 expected_blamed_scid: None,
2080 expected_blamed_chan_closed: None,
2081 expected_mpp_parts_remain: false,
2084 pub fn mpp_parts_remain(mut self) -> Self {
2085 self.expected_mpp_parts_remain = true;
2088 pub fn blamed_scid(mut self, scid: u64) -> Self {
2089 self.expected_blamed_scid = Some(scid);
2092 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2093 self.expected_blamed_chan_closed = Some(closed);
2096 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2097 self.expected_htlc_error_data = Some((code, data));
2103 macro_rules! expect_payment_failed_with_update {
2104 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2105 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2106 &$node, $expected_payment_hash, $payment_failed_permanently,
2107 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2108 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2113 macro_rules! expect_payment_failed {
2114 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2115 #[allow(unused_mut)]
2116 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2118 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2120 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2124 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2125 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2126 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2128 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2129 let expected_payment_id = match &payment_failed_events[0] {
2130 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2134 error_data, .. } => {
2135 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2136 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2139 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2140 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2141 if let Some((code, data)) = conditions.expected_htlc_error_data {
2142 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2143 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2147 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2148 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2150 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2151 if let Some(scid) = conditions.expected_blamed_scid {
2152 assert_eq!(msg.contents.short_channel_id, scid);
2154 const CHAN_DISABLED_FLAG: u8 = 2;
2155 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2157 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2158 if let Some(scid) = conditions.expected_blamed_scid {
2159 assert_eq!(*short_channel_id, scid);
2161 assert!(is_permanent);
2163 _ => panic!("Unexpected update type"),
2165 } else { panic!("Expected network update"); }
2170 _ => panic!("Unexpected event"),
2172 if !conditions.expected_mpp_parts_remain {
2173 match &payment_failed_events[1] {
2174 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2175 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2176 assert_eq!(*payment_id, expected_payment_id);
2177 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2178 PaymentFailureReason::RecipientRejected
2180 PaymentFailureReason::RetriesExhausted
2183 _ => panic!("Unexpected second event"),
2188 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2189 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2190 conditions: PaymentFailedConditions<'e>
2192 let events = node.node.get_and_clear_pending_events();
2193 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2196 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 {
2197 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2198 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2199 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2200 check_added_monitors!(origin_node, expected_paths.len());
2201 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2205 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> {
2206 let mut payment_event = SendEvent::from_event(ev);
2207 let mut prev_node = origin_node;
2208 let mut event = None;
2210 for (idx, &node) in expected_path.iter().enumerate() {
2211 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2213 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2214 check_added_monitors!(node, 0);
2215 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2217 expect_pending_htlcs_forwardable!(node);
2219 if idx == expected_path.len() - 1 && clear_recipient_events {
2220 let events_2 = node.node.get_and_clear_pending_events();
2221 if payment_claimable_expected {
2222 assert_eq!(events_2.len(), 1);
2223 match &events_2[0] {
2224 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2225 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2226 claim_deadline, onion_fields, ..
2228 assert_eq!(our_payment_hash, *payment_hash);
2229 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2230 assert!(onion_fields.is_some());
2232 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2233 assert_eq!(expected_preimage, *payment_preimage);
2234 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2235 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2237 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2238 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2239 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2242 assert_eq!(*amount_msat, recv_value);
2243 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2244 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2245 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2247 _ => panic!("Unexpected event"),
2249 event = Some(events_2[0].clone());
2251 assert!(events_2.is_empty());
2253 } else if idx != expected_path.len() - 1 {
2254 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2255 assert_eq!(events_2.len(), 1);
2256 check_added_monitors!(node, 1);
2257 payment_event = SendEvent::from_event(events_2.remove(0));
2258 assert_eq!(payment_event.msgs.len(), 1);
2266 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> {
2267 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2270 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) {
2271 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2272 assert_eq!(events.len(), expected_route.len());
2273 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2274 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2275 // Once we've gotten through all the HTLCs, the last one should result in a
2276 // PaymentClaimable (but each previous one should not!), .
2277 let expect_payment = path_idx == expected_route.len() - 1;
2278 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2282 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) {
2283 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2284 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2285 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2288 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2289 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2290 our_payment_preimage: PaymentPreimage
2292 let extra_fees = vec![0; expected_paths.len()];
2293 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2294 &extra_fees[..], skip_last, our_payment_preimage)
2297 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2298 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2299 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2301 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2302 for path in expected_paths.iter() {
2303 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2305 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2306 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2309 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 {
2310 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2311 assert_eq!(claim_event.len(), 1);
2312 match claim_event[0] {
2313 Event::PaymentClaimed {
2314 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2318 | Event::PaymentClaimed {
2319 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2324 assert_eq!(preimage, our_payment_preimage);
2325 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2326 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2327 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2329 Event::PaymentClaimed {
2330 purpose: PaymentPurpose::InvoicePayment { .. },
2336 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2337 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2338 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2339 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2344 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2346 let mut expected_total_fee_msat = 0;
2348 macro_rules! msgs_from_ev {
2351 &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 } } => {
2352 assert!(update_add_htlcs.is_empty());
2353 assert_eq!(update_fulfill_htlcs.len(), 1);
2354 assert!(update_fail_htlcs.is_empty());
2355 assert!(update_fail_malformed_htlcs.is_empty());
2356 assert!(update_fee.is_none());
2357 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2359 _ => panic!("Unexpected event"),
2363 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2364 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2365 assert_eq!(events.len(), expected_paths.len());
2367 if events.len() == 1 {
2368 per_path_msgs.push(msgs_from_ev!(&events[0]));
2370 for expected_path in expected_paths.iter() {
2371 // For MPP payments, we always want the message to the first node in the path.
2372 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2373 per_path_msgs.push(msgs_from_ev!(&ev));
2377 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2378 let mut next_msgs = Some(path_msgs);
2379 let mut expected_next_node = next_hop;
2381 macro_rules! last_update_fulfill_dance {
2382 ($node: expr, $prev_node: expr) => {
2384 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2385 check_added_monitors!($node, 0);
2386 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2387 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2391 macro_rules! mid_update_fulfill_dance {
2392 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2394 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2396 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2397 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2398 .unwrap().lock().unwrap();
2399 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2400 if let Some(prev_config) = channel.context().prev_config() {
2401 prev_config.forwarding_fee_base_msat
2403 channel.context().config().forwarding_fee_base_msat
2406 if $idx == 1 { fee += expected_extra_fees[i]; }
2407 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2408 expected_total_fee_msat += fee as u64;
2409 check_added_monitors!($node, 1);
2410 let new_next_msgs = if $new_msgs {
2411 let events = $node.node.get_and_clear_pending_msg_events();
2412 assert_eq!(events.len(), 1);
2413 let (res, nexthop) = msgs_from_ev!(&events[0]);
2414 expected_next_node = nexthop;
2417 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2420 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2421 next_msgs = new_next_msgs;
2426 let mut prev_node = expected_route.last().unwrap();
2427 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2428 assert_eq!(expected_next_node, node.node.get_our_node_id());
2429 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2430 if next_msgs.is_some() {
2431 // Since we are traversing in reverse, next_node is actually the previous node
2432 let next_node: &Node;
2433 if idx == expected_route.len() - 1 {
2434 next_node = origin_node;
2436 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2438 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2440 assert!(!update_next_msgs);
2441 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2443 if !skip_last && idx == expected_route.len() - 1 {
2444 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2451 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2455 // Ensure that claim_funds is idempotent.
2456 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2457 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2458 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2460 expected_total_fee_msat
2462 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) {
2463 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2465 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2469 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2470 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2473 pub const TEST_FINAL_CLTV: u32 = 70;
2475 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) {
2476 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2477 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2478 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2479 let route = get_route(origin_node, &route_params).unwrap();
2480 assert_eq!(route.paths.len(), 1);
2481 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2482 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2483 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2486 let res = send_along_route(origin_node, route, expected_route, recv_value);
2487 (res.0, res.1, res.2, res.3)
2490 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2491 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2492 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2493 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2494 let network_graph = origin_node.network_graph.read_only();
2495 let scorer = test_utils::TestScorer::new();
2496 let seed = [0u8; 32];
2497 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2498 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2499 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2500 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2501 assert_eq!(route.paths.len(), 1);
2502 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2503 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2504 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2507 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2508 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2509 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2510 true, APIError::ChannelUnavailable { ref err },
2511 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2514 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) {
2515 let res = route_payment(&origin, expected_route, recv_value);
2516 claim_payment(&origin, expected_route, res.0);
2520 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) {
2521 for path in expected_paths.iter() {
2522 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2524 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2525 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2526 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2528 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2531 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) {
2532 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2533 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2535 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2536 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2537 assert_eq!(events.len(), expected_paths.len());
2538 for ev in events.iter() {
2539 let (update_fail, commitment_signed, node_id) = match ev {
2540 &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 } } => {
2541 assert!(update_add_htlcs.is_empty());
2542 assert!(update_fulfill_htlcs.is_empty());
2543 assert_eq!(update_fail_htlcs.len(), 1);
2544 assert!(update_fail_malformed_htlcs.is_empty());
2545 assert!(update_fee.is_none());
2546 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2548 _ => panic!("Unexpected event"),
2550 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2552 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2553 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()));
2555 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2556 let mut next_msgs = Some(path_msgs);
2557 let mut expected_next_node = next_hop;
2558 let mut prev_node = expected_route.last().unwrap();
2560 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2561 assert_eq!(expected_next_node, node.node.get_our_node_id());
2562 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2563 if next_msgs.is_some() {
2564 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2565 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2566 if !update_next_node {
2567 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 }]);
2570 let events = node.node.get_and_clear_pending_msg_events();
2571 if update_next_node {
2572 assert_eq!(events.len(), 1);
2574 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 } } => {
2575 assert!(update_add_htlcs.is_empty());
2576 assert!(update_fulfill_htlcs.is_empty());
2577 assert_eq!(update_fail_htlcs.len(), 1);
2578 assert!(update_fail_malformed_htlcs.is_empty());
2579 assert!(update_fee.is_none());
2580 expected_next_node = node_id.clone();
2581 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2583 _ => panic!("Unexpected event"),
2586 assert!(events.is_empty());
2588 if !skip_last && idx == expected_route.len() - 1 {
2589 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2596 let prev_node = expected_route.first().unwrap();
2597 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2598 check_added_monitors!(origin_node, 0);
2599 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2600 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2601 let events = origin_node.node.get_and_clear_pending_events();
2602 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2604 let expected_payment_id = match events[0] {
2605 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2606 assert_eq!(payment_hash, our_payment_hash);
2607 assert!(payment_failed_permanently);
2608 for (idx, hop) in expected_route.iter().enumerate() {
2609 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2613 _ => panic!("Unexpected event"),
2615 if i == expected_paths.len() - 1 {
2617 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2618 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2619 assert_eq!(*payment_id, expected_payment_id);
2620 assert_eq!(reason.unwrap(), expected_fail_reason);
2622 _ => panic!("Unexpected second event"),
2628 // Ensure that fail_htlc_backwards is idempotent.
2629 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2630 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2631 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2632 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2635 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2636 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2639 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2640 let mut chan_mon_cfgs = Vec::new();
2641 for i in 0..node_count {
2642 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2643 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2644 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2645 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2646 let persister = test_utils::TestPersister::new();
2647 let seed = [i as u8; 32];
2648 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2649 let scorer = RwLock::new(test_utils::TestScorer::new());
2651 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2657 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2658 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2661 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>> {
2662 let mut nodes = Vec::new();
2664 for i in 0..node_count {
2665 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);
2666 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2667 let seed = [i as u8; 32];
2668 nodes.push(NodeCfg {
2669 chain_source: &chanmon_cfgs[i].chain_source,
2670 logger: &chanmon_cfgs[i].logger,
2671 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2672 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2673 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2675 keys_manager: &chanmon_cfgs[i].keys_manager,
2678 override_init_features: Rc::new(RefCell::new(None)),
2685 pub fn test_default_channel_config() -> UserConfig {
2686 let mut default_config = UserConfig::default();
2687 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2688 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2689 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2690 default_config.channel_handshake_config.announced_channel = true;
2691 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2692 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2693 // It now defaults to 1, so we simply set it to the expected value here.
2694 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2695 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2696 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2698 default_config.channel_config.max_dust_htlc_exposure =
2699 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2703 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>> {
2704 let mut chanmgrs = Vec::new();
2705 for i in 0..node_count {
2706 let network = Network::Testnet;
2707 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2708 let params = ChainParameters {
2710 best_block: BestBlock::from_network(network),
2712 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,
2713 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);
2714 chanmgrs.push(node);
2720 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>> {
2721 let mut nodes = Vec::new();
2722 let chan_count = Rc::new(RefCell::new(0));
2723 let payment_count = Rc::new(RefCell::new(0));
2724 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2726 for i in 0..node_count {
2727 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2728 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2730 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2731 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2732 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2733 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2734 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2735 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2736 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2737 connect_style: Rc::clone(&connect_style),
2738 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2739 wallet_source: Arc::clone(&wallet_source),
2740 bump_tx_handler: BumpTransactionEventHandler::new(
2741 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2742 &cfgs[i].keys_manager, cfgs[i].logger,
2747 for i in 0..node_count {
2748 for j in (i+1)..node_count {
2749 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2750 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2752 remote_network_address: None,
2754 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2755 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2757 remote_network_address: None,
2765 // Note that the following only works for CLTV values up to 128
2766 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2768 #[derive(PartialEq)]
2769 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2770 /// Tests that the given node has broadcast transactions for the given Channel
2772 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2773 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2774 /// broadcast and the revoked outputs were claimed.
2776 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2777 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2779 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2781 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> {
2782 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2783 let mut txn_seen = HashSet::new();
2784 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2785 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2787 let mut res = Vec::with_capacity(2);
2788 node_txn.retain(|tx| {
2789 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2790 check_spends!(tx, chan.3);
2791 if commitment_tx.is_none() {
2792 res.push(tx.clone());
2797 if let Some(explicit_tx) = commitment_tx {
2798 res.push(explicit_tx.clone());
2801 assert_eq!(res.len(), 1);
2803 if has_htlc_tx != HTLCType::NONE {
2804 node_txn.retain(|tx| {
2805 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2806 check_spends!(tx, res[0]);
2807 if has_htlc_tx == HTLCType::TIMEOUT {
2808 assert!(tx.lock_time.0 != 0);
2810 assert!(tx.lock_time.0 == 0);
2812 res.push(tx.clone());
2816 assert!(res.len() == 2 || res.len() == 3);
2818 assert_eq!(res[1], res[2]);
2822 assert!(node_txn.is_empty());
2826 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2827 /// HTLC transaction.
2828 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2829 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2830 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2831 // for revoked htlc outputs
2832 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2833 node_txn.retain(|tx| {
2834 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2835 check_spends!(tx, revoked_tx);
2839 node_txn.retain(|tx| {
2840 check_spends!(tx, commitment_revoked_tx);
2843 assert!(node_txn.is_empty());
2846 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2847 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2848 let mut txn_seen = HashSet::new();
2849 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2851 let mut found_prev = false;
2852 for prev_tx in prev_txn {
2853 for tx in &*node_txn {
2854 if tx.input[0].previous_output.txid == prev_tx.txid() {
2855 check_spends!(tx, prev_tx);
2856 let mut iter = tx.input[0].witness.iter();
2857 iter.next().expect("expected 3 witness items");
2858 iter.next().expect("expected 3 witness items");
2859 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2860 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2867 assert!(found_prev);
2869 let mut res = Vec::new();
2870 mem::swap(&mut *node_txn, &mut res);
2874 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) {
2875 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2876 assert_eq!(events_1.len(), 2);
2877 let as_update = match events_1[0] {
2878 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2881 _ => panic!("Unexpected event"),
2884 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2885 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2886 assert_eq!(msg.data, expected_error);
2887 if needs_err_handle {
2888 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2891 _ => panic!("Unexpected event"),
2894 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2895 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2896 let bs_update = match events_2[0] {
2897 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2900 _ => panic!("Unexpected event"),
2902 if !needs_err_handle {
2904 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2905 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2906 assert_eq!(msg.data, expected_error);
2908 _ => panic!("Unexpected event"),
2913 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2914 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2918 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2919 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2923 macro_rules! get_channel_value_stat {
2924 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2925 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2926 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2927 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
2928 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
2929 ).flatten().unwrap();
2930 chan.get_value_stat()
2934 macro_rules! get_chan_reestablish_msgs {
2935 ($src_node: expr, $dst_node: expr) => {
2937 let mut announcements = $crate::prelude::HashSet::new();
2938 let mut res = Vec::with_capacity(1);
2939 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2940 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2941 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2942 res.push(msg.clone());
2943 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2944 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2945 announcements.insert(msg.contents.short_channel_id);
2947 panic!("Unexpected event")
2950 assert!(announcements.is_empty());
2956 macro_rules! handle_chan_reestablish_msgs {
2957 ($src_node: expr, $dst_node: expr) => {
2959 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2961 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2963 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2969 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2971 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2974 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2975 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2976 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2978 had_channel_update = true;
2981 let mut revoke_and_ack = None;
2982 let mut commitment_update = None;
2983 let order = if let Some(ev) = msg_events.get(idx) {
2985 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2986 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2987 revoke_and_ack = Some(msg.clone());
2989 RAACommitmentOrder::RevokeAndACKFirst
2991 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2992 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2993 commitment_update = Some(updates.clone());
2995 RAACommitmentOrder::CommitmentFirst
2997 _ => RAACommitmentOrder::CommitmentFirst,
3000 RAACommitmentOrder::CommitmentFirst
3003 if let Some(ev) = msg_events.get(idx) {
3005 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3006 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3007 assert!(revoke_and_ack.is_none());
3008 revoke_and_ack = Some(msg.clone());
3011 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3012 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3013 assert!(commitment_update.is_none());
3014 commitment_update = Some(updates.clone());
3021 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3022 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3024 assert!(!had_channel_update);
3027 assert_eq!(msg_events.len(), idx);
3029 (channel_ready, revoke_and_ack, commitment_update, order)
3034 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3035 pub node_a: &'a Node<'b, 'c, 'd>,
3036 pub node_b: &'a Node<'b, 'c, 'd>,
3037 pub send_channel_ready: (bool, bool),
3038 pub pending_responding_commitment_signed: (bool, bool),
3039 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3040 /// and no monitor update is expected
3041 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3042 pub pending_htlc_adds: (usize, usize),
3043 pub pending_htlc_claims: (usize, usize),
3044 pub pending_htlc_fails: (usize, usize),
3045 pub pending_cell_htlc_claims: (usize, usize),
3046 pub pending_cell_htlc_fails: (usize, usize),
3047 pub pending_raa: (bool, bool),
3050 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3051 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3055 send_channel_ready: (false, false),
3056 pending_responding_commitment_signed: (false, false),
3057 pending_responding_commitment_signed_dup_monitor: (false, false),
3058 pending_htlc_adds: (0, 0),
3059 pending_htlc_claims: (0, 0),
3060 pending_htlc_fails: (0, 0),
3061 pending_cell_htlc_claims: (0, 0),
3062 pending_cell_htlc_fails: (0, 0),
3063 pending_raa: (false, false),
3068 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3069 /// for claims/fails they are separated out.
3070 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3072 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3073 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3074 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3076 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3077 features: node_b.node.init_features(), networks: None, remote_network_address: None
3079 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3080 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3081 features: node_a.node.init_features(), networks: None, remote_network_address: None
3083 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3085 if send_channel_ready.0 {
3086 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3088 for reestablish in reestablish_1.iter() {
3089 assert_eq!(reestablish.next_remote_commitment_number, 0);
3092 if send_channel_ready.1 {
3093 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3095 for reestablish in reestablish_2.iter() {
3096 assert_eq!(reestablish.next_remote_commitment_number, 0);
3099 if send_channel_ready.0 || send_channel_ready.1 {
3100 // If we expect any channel_ready's, both sides better have set
3101 // next_holder_commitment_number to 1
3102 for reestablish in reestablish_1.iter() {
3103 assert_eq!(reestablish.next_local_commitment_number, 1);
3105 for reestablish in reestablish_2.iter() {
3106 assert_eq!(reestablish.next_local_commitment_number, 1);
3110 let mut resp_1 = Vec::new();
3111 for msg in reestablish_1 {
3112 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3113 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3115 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3116 check_added_monitors!(node_b, 1);
3118 check_added_monitors!(node_b, 0);
3121 let mut resp_2 = Vec::new();
3122 for msg in reestablish_2 {
3123 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3124 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3126 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3127 check_added_monitors!(node_a, 1);
3129 check_added_monitors!(node_a, 0);
3132 // We don't yet support both needing updates, as that would require a different commitment dance:
3133 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3134 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3135 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3136 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3138 for chan_msgs in resp_1.drain(..) {
3139 if send_channel_ready.0 {
3140 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3141 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3142 if !announcement_event.is_empty() {
3143 assert_eq!(announcement_event.len(), 1);
3144 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3145 //TODO: Test announcement_sigs re-sending
3146 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3149 assert!(chan_msgs.0.is_none());
3152 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3153 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3154 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3155 check_added_monitors!(node_a, 1);
3157 assert!(chan_msgs.1.is_none());
3159 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3160 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3161 pending_responding_commitment_signed.0
3163 let commitment_update = chan_msgs.2.unwrap();
3164 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3165 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3166 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3167 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3168 for update_add in commitment_update.update_add_htlcs {
3169 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3171 for update_fulfill in commitment_update.update_fulfill_htlcs {
3172 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3174 for update_fail in commitment_update.update_fail_htlcs {
3175 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3178 if !pending_responding_commitment_signed.0 {
3179 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3181 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3182 check_added_monitors!(node_a, 1);
3183 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3184 // No commitment_signed so get_event_msg's assert(len == 1) passes
3185 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3186 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3187 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3190 assert!(chan_msgs.2.is_none());
3194 for chan_msgs in resp_2.drain(..) {
3195 if send_channel_ready.1 {
3196 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3197 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3198 if !announcement_event.is_empty() {
3199 assert_eq!(announcement_event.len(), 1);
3200 match announcement_event[0] {
3201 MessageSendEvent::SendChannelUpdate { .. } => {},
3202 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3203 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3207 assert!(chan_msgs.0.is_none());
3210 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3211 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3212 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3213 check_added_monitors!(node_b, 1);
3215 assert!(chan_msgs.1.is_none());
3217 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3218 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3219 pending_responding_commitment_signed.1
3221 let commitment_update = chan_msgs.2.unwrap();
3222 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3223 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3224 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3225 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3226 for update_add in commitment_update.update_add_htlcs {
3227 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3229 for update_fulfill in commitment_update.update_fulfill_htlcs {
3230 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3232 for update_fail in commitment_update.update_fail_htlcs {
3233 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3236 if !pending_responding_commitment_signed.1 {
3237 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3239 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3240 check_added_monitors!(node_b, 1);
3241 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3242 // No commitment_signed so get_event_msg's assert(len == 1) passes
3243 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3244 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3245 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3248 assert!(chan_msgs.2.is_none());