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::{self, 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};
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 the given transaction at the given height, mining blocks as required to build to that
79 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
80 /// output is the 1st output in the transaction.
81 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
82 let first_connect_height = node.best_block_info().1 + 1;
83 assert!(first_connect_height <= conf_height);
84 if conf_height > first_connect_height {
85 connect_blocks(node, conf_height - first_connect_height);
87 let mut txdata = Vec::new();
88 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
89 txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
92 txdata.push((*tx).clone());
94 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
95 connect_block(node, &block);
96 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
98 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
99 confirm_transactions_at(node, &[tx], conf_height)
102 /// The possible ways we may notify a ChannelManager of a new block
103 #[derive(Clone, Copy, Debug, PartialEq)]
104 pub enum ConnectStyle {
105 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
106 /// the header and height information.
108 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
109 /// make a single `best_block_updated` call.
110 BestBlockFirstSkippingBlocks,
111 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
112 /// `transaction_unconfirmed` is called.
113 BestBlockFirstReorgsOnlyTip,
114 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
115 /// the header and height information.
117 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
118 /// make a single `best_block_updated` call.
119 TransactionsFirstSkippingBlocks,
120 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
121 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
122 /// times to ensure it's idempotent.
123 TransactionsDuplicativelyFirstSkippingBlocks,
124 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
125 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
126 /// times to ensure it's idempotent.
127 HighlyRedundantTransactionsFirstSkippingBlocks,
128 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
129 /// `transaction_unconfirmed` is called.
130 TransactionsFirstReorgsOnlyTip,
131 /// Provides the full block via the `chain::Listen` interface. In the current code this is
132 /// equivalent to `TransactionsFirst` with some additional assertions.
137 pub fn skips_blocks(&self) -> bool {
139 ConnectStyle::BestBlockFirst => false,
140 ConnectStyle::BestBlockFirstSkippingBlocks => true,
141 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
142 ConnectStyle::TransactionsFirst => false,
143 ConnectStyle::TransactionsFirstSkippingBlocks => true,
144 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
145 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
146 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
147 ConnectStyle::FullBlockViaListen => false,
151 pub fn updates_best_block_first(&self) -> bool {
153 ConnectStyle::BestBlockFirst => true,
154 ConnectStyle::BestBlockFirstSkippingBlocks => true,
155 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
156 ConnectStyle::TransactionsFirst => false,
157 ConnectStyle::TransactionsFirstSkippingBlocks => false,
158 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
159 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
160 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
161 ConnectStyle::FullBlockViaListen => false,
165 fn random_style() -> ConnectStyle {
166 #[cfg(feature = "std")] {
167 use core::hash::{BuildHasher, Hasher};
168 // Get a random value using the only std API to do so - the DefaultHasher
169 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
170 let res = match rand_val % 9 {
171 0 => ConnectStyle::BestBlockFirst,
172 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
173 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
174 3 => ConnectStyle::TransactionsFirst,
175 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
176 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
177 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
178 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
179 8 => ConnectStyle::FullBlockViaListen,
182 eprintln!("Using Block Connection Style: {:?}", res);
185 #[cfg(not(feature = "std"))] {
186 ConnectStyle::FullBlockViaListen
191 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> BlockHeader {
193 version: 0x2000_0000,
195 merkle_root: TxMerkleNode::all_zeros(),
202 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
203 Block { header: create_dummy_header(prev_blockhash, time), txdata }
206 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
207 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
209 let height = node.best_block_info().1 + 1;
210 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
213 let prev_blockhash = block.header.block_hash();
214 do_connect_block(node, block, skip_intermediaries);
215 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
217 let hash = block.header.block_hash();
218 do_connect_block(node, block, false);
222 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
223 do_connect_block(node, block.clone(), false);
226 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
227 // Ensure `get_claimable_balances`' self-tests never panic
228 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
229 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
233 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
234 call_claimable_balances(node);
235 let height = node.best_block_info().1 + 1;
236 #[cfg(feature = "std")] {
237 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
239 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
240 // transaction broadcast are correct.
241 node.blocks.lock().unwrap().push((block.clone(), height));
242 if !skip_intermediaries {
243 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
244 match *node.connect_style.borrow() {
245 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
246 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
247 call_claimable_balances(node);
248 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
249 node.node.best_block_updated(&block.header, height);
250 node.node.transactions_confirmed(&block.header, &txdata, height);
252 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
253 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
254 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
255 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
256 let mut connections = Vec::new();
257 for (block, height) in node.blocks.lock().unwrap().iter() {
258 if !block.txdata.is_empty() {
259 // Reconnect all transactions we've ever seen to ensure transaction connection
260 // is *really* idempotent. This is a somewhat likely deployment for some
261 // esplora implementations of chain sync which try to reduce state and
262 // complexity as much as possible.
264 // Sadly we have to clone the block here to maintain lockorder. In the
265 // future we should consider Arc'ing the blocks to avoid this.
266 connections.push((block.clone(), *height));
269 for (old_block, height) in connections {
270 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
271 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
274 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
275 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
276 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
278 call_claimable_balances(node);
279 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
280 node.node.transactions_confirmed(&block.header, &txdata, height);
281 node.node.best_block_updated(&block.header, height);
283 ConnectStyle::FullBlockViaListen => {
284 node.chain_monitor.chain_monitor.block_connected(&block, height);
285 node.node.block_connected(&block, height);
289 call_claimable_balances(node);
290 node.node.test_process_background_events();
292 for tx in &block.txdata {
293 for input in &tx.input {
294 node.wallet_source.remove_utxo(input.previous_output);
296 let wallet_script = node.wallet_source.get_change_script().unwrap();
297 for (idx, output) in tx.output.iter().enumerate() {
298 if output.script_pubkey == wallet_script {
299 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
300 node.wallet_source.add_utxo(outpoint, output.value);
306 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
307 call_claimable_balances(node);
308 #[cfg(feature = "std")] {
309 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
312 let orig = node.blocks.lock().unwrap().pop().unwrap();
313 assert!(orig.1 > 0); // Cannot disconnect genesis
314 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
316 match *node.connect_style.borrow() {
317 ConnectStyle::FullBlockViaListen => {
318 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
319 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
321 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
322 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
324 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
325 node.node.best_block_updated(&prev.0.header, prev.1);
328 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
329 for tx in orig.0.txdata {
330 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
331 node.node.transaction_unconfirmed(&tx.txid());
335 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
336 node.node.best_block_updated(&prev.0.header, prev.1);
339 call_claimable_balances(node);
343 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
344 let count = node.blocks.lock().unwrap().len() as u32 - 1;
345 disconnect_blocks(node, count);
348 pub struct TestChanMonCfg {
349 pub tx_broadcaster: test_utils::TestBroadcaster,
350 pub fee_estimator: test_utils::TestFeeEstimator,
351 pub chain_source: test_utils::TestChainSource,
352 pub persister: test_utils::TestPersister,
353 pub logger: test_utils::TestLogger,
354 pub keys_manager: test_utils::TestKeysInterface,
355 pub scorer: RwLock<test_utils::TestScorer>,
358 pub struct NodeCfg<'a> {
359 pub chain_source: &'a test_utils::TestChainSource,
360 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
361 pub fee_estimator: &'a test_utils::TestFeeEstimator,
362 pub router: test_utils::TestRouter<'a>,
363 pub chain_monitor: test_utils::TestChainMonitor<'a>,
364 pub keys_manager: &'a test_utils::TestKeysInterface,
365 pub logger: &'a test_utils::TestLogger,
366 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
367 pub node_seed: [u8; 32],
368 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
371 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
372 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
373 &'chan_mon_cfg test_utils::TestBroadcaster,
374 &'node_cfg test_utils::TestKeysInterface,
375 &'node_cfg test_utils::TestKeysInterface,
376 &'node_cfg test_utils::TestKeysInterface,
377 &'chan_mon_cfg test_utils::TestFeeEstimator,
378 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
379 &'chan_mon_cfg test_utils::TestLogger,
382 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
383 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
384 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
385 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
386 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
387 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
388 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
389 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
390 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
391 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>,
392 pub node_seed: [u8; 32],
393 pub network_payment_count: Rc<RefCell<u8>>,
394 pub network_chan_count: Rc<RefCell<u32>>,
395 pub logger: &'chan_mon_cfg test_utils::TestLogger,
396 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
397 pub connect_style: Rc<RefCell<ConnectStyle>>,
398 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
399 pub wallet_source: Arc<test_utils::TestWalletSource>,
400 pub bump_tx_handler: BumpTransactionEventHandler<
401 &'chan_mon_cfg test_utils::TestBroadcaster,
402 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
403 &'chan_mon_cfg test_utils::TestKeysInterface,
404 &'chan_mon_cfg test_utils::TestLogger,
407 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
408 pub fn best_block_hash(&self) -> BlockHash {
409 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
411 pub fn best_block_info(&self) -> (BlockHash, u32) {
412 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
414 pub fn get_block_header(&self, height: u32) -> BlockHeader {
415 self.blocks.lock().unwrap()[height as usize].0.header
419 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
420 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
421 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
423 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
425 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
426 Self((node as *const Node<'a, 'b, 'c>).cast())
429 unsafe impl Send for NodePtr {}
430 unsafe impl Sync for NodePtr {}
433 pub trait NodeHolder {
434 type CM: AChannelManager;
435 fn node(&self) -> &ChannelManager<
436 <Self::CM as AChannelManager>::M,
437 <Self::CM as AChannelManager>::T,
438 <Self::CM as AChannelManager>::ES,
439 <Self::CM as AChannelManager>::NS,
440 <Self::CM as AChannelManager>::SP,
441 <Self::CM as AChannelManager>::F,
442 <Self::CM as AChannelManager>::R,
443 <Self::CM as AChannelManager>::L>;
444 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
446 impl<H: NodeHolder> NodeHolder for &H {
448 fn node(&self) -> &ChannelManager<
449 <Self::CM as AChannelManager>::M,
450 <Self::CM as AChannelManager>::T,
451 <Self::CM as AChannelManager>::ES,
452 <Self::CM as AChannelManager>::NS,
453 <Self::CM as AChannelManager>::SP,
454 <Self::CM as AChannelManager>::F,
455 <Self::CM as AChannelManager>::R,
456 <Self::CM as AChannelManager>::L> { (*self).node() }
457 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
459 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
460 type CM = TestChannelManager<'b, 'c>;
461 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
462 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
465 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
468 // Check that we processed all pending events
469 let msg_events = self.node.get_and_clear_pending_msg_events();
470 if !msg_events.is_empty() {
471 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
473 let events = self.node.get_and_clear_pending_events();
474 if !events.is_empty() {
475 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
477 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
478 if !added_monitors.is_empty() {
479 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
482 // Check that if we serialize the network graph, we can deserialize it again.
483 let network_graph = {
484 let mut w = test_utils::TestVecWriter(Vec::new());
485 self.network_graph.write(&mut w).unwrap();
486 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
487 assert!(network_graph_deser == *self.network_graph);
488 let gossip_sync = P2PGossipSync::new(
489 &network_graph_deser, Some(self.chain_source), self.logger
491 let mut chan_progress = 0;
493 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
494 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
495 assert!(orig_announcements == deserialized_announcements);
496 chan_progress = match orig_announcements {
497 Some(announcement) => announcement.0.contents.short_channel_id + 1,
501 let mut node_progress = None;
503 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
504 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
505 assert!(orig_announcements == deserialized_announcements);
506 node_progress = match orig_announcements {
507 Some(announcement) => Some(announcement.contents.node_id),
514 // Check that if we serialize and then deserialize all our channel monitors we get the
515 // same set of outputs to watch for on chain as we have now. Note that if we write
516 // tests that fully close channels and remove the monitors at some point this may break.
517 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
518 let mut deserialized_monitors = Vec::new();
520 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
521 let mut w = test_utils::TestVecWriter(Vec::new());
522 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
523 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
524 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
525 deserialized_monitors.push(deserialized_monitor);
529 let broadcaster = test_utils::TestBroadcaster {
530 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
531 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
534 // Before using all the new monitors to check the watch outpoints, use the full set of
535 // them to ensure we can write and reload our ChannelManager.
537 let mut channel_monitors = HashMap::new();
538 for monitor in deserialized_monitors.iter_mut() {
539 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
542 let scorer = RwLock::new(test_utils::TestScorer::new());
543 let mut w = test_utils::TestVecWriter(Vec::new());
544 self.node.write(&mut w).unwrap();
545 <(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 {
546 default_config: *self.node.get_current_default_configuration(),
547 entropy_source: self.keys_manager,
548 node_signer: self.keys_manager,
549 signer_provider: self.keys_manager,
550 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
551 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
552 chain_monitor: self.chain_monitor,
553 tx_broadcaster: &broadcaster,
554 logger: &self.logger,
559 let persister = test_utils::TestPersister::new();
560 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
561 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
562 for deserialized_monitor in deserialized_monitors.drain(..) {
563 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
567 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
568 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
573 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) {
574 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
577 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) {
578 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
579 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
580 (announcement, as_update, bs_update, channel_id, tx)
583 /// Gets an RAA and CS which were sent in response to a commitment update
584 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
585 let events = node.node().get_and_clear_pending_msg_events();
586 assert_eq!(events.len(), 2);
588 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
589 assert_eq!(node_id, recipient);
592 _ => panic!("Unexpected event"),
594 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
595 assert_eq!(node_id, recipient);
596 assert!(updates.update_add_htlcs.is_empty());
597 assert!(updates.update_fulfill_htlcs.is_empty());
598 assert!(updates.update_fail_htlcs.is_empty());
599 assert!(updates.update_fail_malformed_htlcs.is_empty());
600 assert!(updates.update_fee.is_none());
601 updates.commitment_signed.clone()
603 _ => panic!("Unexpected event"),
608 /// Gets an RAA and CS which were sent in response to a commitment update
610 /// Don't use this, use the identically-named function instead.
611 macro_rules! get_revoke_commit_msgs {
612 ($node: expr, $node_id: expr) => {
613 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
617 /// Get an specific event message from the pending events queue.
619 macro_rules! get_event_msg {
620 ($node: expr, $event_type: path, $node_id: expr) => {
622 let events = $node.node.get_and_clear_pending_msg_events();
623 assert_eq!(events.len(), 1);
625 $event_type { ref node_id, ref msg } => {
626 assert_eq!(*node_id, $node_id);
629 _ => panic!("Unexpected event"),
635 /// Get an error message from the pending events queue.
636 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
637 let events = node.node.get_and_clear_pending_msg_events();
638 assert_eq!(events.len(), 1);
640 MessageSendEvent::HandleError {
641 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
643 assert_eq!(node_id, recipient);
646 _ => panic!("Unexpected event"),
650 /// Get a specific event from the pending events queue.
652 macro_rules! get_event {
653 ($node: expr, $event_type: path) => {
655 let mut events = $node.node.get_and_clear_pending_events();
656 assert_eq!(events.len(), 1);
657 let ev = events.pop().unwrap();
659 $event_type { .. } => {
662 _ => panic!("Unexpected event"),
668 /// Gets an UpdateHTLCs MessageSendEvent
669 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
670 let events = node.node.get_and_clear_pending_msg_events();
671 assert_eq!(events.len(), 1);
673 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
674 assert_eq!(node_id, recipient);
677 _ => panic!("Unexpected event"),
682 /// Gets an UpdateHTLCs MessageSendEvent
684 /// Don't use this, use the identically-named function instead.
685 macro_rules! get_htlc_update_msgs {
686 ($node: expr, $node_id: expr) => {
687 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
691 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
692 /// Returns the `msg_event`.
694 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
695 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
696 /// such messages are intended to all peers.
697 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
698 let ev_index = msg_events.iter().position(|e| { match e {
699 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
700 node_id == msg_node_id
702 MessageSendEvent::SendOpenChannel { node_id, .. } => {
703 node_id == msg_node_id
705 MessageSendEvent::SendFundingCreated { node_id, .. } => {
706 node_id == msg_node_id
708 MessageSendEvent::SendFundingSigned { node_id, .. } => {
709 node_id == msg_node_id
711 MessageSendEvent::SendChannelReady { node_id, .. } => {
712 node_id == msg_node_id
714 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
715 node_id == msg_node_id
717 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
718 node_id == msg_node_id
720 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
721 node_id == msg_node_id
723 MessageSendEvent::SendClosingSigned { node_id, .. } => {
724 node_id == msg_node_id
726 MessageSendEvent::SendShutdown { node_id, .. } => {
727 node_id == msg_node_id
729 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
730 node_id == msg_node_id
732 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
733 node_id == msg_node_id
735 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
738 MessageSendEvent::BroadcastChannelUpdate { .. } => {
741 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
744 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
745 node_id == msg_node_id
747 MessageSendEvent::HandleError { node_id, .. } => {
748 node_id == msg_node_id
750 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
751 node_id == msg_node_id
753 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
754 node_id == msg_node_id
756 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
757 node_id == msg_node_id
759 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
760 node_id == msg_node_id
762 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
763 node_id == msg_node_id
765 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
766 node_id == msg_node_id
768 MessageSendEvent::SendTxAddInput { node_id, .. } => {
769 node_id == msg_node_id
771 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
772 node_id == msg_node_id
774 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
775 node_id == msg_node_id
777 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
778 node_id == msg_node_id
780 MessageSendEvent::SendTxComplete { node_id, .. } => {
781 node_id == msg_node_id
783 MessageSendEvent::SendTxSignatures { node_id, .. } => {
784 node_id == msg_node_id
786 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
787 node_id == msg_node_id
789 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
790 node_id == msg_node_id
792 MessageSendEvent::SendTxAbort { node_id, .. } => {
793 node_id == msg_node_id
796 if ev_index.is_some() {
797 msg_events.remove(ev_index.unwrap())
799 panic!("Couldn't find any MessageSendEvent to the node!")
804 macro_rules! get_channel_ref {
805 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
807 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
808 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
809 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
815 macro_rules! get_outbound_v1_channel_ref {
816 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
818 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
819 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
820 $peer_state_lock.outbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
826 macro_rules! get_inbound_v1_channel_ref {
827 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
829 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
830 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
831 $peer_state_lock.inbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
837 macro_rules! get_feerate {
838 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
840 let mut per_peer_state_lock;
841 let mut peer_state_lock;
842 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
843 chan.context.get_feerate_sat_per_1000_weight()
849 macro_rules! get_channel_type_features {
850 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
852 let mut per_peer_state_lock;
853 let mut peer_state_lock;
854 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
855 chan.context.get_channel_type().clone()
860 /// Returns a channel monitor given a channel id, making some naive assumptions
862 macro_rules! get_monitor {
863 ($node: expr, $channel_id: expr) => {
865 use bitcoin::hashes::Hash;
866 let mut monitor = None;
867 // Assume funding vout is either 0 or 1 blindly
869 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
870 $crate::chain::transaction::OutPoint {
871 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
883 /// Returns any local commitment transactions for the channel.
885 macro_rules! get_local_commitment_txn {
886 ($node: expr, $channel_id: expr) => {
888 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
893 /// Check the error from attempting a payment.
895 macro_rules! unwrap_send_err {
896 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
898 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
899 assert_eq!(fails.len(), 1);
905 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
906 assert_eq!(results.len(), 1);
908 Err($type) => { $check },
917 /// Check whether N channel monitor(s) have been added.
918 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
919 if let Some(chain_monitor) = node.chain_monitor() {
920 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
921 assert_eq!(added_monitors.len(), count);
922 added_monitors.clear();
926 /// Check whether N channel monitor(s) have been added.
928 /// Don't use this, use the identically-named function instead.
930 macro_rules! check_added_monitors {
931 ($node: expr, $count: expr) => {
932 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
936 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
938 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
939 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
940 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
941 let mut nodes = path.iter().rev();
942 let dest = nodes.next().expect("path should have a destination").node;
943 let prev = nodes.next().unwrap_or(&origin_node).node;
944 let dest_channels = dest.list_channels();
945 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
946 .expect("HTLC's channel should be one of destination node's channels");
947 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
948 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
951 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> {
952 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
953 for encoded in monitors_encoded {
954 let mut monitor_read = &encoded[..];
955 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
956 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
957 assert!(monitor_read.is_empty());
958 monitors_read.push(monitor);
961 let mut node_read = &chanman_encoded[..];
962 let (_, node_deserialized) = {
963 let mut channel_monitors = HashMap::new();
964 for monitor in monitors_read.iter_mut() {
965 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
967 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
969 entropy_source: node.keys_manager,
970 node_signer: node.keys_manager,
971 signer_provider: node.keys_manager,
972 fee_estimator: node.fee_estimator,
974 chain_monitor: node.chain_monitor,
975 tx_broadcaster: node.tx_broadcaster,
980 assert!(node_read.is_empty());
982 for monitor in monitors_read.drain(..) {
983 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
984 ChannelMonitorUpdateStatus::Completed);
985 check_added_monitors!(node, 1);
992 macro_rules! reload_node {
993 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
994 let chanman_encoded = $chanman_encoded;
996 $persister = test_utils::TestPersister::new();
997 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
998 $node.chain_monitor = &$new_chain_monitor;
1000 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1001 $node.node = &$new_channelmanager;
1003 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1004 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1008 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1009 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1010 -> (ChannelId, Transaction, OutPoint)
1012 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1015 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1016 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1017 -> (ChannelId, Transaction, OutPoint)
1019 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1022 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1023 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1024 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1025 let chan_id = *node.network_chan_count.borrow();
1027 let events = node.node.get_and_clear_pending_events();
1028 assert_eq!(events.len(), 1);
1030 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1031 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1032 assert_eq!(*channel_value_satoshis, expected_chan_value);
1033 assert_eq!(user_channel_id, expected_user_chan_id);
1035 let input = if coinbase {
1037 previous_output: bitcoin::OutPoint::null(),
1038 ..Default::default()
1044 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1045 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1047 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1048 (*temporary_channel_id, tx, funding_outpoint)
1050 _ => panic!("Unexpected event"),
1054 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 {
1055 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1056 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1058 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1059 check_added_monitors!(node_a, 0);
1061 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1062 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1063 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1065 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1066 assert_eq!(added_monitors.len(), 1);
1067 assert_eq!(added_monitors[0].0, funding_output);
1068 added_monitors.clear();
1070 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1072 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()));
1074 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1075 assert_eq!(added_monitors.len(), 1);
1076 assert_eq!(added_monitors[0].0, funding_output);
1077 added_monitors.clear();
1079 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1081 let events_4 = node_a.node.get_and_clear_pending_events();
1082 assert_eq!(events_4.len(), 0);
1084 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1085 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1086 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1088 // Ensure that funding_transaction_generated is idempotent.
1089 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1090 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1091 check_added_monitors!(node_a, 0);
1096 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1097 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) {
1098 let initiator_channels = initiator.node.list_usable_channels().len();
1099 let receiver_channels = receiver.node.list_usable_channels().len();
1101 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1102 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1104 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1105 let events = receiver.node.get_and_clear_pending_events();
1106 assert_eq!(events.len(), 1);
1108 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1109 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1111 _ => panic!("Unexpected event"),
1114 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1115 assert_eq!(accept_channel.minimum_depth, 0);
1116 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1118 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1119 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1120 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1122 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1123 check_added_monitors!(receiver, 1);
1124 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1125 assert_eq!(bs_signed_locked.len(), 2);
1126 let as_channel_ready;
1127 match &bs_signed_locked[0] {
1128 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1129 assert_eq!(*node_id, initiator.node.get_our_node_id());
1130 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1131 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1132 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1133 check_added_monitors!(initiator, 1);
1135 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1136 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1138 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1140 _ => panic!("Unexpected event"),
1142 match &bs_signed_locked[1] {
1143 MessageSendEvent::SendChannelReady { node_id, msg } => {
1144 assert_eq!(*node_id, initiator.node.get_our_node_id());
1145 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1146 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1148 _ => panic!("Unexpected event"),
1151 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1152 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1154 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1155 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1157 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1158 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1160 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1161 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1163 (tx, as_channel_ready.channel_id)
1166 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 {
1167 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1168 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1169 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1170 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1171 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1172 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1173 let events = node_b.node.get_and_clear_pending_events();
1174 assert_eq!(events.len(), 1);
1176 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1177 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1178 _ => panic!("Unexpected event"),
1181 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1182 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1183 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1184 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1186 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1189 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) {
1190 confirm_transaction_at(node_conf, tx, conf_height);
1191 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1192 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()));
1195 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) {
1197 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1198 assert_eq!(events_6.len(), 3);
1199 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1200 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1202 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1203 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1205 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1206 ((match events_6[0] {
1207 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1208 channel_id = msg.channel_id.clone();
1209 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1212 _ => panic!("Unexpected event"),
1213 }, match events_6[announcement_sigs_idx] {
1214 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1215 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1218 _ => panic!("Unexpected event"),
1222 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) {
1223 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1224 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1225 confirm_transaction_at(node_a, tx, conf_height);
1226 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1227 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1228 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1231 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) {
1232 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1233 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1237 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) {
1238 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1239 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1240 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1242 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1243 assert_eq!(events_7.len(), 1);
1244 let (announcement, bs_update) = match events_7[0] {
1245 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1246 (msg, update_msg.clone().unwrap())
1248 _ => panic!("Unexpected event"),
1251 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1252 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1253 assert_eq!(events_8.len(), 1);
1254 let as_update = match events_8[0] {
1255 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1256 assert!(*announcement == *msg);
1257 let update_msg = update_msg.clone().unwrap();
1258 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1259 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1262 _ => panic!("Unexpected event"),
1265 *node_a.network_chan_count.borrow_mut() += 1;
1267 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1268 ((*announcement).clone(), as_update, bs_update)
1271 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) {
1272 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1275 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) {
1276 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1277 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1278 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1281 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) {
1282 let mut no_announce_cfg = test_default_channel_config();
1283 no_announce_cfg.channel_handshake_config.announced_channel = false;
1284 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1285 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1286 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1287 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1288 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1290 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1291 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1292 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()));
1293 check_added_monitors!(nodes[b], 1);
1295 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1296 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1298 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1299 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1300 check_added_monitors!(nodes[a], 1);
1302 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1303 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1304 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1306 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1307 confirm_transaction_at(&nodes[a], &tx, conf_height);
1308 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1309 confirm_transaction_at(&nodes[b], &tx, conf_height);
1310 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1311 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1312 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()));
1313 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1314 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1315 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1316 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1317 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1319 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1320 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1322 let mut found_a = false;
1323 for chan in nodes[a].node.list_usable_channels() {
1324 if chan.channel_id == as_channel_ready.channel_id {
1327 assert!(!chan.is_public);
1332 let mut found_b = false;
1333 for chan in nodes[b].node.list_usable_channels() {
1334 if chan.channel_id == as_channel_ready.channel_id {
1337 assert!(!chan.is_public);
1342 (as_channel_ready, tx)
1345 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) {
1347 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1348 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1349 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1351 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1352 // forwarding info for local channels even if its not accepted in the network graph.
1353 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1354 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1358 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1359 for outp in tx.output.iter() {
1360 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1362 let mut total_value_in = 0;
1363 for input in tx.input.iter() {
1364 total_value_in += get_output(&input.previous_output).unwrap().value;
1366 let mut total_value_out = 0;
1367 for output in tx.output.iter() {
1368 total_value_out += output.value;
1370 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1371 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1372 assert!(total_value_out + min_fee <= total_value_in);
1373 tx.verify(get_output).unwrap();
1377 macro_rules! check_spends {
1378 ($tx: expr, $($spends_txn: expr),*) => {
1381 for outp in $spends_txn.output.iter() {
1382 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1385 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1387 if out_point.txid == $spends_txn.txid() {
1388 return $spends_txn.output.get(out_point.vout as usize).cloned()
1393 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1398 macro_rules! get_closing_signed_broadcast {
1399 ($node: expr, $dest_pubkey: expr) => {
1401 let events = $node.get_and_clear_pending_msg_events();
1402 assert!(events.len() == 1 || events.len() == 2);
1403 (match events[events.len() - 1] {
1404 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1405 assert_eq!(msg.contents.flags & 2, 2);
1408 _ => panic!("Unexpected event"),
1409 }, if events.len() == 2 {
1411 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1412 assert_eq!(*node_id, $dest_pubkey);
1415 _ => panic!("Unexpected event"),
1423 macro_rules! check_warn_msg {
1424 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1425 let msg_events = $node.node.get_and_clear_pending_msg_events();
1426 assert_eq!(msg_events.len(), 1);
1427 match msg_events[0] {
1428 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1429 assert_eq!(node_id, $recipient_node_id);
1430 assert_eq!(msg.channel_id, $chan_id);
1433 _ => panic!("Unexpected event"),
1438 /// Check that a channel's closing channel update has been broadcasted, and optionally
1439 /// check whether an error message event has occurred.
1440 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1441 let msg_events = node.node.get_and_clear_pending_msg_events();
1442 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1443 msg_events.into_iter().filter_map(|msg_event| {
1445 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1446 assert_eq!(msg.contents.flags & 2, 2);
1449 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1450 assert!(with_error_msg);
1451 // TODO: Check node_id
1454 _ => panic!("Unexpected event"),
1459 /// Check that a channel's closing channel update has been broadcasted, and optionally
1460 /// check whether an error message event has occurred.
1462 /// Don't use this, use the identically-named function instead.
1464 macro_rules! check_closed_broadcast {
1465 ($node: expr, $with_error_msg: expr) => {
1466 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1470 /// Check that a channel's closing channel events has been issued
1471 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1472 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1473 let events = node.node.get_and_clear_pending_events();
1474 assert_eq!(events.len(), events_count, "{:?}", events);
1475 let mut issues_discard_funding = false;
1476 for (idx, event) in events.into_iter().enumerate() {
1478 Event::ChannelClosed { ref reason, counterparty_node_id,
1479 channel_capacity_sats, .. } => {
1480 assert_eq!(*reason, expected_reason);
1481 assert_eq!(counterparty_node_id.unwrap(), expected_counterparty_node_ids[idx]);
1482 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1484 Event::DiscardFunding { .. } => {
1485 issues_discard_funding = true;
1487 _ => panic!("Unexpected event"),
1490 assert_eq!(is_check_discard_funding, issues_discard_funding);
1493 /// Check that a channel's closing channel events has been issued
1495 /// Don't use this, use the identically-named function instead.
1497 macro_rules! check_closed_event {
1498 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1499 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1501 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1502 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1503 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1507 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) {
1508 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) };
1509 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) };
1512 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1513 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1515 let events_1 = node_b.get_and_clear_pending_msg_events();
1516 assert!(events_1.len() >= 1);
1517 let shutdown_b = match events_1[0] {
1518 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1519 assert_eq!(node_id, &node_a.get_our_node_id());
1522 _ => panic!("Unexpected event"),
1525 let closing_signed_b = if !close_inbound_first {
1526 assert_eq!(events_1.len(), 1);
1529 Some(match events_1[1] {
1530 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1531 assert_eq!(node_id, &node_a.get_our_node_id());
1534 _ => panic!("Unexpected event"),
1538 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1539 let (as_update, bs_update) = if close_inbound_first {
1540 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1541 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1543 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1544 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1545 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1546 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1548 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1549 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1550 assert!(none_a.is_none());
1551 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1552 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1553 (as_update, bs_update)
1555 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1557 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1558 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1560 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1561 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1562 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1564 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1565 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1566 assert!(none_b.is_none());
1567 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1568 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1569 (as_update, bs_update)
1571 assert_eq!(tx_a, tx_b);
1572 check_spends!(tx_a, funding_tx);
1574 (as_update, bs_update, tx_a)
1577 pub struct SendEvent {
1578 pub node_id: PublicKey,
1579 pub msgs: Vec<msgs::UpdateAddHTLC>,
1580 pub commitment_msg: msgs::CommitmentSigned,
1583 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1584 assert!(updates.update_fulfill_htlcs.is_empty());
1585 assert!(updates.update_fail_htlcs.is_empty());
1586 assert!(updates.update_fail_malformed_htlcs.is_empty());
1587 assert!(updates.update_fee.is_none());
1588 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1591 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1593 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1594 _ => panic!("Unexpected event type!"),
1598 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1599 let mut events = node.node.get_and_clear_pending_msg_events();
1600 assert_eq!(events.len(), 1);
1601 SendEvent::from_event(events.pop().unwrap())
1606 /// Don't use this, use the identically-named function instead.
1607 macro_rules! expect_pending_htlcs_forwardable_conditions {
1608 ($node: expr, $expected_failures: expr) => {
1609 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1614 macro_rules! expect_htlc_handling_failed_destinations {
1615 ($events: expr, $expected_failures: expr) => {{
1616 for event in $events {
1618 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1619 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1620 assert!($expected_failures.contains(&failed_next_destination))
1622 _ => panic!("Unexpected destination"),
1628 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1629 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1630 /// `expected_failures` set.
1631 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1633 Event::PendingHTLCsForwardable { .. } => { },
1634 _ => panic!("Unexpected event {:?}", events),
1637 let count = expected_failures.len() + 1;
1638 assert_eq!(events.len(), count);
1640 if expected_failures.len() > 0 {
1641 expect_htlc_handling_failed_destinations!(events, expected_failures)
1646 /// Clears (and ignores) a PendingHTLCsForwardable event
1648 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1650 macro_rules! expect_pending_htlcs_forwardable_ignore {
1652 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1657 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1659 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1660 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1661 ($node: expr, $expected_failures: expr) => {
1662 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1667 /// Handles a PendingHTLCsForwardable event
1668 macro_rules! expect_pending_htlcs_forwardable {
1670 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1671 $node.node.process_pending_htlc_forwards();
1673 // Ensure process_pending_htlc_forwards is idempotent.
1674 $node.node.process_pending_htlc_forwards();
1679 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1680 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1681 ($node: expr, $expected_failures: expr) => {{
1682 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1683 $node.node.process_pending_htlc_forwards();
1685 // Ensure process_pending_htlc_forwards is idempotent.
1686 $node.node.process_pending_htlc_forwards();
1691 macro_rules! expect_pending_htlcs_forwardable_from_events {
1692 ($node: expr, $events: expr, $ignore: expr) => {{
1693 assert_eq!($events.len(), 1);
1695 Event::PendingHTLCsForwardable { .. } => { },
1696 _ => panic!("Unexpected event"),
1699 $node.node.process_pending_htlc_forwards();
1701 // Ensure process_pending_htlc_forwards is idempotent.
1702 $node.node.process_pending_htlc_forwards();
1708 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1709 /// commitment update.
1710 macro_rules! commitment_signed_dance {
1711 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1712 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1714 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1715 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1717 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1719 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1720 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1721 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1722 check_added_monitors(&$node_a, 1);
1723 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1724 assert!(extra_msg_option.is_none());
1728 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1729 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1731 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1732 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1736 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1737 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1738 /// `revoke_and_ack` response to it.
1740 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1741 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1742 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1743 /// the commitment we're exchanging. `includes_claim` provides that information.
1745 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1746 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1747 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1748 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1749 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1753 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1754 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1755 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1757 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1758 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1759 check_added_monitors!(node_b, 0);
1760 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1761 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1762 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1763 check_added_monitors!(node_b, 1);
1764 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1765 let (bs_revoke_and_ack, extra_msg_option) = {
1766 let mut events = node_b.node.get_and_clear_pending_msg_events();
1767 assert!(events.len() <= 2);
1768 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1769 (match node_a_event {
1770 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1771 assert_eq!(*node_id, node_a.node.get_our_node_id());
1774 _ => panic!("Unexpected event"),
1775 }, events.get(0).map(|e| e.clone()))
1777 check_added_monitors!(node_b, 1);
1779 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1780 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1782 (extra_msg_option, bs_revoke_and_ack)
1785 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1786 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1788 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1789 /// on failure or that no new messages are left over on success.
1790 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1791 check_added_monitors!(node_a, 0);
1792 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1793 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1794 check_added_monitors!(node_a, 1);
1796 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1797 let got_claim = node_a.node.pending_events.lock().unwrap().iter().any(|(ev, action)| {
1798 let matching_action = if let Some(channelmanager::EventCompletionAction::ReleaseRAAChannelMonitorUpdate
1799 { channel_funding_outpoint, counterparty_node_id }) = action
1801 if channel_funding_outpoint.to_channel_id() == commitment_signed.channel_id {
1802 assert_eq!(*counterparty_node_id, node_b.node.get_our_node_id());
1806 if matching_action {
1807 if let Event::PaymentSent { .. } = ev {} else { panic!(); }
1811 if fail_backwards { assert!(!got_claim); }
1812 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1814 if skip_last_step { return; }
1817 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1818 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1819 check_added_monitors!(node_a, 1);
1821 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1822 let mut number_of_msg_events = 0;
1823 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1824 let peer_state = peer_state_mutex.lock().unwrap();
1825 let cp_pending_msg_events = &peer_state.pending_msg_events;
1826 number_of_msg_events += cp_pending_msg_events.len();
1827 if cp_pending_msg_events.len() == 1 {
1828 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1829 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1830 } else { panic!("Unexpected event"); }
1833 // Expecting the failure backwards event to the previous hop (not `node_b`)
1834 assert_eq!(number_of_msg_events, 1);
1836 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1840 /// Get a payment preimage and hash.
1841 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1842 let mut payment_count = recipient.network_payment_count.borrow_mut();
1843 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1844 *payment_count += 1;
1845 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1846 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1847 (payment_preimage, payment_hash, payment_secret)
1850 /// Get a payment preimage and hash.
1852 /// Don't use this, use the identically-named function instead.
1854 macro_rules! get_payment_preimage_hash {
1855 ($dest_node: expr) => {
1856 get_payment_preimage_hash!($dest_node, None)
1858 ($dest_node: expr, $min_value_msat: expr) => {
1859 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1861 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1862 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1866 /// Gets a route from the given sender to the node described in `payment_params`.
1867 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1868 let scorer = TestScorer::new();
1869 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1870 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1872 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1873 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1874 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1878 /// Gets a route from the given sender to the node described in `payment_params`.
1880 /// Don't use this, use the identically-named function instead.
1882 macro_rules! get_route {
1883 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1884 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1890 macro_rules! get_route_and_payment_hash {
1891 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1892 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1893 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1894 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1896 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1897 let (payment_preimage, payment_hash, payment_secret) =
1898 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1899 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1900 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1904 pub fn check_payment_claimable(
1905 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1906 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1907 expected_receiver_node_id: PublicKey,
1910 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1911 assert_eq!(expected_payment_hash, *payment_hash);
1912 assert_eq!(expected_recv_value, *amount_msat);
1913 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1915 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1916 assert_eq!(&expected_payment_preimage, payment_preimage);
1917 assert_eq!(expected_payment_secret, *payment_secret);
1922 _ => panic!("Unexpected event"),
1927 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1928 macro_rules! expect_payment_claimable {
1929 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1930 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1932 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1933 let events = $node.node.get_and_clear_pending_events();
1934 assert_eq!(events.len(), 1);
1935 $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)
1940 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1941 macro_rules! expect_payment_claimed {
1942 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1943 let events = $node.node.get_and_clear_pending_events();
1944 assert_eq!(events.len(), 1);
1946 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1947 assert_eq!($expected_payment_hash, *payment_hash);
1948 assert_eq!($expected_recv_value, amount_msat);
1950 _ => panic!("Unexpected event"),
1955 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1956 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1957 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
1959 let events = node.node().get_and_clear_pending_events();
1960 let expected_payment_hash = PaymentHash(
1961 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1962 if expect_per_path_claims {
1963 assert!(events.len() > 1);
1965 assert_eq!(events.len(), 1);
1967 if expect_post_ev_mon_update {
1968 check_added_monitors(node, 1);
1970 let expected_payment_id = match events[0] {
1971 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1972 assert_eq!(expected_payment_preimage, *payment_preimage);
1973 assert_eq!(expected_payment_hash, *payment_hash);
1974 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1975 assert_eq!(*fee_paid_msat, expected_fee_msat);
1977 assert!(fee_paid_msat.is_some());
1981 _ => panic!("Unexpected event"),
1983 if expect_per_path_claims {
1984 for i in 1..events.len() {
1986 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1987 assert_eq!(payment_id, expected_payment_id);
1988 assert_eq!(payment_hash, Some(expected_payment_hash));
1990 _ => panic!("Unexpected event"),
1997 macro_rules! expect_payment_sent {
1998 ($node: expr, $expected_payment_preimage: expr) => {
1999 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2001 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2002 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2004 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2005 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2006 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2012 macro_rules! expect_payment_path_successful {
2014 let events = $node.node.get_and_clear_pending_events();
2015 assert_eq!(events.len(), 1);
2017 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2018 _ => panic!("Unexpected event"),
2023 macro_rules! expect_payment_forwarded {
2024 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2025 let events = $node.node.get_and_clear_pending_events();
2026 assert_eq!(events.len(), 1);
2028 Event::PaymentForwarded {
2029 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2030 outbound_amount_forwarded_msat: _
2032 assert_eq!(fee_earned_msat, $expected_fee);
2033 if fee_earned_msat.is_some() {
2034 // Is the event prev_channel_id in one of the channels between the two nodes?
2035 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()));
2037 // We check for force closures since a force closed channel is removed from the
2038 // node's channel list
2039 if !$downstream_force_closed {
2040 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()));
2042 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
2044 _ => panic!("Unexpected event"),
2051 macro_rules! expect_channel_shutdown_state {
2052 ($node: expr, $chan_id: expr, $state: path) => {
2053 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2054 assert_eq!(chan_details.len(), 1);
2055 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2059 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2060 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2061 let events = node.node.get_and_clear_pending_events();
2062 assert_eq!(events.len(), 1);
2064 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2065 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2067 _ => panic!("Unexpected event"),
2071 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2072 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2073 let events = node.node.get_and_clear_pending_events();
2074 assert_eq!(events.len(), 1);
2076 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2077 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2079 _ => panic!("Unexpected event"),
2083 pub struct PaymentFailedConditions<'a> {
2084 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2085 pub(crate) expected_blamed_scid: Option<u64>,
2086 pub(crate) expected_blamed_chan_closed: Option<bool>,
2087 pub(crate) expected_mpp_parts_remain: bool,
2090 impl<'a> PaymentFailedConditions<'a> {
2091 pub fn new() -> Self {
2093 expected_htlc_error_data: None,
2094 expected_blamed_scid: None,
2095 expected_blamed_chan_closed: None,
2096 expected_mpp_parts_remain: false,
2099 pub fn mpp_parts_remain(mut self) -> Self {
2100 self.expected_mpp_parts_remain = true;
2103 pub fn blamed_scid(mut self, scid: u64) -> Self {
2104 self.expected_blamed_scid = Some(scid);
2107 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2108 self.expected_blamed_chan_closed = Some(closed);
2111 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2112 self.expected_htlc_error_data = Some((code, data));
2118 macro_rules! expect_payment_failed_with_update {
2119 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2120 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2121 &$node, $expected_payment_hash, $payment_failed_permanently,
2122 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2123 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2128 macro_rules! expect_payment_failed {
2129 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2130 #[allow(unused_mut)]
2131 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2133 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2135 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2139 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2140 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2141 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2143 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2144 let expected_payment_id = match &payment_failed_events[0] {
2145 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2149 error_data, .. } => {
2150 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2151 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2154 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2155 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2156 if let Some((code, data)) = conditions.expected_htlc_error_data {
2157 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2158 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2162 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2163 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2165 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2166 if let Some(scid) = conditions.expected_blamed_scid {
2167 assert_eq!(msg.contents.short_channel_id, scid);
2169 const CHAN_DISABLED_FLAG: u8 = 2;
2170 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2172 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2173 if let Some(scid) = conditions.expected_blamed_scid {
2174 assert_eq!(*short_channel_id, scid);
2176 assert!(is_permanent);
2178 _ => panic!("Unexpected update type"),
2180 } else { panic!("Expected network update"); }
2185 _ => panic!("Unexpected event"),
2187 if !conditions.expected_mpp_parts_remain {
2188 match &payment_failed_events[1] {
2189 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2190 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2191 assert_eq!(*payment_id, expected_payment_id);
2192 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2193 PaymentFailureReason::RecipientRejected
2195 PaymentFailureReason::RetriesExhausted
2198 _ => panic!("Unexpected second event"),
2203 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2204 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2205 conditions: PaymentFailedConditions<'e>
2207 let events = node.node.get_and_clear_pending_events();
2208 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2211 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 {
2212 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2213 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2214 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2215 check_added_monitors!(origin_node, expected_paths.len());
2216 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2220 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> {
2221 let mut payment_event = SendEvent::from_event(ev);
2222 let mut prev_node = origin_node;
2223 let mut event = None;
2225 for (idx, &node) in expected_path.iter().enumerate() {
2226 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2228 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2229 check_added_monitors!(node, 0);
2230 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2232 expect_pending_htlcs_forwardable!(node);
2234 if idx == expected_path.len() - 1 && clear_recipient_events {
2235 let events_2 = node.node.get_and_clear_pending_events();
2236 if payment_claimable_expected {
2237 assert_eq!(events_2.len(), 1);
2238 match &events_2[0] {
2239 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2240 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2241 claim_deadline, onion_fields, ..
2243 assert_eq!(our_payment_hash, *payment_hash);
2244 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2245 assert!(onion_fields.is_some());
2247 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2248 assert_eq!(expected_preimage, *payment_preimage);
2249 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2250 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2252 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2253 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2254 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2257 assert_eq!(*amount_msat, recv_value);
2258 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2259 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2260 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2262 _ => panic!("Unexpected event"),
2264 event = Some(events_2[0].clone());
2266 assert!(events_2.is_empty());
2268 } else if idx != expected_path.len() - 1 {
2269 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2270 assert_eq!(events_2.len(), 1);
2271 check_added_monitors!(node, 1);
2272 payment_event = SendEvent::from_event(events_2.remove(0));
2273 assert_eq!(payment_event.msgs.len(), 1);
2281 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> {
2282 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2285 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) {
2286 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2287 assert_eq!(events.len(), expected_route.len());
2288 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2289 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2290 // Once we've gotten through all the HTLCs, the last one should result in a
2291 // PaymentClaimable (but each previous one should not!), .
2292 let expect_payment = path_idx == expected_route.len() - 1;
2293 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2297 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) {
2298 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2299 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2300 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2303 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2304 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2305 our_payment_preimage: PaymentPreimage
2307 let extra_fees = vec![0; expected_paths.len()];
2308 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2309 &extra_fees[..], skip_last, our_payment_preimage)
2312 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2313 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2314 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2316 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2317 for path in expected_paths.iter() {
2318 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2320 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2321 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2324 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 {
2325 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2326 assert_eq!(claim_event.len(), 1);
2327 match claim_event[0] {
2328 Event::PaymentClaimed {
2329 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2333 | Event::PaymentClaimed {
2334 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2339 assert_eq!(preimage, our_payment_preimage);
2340 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2341 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2342 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2344 Event::PaymentClaimed {
2345 purpose: PaymentPurpose::InvoicePayment { .. },
2351 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2352 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2353 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2354 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2359 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2361 let mut expected_total_fee_msat = 0;
2363 macro_rules! msgs_from_ev {
2366 &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 } } => {
2367 assert!(update_add_htlcs.is_empty());
2368 assert_eq!(update_fulfill_htlcs.len(), 1);
2369 assert!(update_fail_htlcs.is_empty());
2370 assert!(update_fail_malformed_htlcs.is_empty());
2371 assert!(update_fee.is_none());
2372 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2374 _ => panic!("Unexpected event"),
2378 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2379 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2380 assert_eq!(events.len(), expected_paths.len());
2382 if events.len() == 1 {
2383 per_path_msgs.push(msgs_from_ev!(&events[0]));
2385 for expected_path in expected_paths.iter() {
2386 // For MPP payments, we always want the message to the first node in the path.
2387 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2388 per_path_msgs.push(msgs_from_ev!(&ev));
2392 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2393 let mut next_msgs = Some(path_msgs);
2394 let mut expected_next_node = next_hop;
2396 macro_rules! last_update_fulfill_dance {
2397 ($node: expr, $prev_node: expr) => {
2399 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2400 check_added_monitors!($node, 0);
2401 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2402 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2406 macro_rules! mid_update_fulfill_dance {
2407 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2409 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2411 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2412 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2413 .unwrap().lock().unwrap();
2414 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2415 if let Some(prev_config) = channel.context.prev_config() {
2416 prev_config.forwarding_fee_base_msat
2418 channel.context.config().forwarding_fee_base_msat
2421 if $idx == 1 { fee += expected_extra_fees[i]; }
2422 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2423 expected_total_fee_msat += fee as u64;
2424 check_added_monitors!($node, 1);
2425 let new_next_msgs = if $new_msgs {
2426 let events = $node.node.get_and_clear_pending_msg_events();
2427 assert_eq!(events.len(), 1);
2428 let (res, nexthop) = msgs_from_ev!(&events[0]);
2429 expected_next_node = nexthop;
2432 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2435 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2436 next_msgs = new_next_msgs;
2441 let mut prev_node = expected_route.last().unwrap();
2442 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2443 assert_eq!(expected_next_node, node.node.get_our_node_id());
2444 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2445 if next_msgs.is_some() {
2446 // Since we are traversing in reverse, next_node is actually the previous node
2447 let next_node: &Node;
2448 if idx == expected_route.len() - 1 {
2449 next_node = origin_node;
2451 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2453 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2455 assert!(!update_next_msgs);
2456 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2458 if !skip_last && idx == expected_route.len() - 1 {
2459 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2466 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2470 // Ensure that claim_funds is idempotent.
2471 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2472 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2473 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2475 expected_total_fee_msat
2477 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) {
2478 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2480 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2484 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2485 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2488 pub const TEST_FINAL_CLTV: u32 = 70;
2490 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) {
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 = get_route(origin_node, &payment_params, recv_value).unwrap();
2494 assert_eq!(route.paths.len(), 1);
2495 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2496 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2497 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2500 let res = send_along_route(origin_node, route, expected_route, recv_value);
2501 (res.0, res.1, res.2)
2504 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2505 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2506 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2507 let network_graph = origin_node.network_graph.read_only();
2508 let scorer = test_utils::TestScorer::new();
2509 let seed = [0u8; 32];
2510 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2511 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2512 let route = router::get_route(
2513 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2514 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2515 assert_eq!(route.paths.len(), 1);
2516 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2517 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2518 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2521 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2522 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2523 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2524 true, APIError::ChannelUnavailable { ref err },
2525 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2528 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2529 let res = route_payment(&origin, expected_route, recv_value);
2530 claim_payment(&origin, expected_route, res.0);
2534 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) {
2535 for path in expected_paths.iter() {
2536 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2538 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2539 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2540 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2542 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2545 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) {
2546 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2547 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2549 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2550 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2551 assert_eq!(events.len(), expected_paths.len());
2552 for ev in events.iter() {
2553 let (update_fail, commitment_signed, node_id) = match ev {
2554 &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 } } => {
2555 assert!(update_add_htlcs.is_empty());
2556 assert!(update_fulfill_htlcs.is_empty());
2557 assert_eq!(update_fail_htlcs.len(), 1);
2558 assert!(update_fail_malformed_htlcs.is_empty());
2559 assert!(update_fee.is_none());
2560 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2562 _ => panic!("Unexpected event"),
2564 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2566 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2567 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()));
2569 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2570 let mut next_msgs = Some(path_msgs);
2571 let mut expected_next_node = next_hop;
2572 let mut prev_node = expected_route.last().unwrap();
2574 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2575 assert_eq!(expected_next_node, node.node.get_our_node_id());
2576 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2577 if next_msgs.is_some() {
2578 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2579 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2580 if !update_next_node {
2581 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 }]);
2584 let events = node.node.get_and_clear_pending_msg_events();
2585 if update_next_node {
2586 assert_eq!(events.len(), 1);
2588 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 } } => {
2589 assert!(update_add_htlcs.is_empty());
2590 assert!(update_fulfill_htlcs.is_empty());
2591 assert_eq!(update_fail_htlcs.len(), 1);
2592 assert!(update_fail_malformed_htlcs.is_empty());
2593 assert!(update_fee.is_none());
2594 expected_next_node = node_id.clone();
2595 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2597 _ => panic!("Unexpected event"),
2600 assert!(events.is_empty());
2602 if !skip_last && idx == expected_route.len() - 1 {
2603 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2610 let prev_node = expected_route.first().unwrap();
2611 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2612 check_added_monitors!(origin_node, 0);
2613 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2614 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2615 let events = origin_node.node.get_and_clear_pending_events();
2616 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2618 let expected_payment_id = match events[0] {
2619 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2620 assert_eq!(payment_hash, our_payment_hash);
2621 assert!(payment_failed_permanently);
2622 for (idx, hop) in expected_route.iter().enumerate() {
2623 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2627 _ => panic!("Unexpected event"),
2629 if i == expected_paths.len() - 1 {
2631 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2632 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2633 assert_eq!(*payment_id, expected_payment_id);
2634 assert_eq!(reason.unwrap(), expected_fail_reason);
2636 _ => panic!("Unexpected second event"),
2642 // Ensure that fail_htlc_backwards is idempotent.
2643 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2644 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2645 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2646 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2649 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2650 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2653 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2654 let mut chan_mon_cfgs = Vec::new();
2655 for i in 0..node_count {
2656 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2657 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2658 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2659 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2660 let persister = test_utils::TestPersister::new();
2661 let seed = [i as u8; 32];
2662 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2663 let scorer = RwLock::new(test_utils::TestScorer::new());
2665 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2671 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2672 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2675 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>> {
2676 let mut nodes = Vec::new();
2678 for i in 0..node_count {
2679 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);
2680 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2681 let seed = [i as u8; 32];
2682 nodes.push(NodeCfg {
2683 chain_source: &chanmon_cfgs[i].chain_source,
2684 logger: &chanmon_cfgs[i].logger,
2685 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2686 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2687 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2689 keys_manager: &chanmon_cfgs[i].keys_manager,
2692 override_init_features: Rc::new(RefCell::new(None)),
2699 pub fn test_default_channel_config() -> UserConfig {
2700 let mut default_config = UserConfig::default();
2701 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2702 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2703 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2704 default_config.channel_handshake_config.announced_channel = true;
2705 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2706 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2707 // It now defaults to 1, so we simply set it to the expected value here.
2708 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2709 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2710 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2712 default_config.channel_config.max_dust_htlc_exposure =
2713 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2717 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>> {
2718 let mut chanmgrs = Vec::new();
2719 for i in 0..node_count {
2720 let network = Network::Testnet;
2721 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2722 let params = ChainParameters {
2724 best_block: BestBlock::from_network(network),
2726 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,
2727 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);
2728 chanmgrs.push(node);
2734 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>> {
2735 let mut nodes = Vec::new();
2736 let chan_count = Rc::new(RefCell::new(0));
2737 let payment_count = Rc::new(RefCell::new(0));
2738 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2740 for i in 0..node_count {
2741 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2742 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2744 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2745 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2746 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2747 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2748 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2749 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2750 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2751 connect_style: Rc::clone(&connect_style),
2752 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2753 wallet_source: Arc::clone(&wallet_source),
2754 bump_tx_handler: BumpTransactionEventHandler::new(
2755 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2756 &cfgs[i].keys_manager, cfgs[i].logger,
2761 for i in 0..node_count {
2762 for j in (i+1)..node_count {
2763 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2764 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2766 remote_network_address: None,
2768 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2769 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2771 remote_network_address: None,
2779 // Note that the following only works for CLTV values up to 128
2780 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2782 #[derive(PartialEq)]
2783 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2784 /// Tests that the given node has broadcast transactions for the given Channel
2786 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2787 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2788 /// broadcast and the revoked outputs were claimed.
2790 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2791 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2793 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2795 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> {
2796 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2797 let mut txn_seen = HashSet::new();
2798 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2799 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2801 let mut res = Vec::with_capacity(2);
2802 node_txn.retain(|tx| {
2803 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2804 check_spends!(tx, chan.3);
2805 if commitment_tx.is_none() {
2806 res.push(tx.clone());
2811 if let Some(explicit_tx) = commitment_tx {
2812 res.push(explicit_tx.clone());
2815 assert_eq!(res.len(), 1);
2817 if has_htlc_tx != HTLCType::NONE {
2818 node_txn.retain(|tx| {
2819 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2820 check_spends!(tx, res[0]);
2821 if has_htlc_tx == HTLCType::TIMEOUT {
2822 assert!(tx.lock_time.0 != 0);
2824 assert!(tx.lock_time.0 == 0);
2826 res.push(tx.clone());
2830 assert!(res.len() == 2 || res.len() == 3);
2832 assert_eq!(res[1], res[2]);
2836 assert!(node_txn.is_empty());
2840 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2841 /// HTLC transaction.
2842 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2843 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2844 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2845 // for revoked htlc outputs
2846 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2847 node_txn.retain(|tx| {
2848 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2849 check_spends!(tx, revoked_tx);
2853 node_txn.retain(|tx| {
2854 check_spends!(tx, commitment_revoked_tx);
2857 assert!(node_txn.is_empty());
2860 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2861 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2862 let mut txn_seen = HashSet::new();
2863 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2865 let mut found_prev = false;
2866 for prev_tx in prev_txn {
2867 for tx in &*node_txn {
2868 if tx.input[0].previous_output.txid == prev_tx.txid() {
2869 check_spends!(tx, prev_tx);
2870 let mut iter = tx.input[0].witness.iter();
2871 iter.next().expect("expected 3 witness items");
2872 iter.next().expect("expected 3 witness items");
2873 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2874 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2881 assert!(found_prev);
2883 let mut res = Vec::new();
2884 mem::swap(&mut *node_txn, &mut res);
2888 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) {
2889 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2890 assert_eq!(events_1.len(), 2);
2891 let as_update = match events_1[0] {
2892 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2895 _ => panic!("Unexpected event"),
2898 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2899 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2900 assert_eq!(msg.data, expected_error);
2901 if needs_err_handle {
2902 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2905 _ => panic!("Unexpected event"),
2908 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2909 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2910 let bs_update = match events_2[0] {
2911 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2914 _ => panic!("Unexpected event"),
2916 if !needs_err_handle {
2918 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2919 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2920 assert_eq!(msg.data, expected_error);
2922 _ => panic!("Unexpected event"),
2927 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2928 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2932 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2933 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2937 macro_rules! get_channel_value_stat {
2938 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2939 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2940 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2941 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2942 chan.get_value_stat()
2946 macro_rules! get_chan_reestablish_msgs {
2947 ($src_node: expr, $dst_node: expr) => {
2949 let mut announcements = $crate::prelude::HashSet::new();
2950 let mut res = Vec::with_capacity(1);
2951 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2952 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2953 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2954 res.push(msg.clone());
2955 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2956 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2957 announcements.insert(msg.contents.short_channel_id);
2959 panic!("Unexpected event")
2962 assert!(announcements.is_empty());
2968 macro_rules! handle_chan_reestablish_msgs {
2969 ($src_node: expr, $dst_node: expr) => {
2971 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2973 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2975 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2981 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2983 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2986 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2987 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2988 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2990 had_channel_update = true;
2993 let mut revoke_and_ack = None;
2994 let mut commitment_update = None;
2995 let order = if let Some(ev) = msg_events.get(idx) {
2997 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2998 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2999 revoke_and_ack = Some(msg.clone());
3001 RAACommitmentOrder::RevokeAndACKFirst
3003 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3004 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3005 commitment_update = Some(updates.clone());
3007 RAACommitmentOrder::CommitmentFirst
3009 _ => RAACommitmentOrder::CommitmentFirst,
3012 RAACommitmentOrder::CommitmentFirst
3015 if let Some(ev) = msg_events.get(idx) {
3017 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3018 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3019 assert!(revoke_and_ack.is_none());
3020 revoke_and_ack = Some(msg.clone());
3023 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3024 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3025 assert!(commitment_update.is_none());
3026 commitment_update = Some(updates.clone());
3033 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3034 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3036 assert!(!had_channel_update);
3039 assert_eq!(msg_events.len(), idx);
3041 (channel_ready, revoke_and_ack, commitment_update, order)
3046 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3047 pub node_a: &'a Node<'b, 'c, 'd>,
3048 pub node_b: &'a Node<'b, 'c, 'd>,
3049 pub send_channel_ready: (bool, bool),
3050 pub pending_htlc_adds: (i64, i64),
3051 pub pending_htlc_claims: (usize, usize),
3052 pub pending_htlc_fails: (usize, usize),
3053 pub pending_cell_htlc_claims: (usize, usize),
3054 pub pending_cell_htlc_fails: (usize, usize),
3055 pub pending_raa: (bool, bool),
3058 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3059 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3063 send_channel_ready: (false, false),
3064 pending_htlc_adds: (0, 0),
3065 pending_htlc_claims: (0, 0),
3066 pending_htlc_fails: (0, 0),
3067 pending_cell_htlc_claims: (0, 0),
3068 pending_cell_htlc_fails: (0, 0),
3069 pending_raa: (false, false),
3074 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3075 /// for claims/fails they are separated out.
3076 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3078 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3079 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa
3081 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3082 features: node_b.node.init_features(), networks: None, remote_network_address: None
3084 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3085 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3086 features: node_a.node.init_features(), networks: None, remote_network_address: None
3088 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3090 if send_channel_ready.0 {
3091 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3093 for reestablish in reestablish_1.iter() {
3094 assert_eq!(reestablish.next_remote_commitment_number, 0);
3097 if send_channel_ready.1 {
3098 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3100 for reestablish in reestablish_2.iter() {
3101 assert_eq!(reestablish.next_remote_commitment_number, 0);
3104 if send_channel_ready.0 || send_channel_ready.1 {
3105 // If we expect any channel_ready's, both sides better have set
3106 // next_holder_commitment_number to 1
3107 for reestablish in reestablish_1.iter() {
3108 assert_eq!(reestablish.next_local_commitment_number, 1);
3110 for reestablish in reestablish_2.iter() {
3111 assert_eq!(reestablish.next_local_commitment_number, 1);
3115 let mut resp_1 = Vec::new();
3116 for msg in reestablish_1 {
3117 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3118 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3120 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3121 check_added_monitors!(node_b, 1);
3123 check_added_monitors!(node_b, 0);
3126 let mut resp_2 = Vec::new();
3127 for msg in reestablish_2 {
3128 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3129 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3131 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3132 check_added_monitors!(node_a, 1);
3134 check_added_monitors!(node_a, 0);
3137 // We don't yet support both needing updates, as that would require a different commitment dance:
3138 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3139 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3140 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3141 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3143 for chan_msgs in resp_1.drain(..) {
3144 if send_channel_ready.0 {
3145 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3146 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3147 if !announcement_event.is_empty() {
3148 assert_eq!(announcement_event.len(), 1);
3149 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3150 //TODO: Test announcement_sigs re-sending
3151 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3154 assert!(chan_msgs.0.is_none());
3157 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3158 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3159 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3160 check_added_monitors!(node_a, 1);
3162 assert!(chan_msgs.1.is_none());
3164 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3165 let commitment_update = chan_msgs.2.unwrap();
3166 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3167 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3169 assert!(commitment_update.update_add_htlcs.is_empty());
3171 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3172 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3173 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3174 for update_add in commitment_update.update_add_htlcs {
3175 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3177 for update_fulfill in commitment_update.update_fulfill_htlcs {
3178 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3180 for update_fail in commitment_update.update_fail_htlcs {
3181 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3184 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3185 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3187 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3188 check_added_monitors!(node_a, 1);
3189 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3190 // No commitment_signed so get_event_msg's assert(len == 1) passes
3191 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3192 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3193 check_added_monitors!(node_b, 1);
3196 assert!(chan_msgs.2.is_none());
3200 for chan_msgs in resp_2.drain(..) {
3201 if send_channel_ready.1 {
3202 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3203 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3204 if !announcement_event.is_empty() {
3205 assert_eq!(announcement_event.len(), 1);
3206 match announcement_event[0] {
3207 MessageSendEvent::SendChannelUpdate { .. } => {},
3208 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3209 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3213 assert!(chan_msgs.0.is_none());
3216 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3217 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3218 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3219 check_added_monitors!(node_b, 1);
3221 assert!(chan_msgs.1.is_none());
3223 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3224 let commitment_update = chan_msgs.2.unwrap();
3225 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3226 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3228 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3229 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3230 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3231 for update_add in commitment_update.update_add_htlcs {
3232 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3234 for update_fulfill in commitment_update.update_fulfill_htlcs {
3235 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3237 for update_fail in commitment_update.update_fail_htlcs {
3238 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3241 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3242 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3244 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3245 check_added_monitors!(node_b, 1);
3246 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3247 // No commitment_signed so get_event_msg's assert(len == 1) passes
3248 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3249 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3250 check_added_monitors!(node_a, 1);
3253 assert!(chan_msgs.2.is_none());