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, RouteParameters};
23 use crate::ln::features::InitFeatures;
25 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
26 use crate::util::test_channel_signer::TestChannelSigner;
27 use crate::util::scid_utils;
28 use crate::util::test_utils;
29 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
30 use crate::util::errors::APIError;
31 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
32 use crate::util::ser::{ReadableArgs, Writeable};
34 use bitcoin::blockdata::block::{Block, BlockHeader};
35 use bitcoin::blockdata::transaction::{Transaction, TxOut};
36 use bitcoin::hash_types::BlockHash;
37 use bitcoin::hashes::sha256::Hash as Sha256;
38 use bitcoin::hashes::Hash as _;
39 use bitcoin::network::constants::Network;
40 use bitcoin::secp256k1::{PublicKey, SecretKey};
43 use crate::prelude::*;
44 use core::cell::RefCell;
46 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
48 use core::iter::repeat;
49 use bitcoin::{PackedLockTime, TxIn, TxMerkleNode};
51 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
53 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
54 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
56 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
57 /// output is the 1st output in the transaction.
58 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
59 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
60 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
63 /// Mine a single block containing the given transaction
65 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
66 /// output is the 1st output in the transaction.
67 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
68 let height = node.best_block_info().1 + 1;
69 confirm_transaction_at(node, tx, height)
71 /// Mine a single block containing the given transactions
72 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
73 let height = node.best_block_info().1 + 1;
74 confirm_transactions_at(node, txn, height);
76 /// Mine 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_feerate {
816 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
818 let mut per_peer_state_lock;
819 let mut peer_state_lock;
820 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
821 phase.context().get_feerate_sat_per_1000_weight()
827 macro_rules! get_channel_type_features {
828 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
830 let mut per_peer_state_lock;
831 let mut peer_state_lock;
832 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
833 chan.context().get_channel_type().clone()
838 /// Returns a channel monitor given a channel id, making some naive assumptions
840 macro_rules! get_monitor {
841 ($node: expr, $channel_id: expr) => {
843 use bitcoin::hashes::Hash;
844 let mut monitor = None;
845 // Assume funding vout is either 0 or 1 blindly
847 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
848 $crate::chain::transaction::OutPoint {
849 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
861 /// Returns any local commitment transactions for the channel.
863 macro_rules! get_local_commitment_txn {
864 ($node: expr, $channel_id: expr) => {
866 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
871 /// Check the error from attempting a payment.
873 macro_rules! unwrap_send_err {
874 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
876 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
877 assert_eq!(fails.len(), 1);
883 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
884 assert_eq!(results.len(), 1);
886 Err($type) => { $check },
895 /// Check whether N channel monitor(s) have been added.
896 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
897 if let Some(chain_monitor) = node.chain_monitor() {
898 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
899 assert_eq!(added_monitors.len(), count);
900 added_monitors.clear();
904 /// Check whether N channel monitor(s) have been added.
906 /// Don't use this, use the identically-named function instead.
908 macro_rules! check_added_monitors {
909 ($node: expr, $count: expr) => {
910 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
914 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
916 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
917 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
918 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
919 let mut nodes = path.iter().rev();
920 let dest = nodes.next().expect("path should have a destination").node;
921 let prev = nodes.next().unwrap_or(&origin_node).node;
922 let dest_channels = dest.list_channels();
923 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
924 .expect("HTLC's channel should be one of destination node's channels");
925 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
926 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
929 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> {
930 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
931 for encoded in monitors_encoded {
932 let mut monitor_read = &encoded[..];
933 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
934 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
935 assert!(monitor_read.is_empty());
936 monitors_read.push(monitor);
939 let mut node_read = &chanman_encoded[..];
940 let (_, node_deserialized) = {
941 let mut channel_monitors = HashMap::new();
942 for monitor in monitors_read.iter_mut() {
943 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
945 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
947 entropy_source: node.keys_manager,
948 node_signer: node.keys_manager,
949 signer_provider: node.keys_manager,
950 fee_estimator: node.fee_estimator,
952 chain_monitor: node.chain_monitor,
953 tx_broadcaster: node.tx_broadcaster,
958 assert!(node_read.is_empty());
960 for monitor in monitors_read.drain(..) {
961 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
962 ChannelMonitorUpdateStatus::Completed);
963 check_added_monitors!(node, 1);
970 macro_rules! reload_node {
971 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
972 let chanman_encoded = $chanman_encoded;
974 $persister = test_utils::TestPersister::new();
975 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
976 $node.chain_monitor = &$new_chain_monitor;
978 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
979 $node.node = &$new_channelmanager;
981 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
982 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
986 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
987 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
988 -> (ChannelId, Transaction, OutPoint)
990 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
993 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
994 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
995 -> (ChannelId, Transaction, OutPoint)
997 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1000 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1001 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1002 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1003 let chan_id = *node.network_chan_count.borrow();
1005 let events = node.node.get_and_clear_pending_events();
1006 assert_eq!(events.len(), 1);
1008 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1009 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1010 assert_eq!(*channel_value_satoshis, expected_chan_value);
1011 assert_eq!(user_channel_id, expected_user_chan_id);
1013 let input = if coinbase {
1015 previous_output: bitcoin::OutPoint::null(),
1016 ..Default::default()
1022 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1023 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1025 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1026 (*temporary_channel_id, tx, funding_outpoint)
1028 _ => panic!("Unexpected event"),
1032 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 {
1033 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1034 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1036 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1037 check_added_monitors!(node_a, 0);
1039 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1040 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1041 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1043 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1044 assert_eq!(added_monitors.len(), 1);
1045 assert_eq!(added_monitors[0].0, funding_output);
1046 added_monitors.clear();
1048 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1050 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()));
1052 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1053 assert_eq!(added_monitors.len(), 1);
1054 assert_eq!(added_monitors[0].0, funding_output);
1055 added_monitors.clear();
1057 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1059 let events_4 = node_a.node.get_and_clear_pending_events();
1060 assert_eq!(events_4.len(), 0);
1062 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1063 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1064 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1066 // Ensure that funding_transaction_generated is idempotent.
1067 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1068 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1069 check_added_monitors!(node_a, 0);
1074 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1075 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) {
1076 let initiator_channels = initiator.node.list_usable_channels().len();
1077 let receiver_channels = receiver.node.list_usable_channels().len();
1079 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1080 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1082 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1083 let events = receiver.node.get_and_clear_pending_events();
1084 assert_eq!(events.len(), 1);
1086 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1087 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1089 _ => panic!("Unexpected event"),
1092 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1093 assert_eq!(accept_channel.minimum_depth, 0);
1094 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1096 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1097 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1098 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1100 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1101 check_added_monitors!(receiver, 1);
1102 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1103 assert_eq!(bs_signed_locked.len(), 2);
1104 let as_channel_ready;
1105 match &bs_signed_locked[0] {
1106 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1107 assert_eq!(*node_id, initiator.node.get_our_node_id());
1108 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1109 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1110 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1111 check_added_monitors!(initiator, 1);
1113 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1114 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1116 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1118 _ => panic!("Unexpected event"),
1120 match &bs_signed_locked[1] {
1121 MessageSendEvent::SendChannelReady { node_id, msg } => {
1122 assert_eq!(*node_id, initiator.node.get_our_node_id());
1123 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1124 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1126 _ => panic!("Unexpected event"),
1129 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1130 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1132 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1133 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1135 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1136 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1138 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1139 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1141 (tx, as_channel_ready.channel_id)
1144 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 {
1145 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1146 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1147 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1148 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1149 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1150 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1151 let events = node_b.node.get_and_clear_pending_events();
1152 assert_eq!(events.len(), 1);
1154 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1155 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1156 _ => panic!("Unexpected event"),
1159 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1160 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1161 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1162 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1164 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1167 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) {
1168 confirm_transaction_at(node_conf, tx, conf_height);
1169 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1170 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()));
1173 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) {
1175 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1176 assert_eq!(events_6.len(), 3);
1177 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1178 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1180 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1181 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1183 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1184 ((match events_6[0] {
1185 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1186 channel_id = msg.channel_id.clone();
1187 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1190 _ => panic!("Unexpected event"),
1191 }, match events_6[announcement_sigs_idx] {
1192 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1193 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1196 _ => panic!("Unexpected event"),
1200 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) {
1201 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1202 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1203 confirm_transaction_at(node_a, tx, conf_height);
1204 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1205 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1206 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1209 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) {
1210 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1211 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1215 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) {
1216 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1217 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1218 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1220 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1221 assert_eq!(events_7.len(), 1);
1222 let (announcement, bs_update) = match events_7[0] {
1223 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1224 (msg, update_msg.clone().unwrap())
1226 _ => panic!("Unexpected event"),
1229 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1230 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1231 assert_eq!(events_8.len(), 1);
1232 let as_update = match events_8[0] {
1233 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1234 assert!(*announcement == *msg);
1235 let update_msg = update_msg.clone().unwrap();
1236 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1237 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1240 _ => panic!("Unexpected event"),
1243 *node_a.network_chan_count.borrow_mut() += 1;
1245 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1246 ((*announcement).clone(), as_update, bs_update)
1249 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) {
1250 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1253 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) {
1254 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1255 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1256 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1259 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) {
1260 let mut no_announce_cfg = test_default_channel_config();
1261 no_announce_cfg.channel_handshake_config.announced_channel = false;
1262 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1263 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1264 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1265 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1266 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1268 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1269 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1270 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()));
1271 check_added_monitors!(nodes[b], 1);
1273 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1274 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1276 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1277 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1278 check_added_monitors!(nodes[a], 1);
1280 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1281 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1282 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1284 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1285 confirm_transaction_at(&nodes[a], &tx, conf_height);
1286 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1287 confirm_transaction_at(&nodes[b], &tx, conf_height);
1288 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1289 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1290 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()));
1291 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1292 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1293 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1294 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1295 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1297 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1298 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1300 let mut found_a = false;
1301 for chan in nodes[a].node.list_usable_channels() {
1302 if chan.channel_id == as_channel_ready.channel_id {
1305 assert!(!chan.is_public);
1310 let mut found_b = false;
1311 for chan in nodes[b].node.list_usable_channels() {
1312 if chan.channel_id == as_channel_ready.channel_id {
1315 assert!(!chan.is_public);
1320 (as_channel_ready, tx)
1323 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) {
1325 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1326 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1327 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1329 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1330 // forwarding info for local channels even if its not accepted in the network graph.
1331 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1332 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1336 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1337 for outp in tx.output.iter() {
1338 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1340 let mut total_value_in = 0;
1341 for input in tx.input.iter() {
1342 total_value_in += get_output(&input.previous_output).unwrap().value;
1344 let mut total_value_out = 0;
1345 for output in tx.output.iter() {
1346 total_value_out += output.value;
1348 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1349 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1350 assert!(total_value_out + min_fee <= total_value_in);
1351 tx.verify(get_output).unwrap();
1355 macro_rules! check_spends {
1356 ($tx: expr, $($spends_txn: expr),*) => {
1359 for outp in $spends_txn.output.iter() {
1360 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1363 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1365 if out_point.txid == $spends_txn.txid() {
1366 return $spends_txn.output.get(out_point.vout as usize).cloned()
1371 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1376 macro_rules! get_closing_signed_broadcast {
1377 ($node: expr, $dest_pubkey: expr) => {
1379 let events = $node.get_and_clear_pending_msg_events();
1380 assert!(events.len() == 1 || events.len() == 2);
1381 (match events[events.len() - 1] {
1382 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1383 assert_eq!(msg.contents.flags & 2, 2);
1386 _ => panic!("Unexpected event"),
1387 }, if events.len() == 2 {
1389 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1390 assert_eq!(*node_id, $dest_pubkey);
1393 _ => panic!("Unexpected event"),
1401 macro_rules! check_warn_msg {
1402 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1403 let msg_events = $node.node.get_and_clear_pending_msg_events();
1404 assert_eq!(msg_events.len(), 1);
1405 match msg_events[0] {
1406 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1407 assert_eq!(node_id, $recipient_node_id);
1408 assert_eq!(msg.channel_id, $chan_id);
1411 _ => panic!("Unexpected event"),
1416 /// Check that a channel's closing channel update has been broadcasted, and optionally
1417 /// check whether an error message event has occurred.
1418 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1419 let msg_events = node.node.get_and_clear_pending_msg_events();
1420 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1421 msg_events.into_iter().filter_map(|msg_event| {
1423 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1424 assert_eq!(msg.contents.flags & 2, 2);
1427 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1428 assert!(with_error_msg);
1429 // TODO: Check node_id
1432 _ => panic!("Unexpected event"),
1437 /// Check that a channel's closing channel update has been broadcasted, and optionally
1438 /// check whether an error message event has occurred.
1440 /// Don't use this, use the identically-named function instead.
1442 macro_rules! check_closed_broadcast {
1443 ($node: expr, $with_error_msg: expr) => {
1444 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1448 /// Check that a channel's closing channel events has been issued
1449 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1450 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1451 let events = node.node.get_and_clear_pending_events();
1452 assert_eq!(events.len(), events_count, "{:?}", events);
1453 let mut issues_discard_funding = false;
1454 for (idx, event) in events.into_iter().enumerate() {
1456 Event::ChannelClosed { ref reason, counterparty_node_id,
1457 channel_capacity_sats, .. } => {
1458 assert_eq!(*reason, expected_reason);
1459 assert_eq!(counterparty_node_id.unwrap(), expected_counterparty_node_ids[idx]);
1460 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1462 Event::DiscardFunding { .. } => {
1463 issues_discard_funding = true;
1465 _ => panic!("Unexpected event"),
1468 assert_eq!(is_check_discard_funding, issues_discard_funding);
1471 /// Check that a channel's closing channel events has been issued
1473 /// Don't use this, use the identically-named function instead.
1475 macro_rules! check_closed_event {
1476 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1477 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1479 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1480 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1481 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1485 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) {
1486 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) };
1487 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) };
1490 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1491 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1493 let events_1 = node_b.get_and_clear_pending_msg_events();
1494 assert!(events_1.len() >= 1);
1495 let shutdown_b = match events_1[0] {
1496 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1497 assert_eq!(node_id, &node_a.get_our_node_id());
1500 _ => panic!("Unexpected event"),
1503 let closing_signed_b = if !close_inbound_first {
1504 assert_eq!(events_1.len(), 1);
1507 Some(match events_1[1] {
1508 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1509 assert_eq!(node_id, &node_a.get_our_node_id());
1512 _ => panic!("Unexpected event"),
1516 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1517 let (as_update, bs_update) = if close_inbound_first {
1518 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1519 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1521 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1522 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1523 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1524 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1526 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1527 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1528 assert!(none_a.is_none());
1529 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1530 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1531 (as_update, bs_update)
1533 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1535 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1536 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1538 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1539 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1540 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1542 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1543 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1544 assert!(none_b.is_none());
1545 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1546 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1547 (as_update, bs_update)
1549 assert_eq!(tx_a, tx_b);
1550 check_spends!(tx_a, funding_tx);
1552 (as_update, bs_update, tx_a)
1555 pub struct SendEvent {
1556 pub node_id: PublicKey,
1557 pub msgs: Vec<msgs::UpdateAddHTLC>,
1558 pub commitment_msg: msgs::CommitmentSigned,
1561 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1562 assert!(updates.update_fulfill_htlcs.is_empty());
1563 assert!(updates.update_fail_htlcs.is_empty());
1564 assert!(updates.update_fail_malformed_htlcs.is_empty());
1565 assert!(updates.update_fee.is_none());
1566 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1569 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1571 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1572 _ => panic!("Unexpected event type!"),
1576 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1577 let mut events = node.node.get_and_clear_pending_msg_events();
1578 assert_eq!(events.len(), 1);
1579 SendEvent::from_event(events.pop().unwrap())
1584 /// Don't use this, use the identically-named function instead.
1585 macro_rules! expect_pending_htlcs_forwardable_conditions {
1586 ($node: expr, $expected_failures: expr) => {
1587 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1592 macro_rules! expect_htlc_handling_failed_destinations {
1593 ($events: expr, $expected_failures: expr) => {{
1594 for event in $events {
1596 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1597 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1598 assert!($expected_failures.contains(&failed_next_destination))
1600 _ => panic!("Unexpected destination"),
1606 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1607 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1608 /// `expected_failures` set.
1609 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1611 Event::PendingHTLCsForwardable { .. } => { },
1612 _ => panic!("Unexpected event {:?}", events),
1615 let count = expected_failures.len() + 1;
1616 assert_eq!(events.len(), count);
1618 if expected_failures.len() > 0 {
1619 expect_htlc_handling_failed_destinations!(events, expected_failures)
1624 /// Clears (and ignores) a PendingHTLCsForwardable event
1626 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1628 macro_rules! expect_pending_htlcs_forwardable_ignore {
1630 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1635 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1637 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1638 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1639 ($node: expr, $expected_failures: expr) => {
1640 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1645 /// Handles a PendingHTLCsForwardable event
1646 macro_rules! expect_pending_htlcs_forwardable {
1648 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1649 $node.node.process_pending_htlc_forwards();
1651 // Ensure process_pending_htlc_forwards is idempotent.
1652 $node.node.process_pending_htlc_forwards();
1657 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1658 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1659 ($node: expr, $expected_failures: expr) => {{
1660 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1661 $node.node.process_pending_htlc_forwards();
1663 // Ensure process_pending_htlc_forwards is idempotent.
1664 $node.node.process_pending_htlc_forwards();
1669 macro_rules! expect_pending_htlcs_forwardable_from_events {
1670 ($node: expr, $events: expr, $ignore: expr) => {{
1671 assert_eq!($events.len(), 1);
1673 Event::PendingHTLCsForwardable { .. } => { },
1674 _ => panic!("Unexpected event"),
1677 $node.node.process_pending_htlc_forwards();
1679 // Ensure process_pending_htlc_forwards is idempotent.
1680 $node.node.process_pending_htlc_forwards();
1686 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1687 /// commitment update.
1688 macro_rules! commitment_signed_dance {
1689 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1690 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1692 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1693 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1695 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1697 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1698 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1699 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1700 check_added_monitors(&$node_a, 1);
1701 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1702 assert!(extra_msg_option.is_none());
1706 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1707 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1709 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1710 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1714 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1715 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1716 /// `revoke_and_ack` response to it.
1718 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1719 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1720 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1721 /// the commitment we're exchanging. `includes_claim` provides that information.
1723 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1724 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1725 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1726 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1727 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1731 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1732 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1733 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1735 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1736 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1737 check_added_monitors!(node_b, 0);
1738 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1739 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1740 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1741 check_added_monitors!(node_b, 1);
1742 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1743 let (bs_revoke_and_ack, extra_msg_option) = {
1744 let mut events = node_b.node.get_and_clear_pending_msg_events();
1745 assert!(events.len() <= 2);
1746 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1747 (match node_a_event {
1748 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1749 assert_eq!(*node_id, node_a.node.get_our_node_id());
1752 _ => panic!("Unexpected event"),
1753 }, events.get(0).map(|e| e.clone()))
1755 check_added_monitors!(node_b, 1);
1757 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1758 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1760 (extra_msg_option, bs_revoke_and_ack)
1763 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1764 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1766 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1767 /// on failure or that no new messages are left over on success.
1768 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1769 check_added_monitors!(node_a, 0);
1770 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1771 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1772 check_added_monitors!(node_a, 1);
1774 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1775 let got_claim = node_a.node.pending_events.lock().unwrap().iter().any(|(ev, action)| {
1776 let matching_action = if let Some(channelmanager::EventCompletionAction::ReleaseRAAChannelMonitorUpdate
1777 { channel_funding_outpoint, counterparty_node_id }) = action
1779 if channel_funding_outpoint.to_channel_id() == commitment_signed.channel_id {
1780 assert_eq!(*counterparty_node_id, node_b.node.get_our_node_id());
1784 if matching_action {
1785 if let Event::PaymentSent { .. } = ev {} else { panic!(); }
1789 if fail_backwards { assert!(!got_claim); }
1790 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1792 if skip_last_step { return; }
1795 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1796 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1797 check_added_monitors!(node_a, 1);
1799 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1800 let mut number_of_msg_events = 0;
1801 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1802 let peer_state = peer_state_mutex.lock().unwrap();
1803 let cp_pending_msg_events = &peer_state.pending_msg_events;
1804 number_of_msg_events += cp_pending_msg_events.len();
1805 if cp_pending_msg_events.len() == 1 {
1806 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1807 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1808 } else { panic!("Unexpected event"); }
1811 // Expecting the failure backwards event to the previous hop (not `node_b`)
1812 assert_eq!(number_of_msg_events, 1);
1814 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1818 /// Get a payment preimage and hash.
1819 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1820 let mut payment_count = recipient.network_payment_count.borrow_mut();
1821 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1822 *payment_count += 1;
1823 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1824 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1825 (payment_preimage, payment_hash, payment_secret)
1828 /// Get a payment preimage and hash.
1830 /// Don't use this, use the identically-named function instead.
1832 macro_rules! get_payment_preimage_hash {
1833 ($dest_node: expr) => {
1834 get_payment_preimage_hash!($dest_node, None)
1836 ($dest_node: expr, $min_value_msat: expr) => {
1837 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1839 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1840 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1844 /// Gets a route from the given sender to the node described in `payment_params`.
1845 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1846 let scorer = TestScorer::new();
1847 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1848 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1850 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1851 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1852 send_node.logger, &scorer, &(), &random_seed_bytes
1856 /// Gets a route from the given sender to the node described in `payment_params`.
1858 /// Don't use this, use the identically-named function instead.
1860 macro_rules! get_route {
1861 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1862 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1863 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1869 macro_rules! get_route_and_payment_hash {
1870 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1871 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1872 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1873 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1875 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1876 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1877 let (payment_preimage, payment_hash, payment_secret) =
1878 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1879 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1880 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1884 pub fn check_payment_claimable(
1885 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1886 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1887 expected_receiver_node_id: PublicKey,
1890 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1891 assert_eq!(expected_payment_hash, *payment_hash);
1892 assert_eq!(expected_recv_value, *amount_msat);
1893 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1895 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1896 assert_eq!(&expected_payment_preimage, payment_preimage);
1897 assert_eq!(expected_payment_secret, *payment_secret);
1902 _ => panic!("Unexpected event"),
1907 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1908 macro_rules! expect_payment_claimable {
1909 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1910 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1912 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1913 let events = $node.node.get_and_clear_pending_events();
1914 assert_eq!(events.len(), 1);
1915 $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)
1920 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1921 macro_rules! expect_payment_claimed {
1922 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1923 let events = $node.node.get_and_clear_pending_events();
1924 assert_eq!(events.len(), 1);
1926 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1927 assert_eq!($expected_payment_hash, *payment_hash);
1928 assert_eq!($expected_recv_value, amount_msat);
1930 _ => panic!("Unexpected event"),
1935 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1936 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1937 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
1939 let events = node.node().get_and_clear_pending_events();
1940 let expected_payment_hash = PaymentHash(
1941 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1942 if expect_per_path_claims {
1943 assert!(events.len() > 1);
1945 assert_eq!(events.len(), 1);
1947 if expect_post_ev_mon_update {
1948 check_added_monitors(node, 1);
1950 let expected_payment_id = match events[0] {
1951 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1952 assert_eq!(expected_payment_preimage, *payment_preimage);
1953 assert_eq!(expected_payment_hash, *payment_hash);
1954 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1955 assert_eq!(*fee_paid_msat, expected_fee_msat);
1957 assert!(fee_paid_msat.is_some());
1961 _ => panic!("Unexpected event"),
1963 if expect_per_path_claims {
1964 for i in 1..events.len() {
1966 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1967 assert_eq!(payment_id, expected_payment_id);
1968 assert_eq!(payment_hash, Some(expected_payment_hash));
1970 _ => panic!("Unexpected event"),
1977 macro_rules! expect_payment_sent {
1978 ($node: expr, $expected_payment_preimage: expr) => {
1979 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1981 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1982 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1984 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1985 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1986 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
1992 macro_rules! expect_payment_path_successful {
1994 let events = $node.node.get_and_clear_pending_events();
1995 assert_eq!(events.len(), 1);
1997 $crate::events::Event::PaymentPathSuccessful { .. } => {},
1998 _ => panic!("Unexpected event"),
2003 macro_rules! expect_payment_forwarded {
2004 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2005 let events = $node.node.get_and_clear_pending_events();
2006 assert_eq!(events.len(), 1);
2008 Event::PaymentForwarded {
2009 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2010 outbound_amount_forwarded_msat: _
2012 assert_eq!(fee_earned_msat, $expected_fee);
2013 if fee_earned_msat.is_some() {
2014 // Is the event prev_channel_id in one of the channels between the two nodes?
2015 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()));
2017 // We check for force closures since a force closed channel is removed from the
2018 // node's channel list
2019 if !$downstream_force_closed {
2020 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()));
2022 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
2024 _ => panic!("Unexpected event"),
2031 macro_rules! expect_channel_shutdown_state {
2032 ($node: expr, $chan_id: expr, $state: path) => {
2033 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2034 assert_eq!(chan_details.len(), 1);
2035 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2039 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2040 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2041 let events = node.node.get_and_clear_pending_events();
2042 assert_eq!(events.len(), 1);
2044 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2045 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2047 _ => panic!("Unexpected event"),
2051 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2052 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2053 let events = node.node.get_and_clear_pending_events();
2054 assert_eq!(events.len(), 1);
2056 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2057 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2059 _ => panic!("Unexpected event"),
2063 pub struct PaymentFailedConditions<'a> {
2064 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2065 pub(crate) expected_blamed_scid: Option<u64>,
2066 pub(crate) expected_blamed_chan_closed: Option<bool>,
2067 pub(crate) expected_mpp_parts_remain: bool,
2070 impl<'a> PaymentFailedConditions<'a> {
2071 pub fn new() -> Self {
2073 expected_htlc_error_data: None,
2074 expected_blamed_scid: None,
2075 expected_blamed_chan_closed: None,
2076 expected_mpp_parts_remain: false,
2079 pub fn mpp_parts_remain(mut self) -> Self {
2080 self.expected_mpp_parts_remain = true;
2083 pub fn blamed_scid(mut self, scid: u64) -> Self {
2084 self.expected_blamed_scid = Some(scid);
2087 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2088 self.expected_blamed_chan_closed = Some(closed);
2091 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2092 self.expected_htlc_error_data = Some((code, data));
2098 macro_rules! expect_payment_failed_with_update {
2099 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2100 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2101 &$node, $expected_payment_hash, $payment_failed_permanently,
2102 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2103 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2108 macro_rules! expect_payment_failed {
2109 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2110 #[allow(unused_mut)]
2111 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2113 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2115 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2119 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2120 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2121 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2123 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2124 let expected_payment_id = match &payment_failed_events[0] {
2125 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2129 error_data, .. } => {
2130 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2131 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2134 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2135 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2136 if let Some((code, data)) = conditions.expected_htlc_error_data {
2137 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2138 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2142 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2143 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2145 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2146 if let Some(scid) = conditions.expected_blamed_scid {
2147 assert_eq!(msg.contents.short_channel_id, scid);
2149 const CHAN_DISABLED_FLAG: u8 = 2;
2150 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2152 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2153 if let Some(scid) = conditions.expected_blamed_scid {
2154 assert_eq!(*short_channel_id, scid);
2156 assert!(is_permanent);
2158 _ => panic!("Unexpected update type"),
2160 } else { panic!("Expected network update"); }
2165 _ => panic!("Unexpected event"),
2167 if !conditions.expected_mpp_parts_remain {
2168 match &payment_failed_events[1] {
2169 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2170 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2171 assert_eq!(*payment_id, expected_payment_id);
2172 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2173 PaymentFailureReason::RecipientRejected
2175 PaymentFailureReason::RetriesExhausted
2178 _ => panic!("Unexpected second event"),
2183 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2184 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2185 conditions: PaymentFailedConditions<'e>
2187 let events = node.node.get_and_clear_pending_events();
2188 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2191 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 {
2192 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2193 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2194 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2195 check_added_monitors!(origin_node, expected_paths.len());
2196 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2200 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> {
2201 let mut payment_event = SendEvent::from_event(ev);
2202 let mut prev_node = origin_node;
2203 let mut event = None;
2205 for (idx, &node) in expected_path.iter().enumerate() {
2206 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2208 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2209 check_added_monitors!(node, 0);
2210 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2212 expect_pending_htlcs_forwardable!(node);
2214 if idx == expected_path.len() - 1 && clear_recipient_events {
2215 let events_2 = node.node.get_and_clear_pending_events();
2216 if payment_claimable_expected {
2217 assert_eq!(events_2.len(), 1);
2218 match &events_2[0] {
2219 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2220 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2221 claim_deadline, onion_fields, ..
2223 assert_eq!(our_payment_hash, *payment_hash);
2224 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2225 assert!(onion_fields.is_some());
2227 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2228 assert_eq!(expected_preimage, *payment_preimage);
2229 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2230 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2232 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2233 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2234 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2237 assert_eq!(*amount_msat, recv_value);
2238 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2239 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2240 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2242 _ => panic!("Unexpected event"),
2244 event = Some(events_2[0].clone());
2246 assert!(events_2.is_empty());
2248 } else if idx != expected_path.len() - 1 {
2249 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2250 assert_eq!(events_2.len(), 1);
2251 check_added_monitors!(node, 1);
2252 payment_event = SendEvent::from_event(events_2.remove(0));
2253 assert_eq!(payment_event.msgs.len(), 1);
2261 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> {
2262 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2265 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) {
2266 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2267 assert_eq!(events.len(), expected_route.len());
2268 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2269 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2270 // Once we've gotten through all the HTLCs, the last one should result in a
2271 // PaymentClaimable (but each previous one should not!), .
2272 let expect_payment = path_idx == expected_route.len() - 1;
2273 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2277 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) {
2278 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2279 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2280 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2283 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2284 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2285 our_payment_preimage: PaymentPreimage
2287 let extra_fees = vec![0; expected_paths.len()];
2288 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2289 &extra_fees[..], skip_last, our_payment_preimage)
2292 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2293 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2294 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2296 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2297 for path in expected_paths.iter() {
2298 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2300 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2301 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2304 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 {
2305 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2306 assert_eq!(claim_event.len(), 1);
2307 match claim_event[0] {
2308 Event::PaymentClaimed {
2309 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2313 | Event::PaymentClaimed {
2314 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2319 assert_eq!(preimage, our_payment_preimage);
2320 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2321 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2322 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2324 Event::PaymentClaimed {
2325 purpose: PaymentPurpose::InvoicePayment { .. },
2331 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2332 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2333 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2334 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2339 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2341 let mut expected_total_fee_msat = 0;
2343 macro_rules! msgs_from_ev {
2346 &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 } } => {
2347 assert!(update_add_htlcs.is_empty());
2348 assert_eq!(update_fulfill_htlcs.len(), 1);
2349 assert!(update_fail_htlcs.is_empty());
2350 assert!(update_fail_malformed_htlcs.is_empty());
2351 assert!(update_fee.is_none());
2352 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2354 _ => panic!("Unexpected event"),
2358 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2359 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2360 assert_eq!(events.len(), expected_paths.len());
2362 if events.len() == 1 {
2363 per_path_msgs.push(msgs_from_ev!(&events[0]));
2365 for expected_path in expected_paths.iter() {
2366 // For MPP payments, we always want the message to the first node in the path.
2367 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2368 per_path_msgs.push(msgs_from_ev!(&ev));
2372 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2373 let mut next_msgs = Some(path_msgs);
2374 let mut expected_next_node = next_hop;
2376 macro_rules! last_update_fulfill_dance {
2377 ($node: expr, $prev_node: expr) => {
2379 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2380 check_added_monitors!($node, 0);
2381 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2382 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2386 macro_rules! mid_update_fulfill_dance {
2387 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2389 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2391 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2392 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2393 .unwrap().lock().unwrap();
2394 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2395 if let Some(prev_config) = channel.context().prev_config() {
2396 prev_config.forwarding_fee_base_msat
2398 channel.context().config().forwarding_fee_base_msat
2401 if $idx == 1 { fee += expected_extra_fees[i]; }
2402 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2403 expected_total_fee_msat += fee as u64;
2404 check_added_monitors!($node, 1);
2405 let new_next_msgs = if $new_msgs {
2406 let events = $node.node.get_and_clear_pending_msg_events();
2407 assert_eq!(events.len(), 1);
2408 let (res, nexthop) = msgs_from_ev!(&events[0]);
2409 expected_next_node = nexthop;
2412 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2415 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2416 next_msgs = new_next_msgs;
2421 let mut prev_node = expected_route.last().unwrap();
2422 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2423 assert_eq!(expected_next_node, node.node.get_our_node_id());
2424 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2425 if next_msgs.is_some() {
2426 // Since we are traversing in reverse, next_node is actually the previous node
2427 let next_node: &Node;
2428 if idx == expected_route.len() - 1 {
2429 next_node = origin_node;
2431 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2433 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2435 assert!(!update_next_msgs);
2436 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2438 if !skip_last && idx == expected_route.len() - 1 {
2439 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2446 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2450 // Ensure that claim_funds is idempotent.
2451 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2452 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2453 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2455 expected_total_fee_msat
2457 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) {
2458 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2460 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2464 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2465 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2468 pub const TEST_FINAL_CLTV: u32 = 70;
2470 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) {
2471 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2472 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2473 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2474 let route = get_route(origin_node, &route_params).unwrap();
2475 assert_eq!(route.paths.len(), 1);
2476 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2477 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2478 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2481 let res = send_along_route(origin_node, route, expected_route, recv_value);
2482 (res.0, res.1, res.2)
2485 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2486 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2487 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2488 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2489 let network_graph = origin_node.network_graph.read_only();
2490 let scorer = test_utils::TestScorer::new();
2491 let seed = [0u8; 32];
2492 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2493 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2494 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2495 None, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2496 assert_eq!(route.paths.len(), 1);
2497 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2498 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2499 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2502 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2503 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2504 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2505 true, APIError::ChannelUnavailable { ref err },
2506 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2509 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2510 let res = route_payment(&origin, expected_route, recv_value);
2511 claim_payment(&origin, expected_route, res.0);
2515 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) {
2516 for path in expected_paths.iter() {
2517 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2519 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2520 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2521 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2523 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2526 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) {
2527 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2528 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2530 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2531 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2532 assert_eq!(events.len(), expected_paths.len());
2533 for ev in events.iter() {
2534 let (update_fail, commitment_signed, node_id) = match ev {
2535 &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 } } => {
2536 assert!(update_add_htlcs.is_empty());
2537 assert!(update_fulfill_htlcs.is_empty());
2538 assert_eq!(update_fail_htlcs.len(), 1);
2539 assert!(update_fail_malformed_htlcs.is_empty());
2540 assert!(update_fee.is_none());
2541 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2543 _ => panic!("Unexpected event"),
2545 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2547 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2548 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()));
2550 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2551 let mut next_msgs = Some(path_msgs);
2552 let mut expected_next_node = next_hop;
2553 let mut prev_node = expected_route.last().unwrap();
2555 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2556 assert_eq!(expected_next_node, node.node.get_our_node_id());
2557 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2558 if next_msgs.is_some() {
2559 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2560 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2561 if !update_next_node {
2562 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 }]);
2565 let events = node.node.get_and_clear_pending_msg_events();
2566 if update_next_node {
2567 assert_eq!(events.len(), 1);
2569 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 } } => {
2570 assert!(update_add_htlcs.is_empty());
2571 assert!(update_fulfill_htlcs.is_empty());
2572 assert_eq!(update_fail_htlcs.len(), 1);
2573 assert!(update_fail_malformed_htlcs.is_empty());
2574 assert!(update_fee.is_none());
2575 expected_next_node = node_id.clone();
2576 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2578 _ => panic!("Unexpected event"),
2581 assert!(events.is_empty());
2583 if !skip_last && idx == expected_route.len() - 1 {
2584 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2591 let prev_node = expected_route.first().unwrap();
2592 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2593 check_added_monitors!(origin_node, 0);
2594 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2595 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2596 let events = origin_node.node.get_and_clear_pending_events();
2597 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2599 let expected_payment_id = match events[0] {
2600 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2601 assert_eq!(payment_hash, our_payment_hash);
2602 assert!(payment_failed_permanently);
2603 for (idx, hop) in expected_route.iter().enumerate() {
2604 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2608 _ => panic!("Unexpected event"),
2610 if i == expected_paths.len() - 1 {
2612 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2613 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2614 assert_eq!(*payment_id, expected_payment_id);
2615 assert_eq!(reason.unwrap(), expected_fail_reason);
2617 _ => panic!("Unexpected second event"),
2623 // Ensure that fail_htlc_backwards is idempotent.
2624 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2625 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2626 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2627 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2630 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2631 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2634 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2635 let mut chan_mon_cfgs = Vec::new();
2636 for i in 0..node_count {
2637 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2638 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2639 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2640 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2641 let persister = test_utils::TestPersister::new();
2642 let seed = [i as u8; 32];
2643 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2644 let scorer = RwLock::new(test_utils::TestScorer::new());
2646 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2652 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2653 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2656 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>> {
2657 let mut nodes = Vec::new();
2659 for i in 0..node_count {
2660 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);
2661 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2662 let seed = [i as u8; 32];
2663 nodes.push(NodeCfg {
2664 chain_source: &chanmon_cfgs[i].chain_source,
2665 logger: &chanmon_cfgs[i].logger,
2666 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2667 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2668 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2670 keys_manager: &chanmon_cfgs[i].keys_manager,
2673 override_init_features: Rc::new(RefCell::new(None)),
2680 pub fn test_default_channel_config() -> UserConfig {
2681 let mut default_config = UserConfig::default();
2682 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2683 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2684 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2685 default_config.channel_handshake_config.announced_channel = true;
2686 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2687 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2688 // It now defaults to 1, so we simply set it to the expected value here.
2689 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2690 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2691 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2693 default_config.channel_config.max_dust_htlc_exposure =
2694 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2698 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>> {
2699 let mut chanmgrs = Vec::new();
2700 for i in 0..node_count {
2701 let network = Network::Testnet;
2702 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2703 let params = ChainParameters {
2705 best_block: BestBlock::from_network(network),
2707 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,
2708 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);
2709 chanmgrs.push(node);
2715 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>> {
2716 let mut nodes = Vec::new();
2717 let chan_count = Rc::new(RefCell::new(0));
2718 let payment_count = Rc::new(RefCell::new(0));
2719 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2721 for i in 0..node_count {
2722 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2723 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2725 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2726 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2727 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2728 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2729 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2730 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2731 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2732 connect_style: Rc::clone(&connect_style),
2733 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2734 wallet_source: Arc::clone(&wallet_source),
2735 bump_tx_handler: BumpTransactionEventHandler::new(
2736 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2737 &cfgs[i].keys_manager, cfgs[i].logger,
2742 for i in 0..node_count {
2743 for j in (i+1)..node_count {
2744 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2745 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2747 remote_network_address: None,
2749 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2750 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2752 remote_network_address: None,
2760 // Note that the following only works for CLTV values up to 128
2761 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2763 #[derive(PartialEq)]
2764 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2765 /// Tests that the given node has broadcast transactions for the given Channel
2767 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2768 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2769 /// broadcast and the revoked outputs were claimed.
2771 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2772 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2774 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2776 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> {
2777 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2778 let mut txn_seen = HashSet::new();
2779 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2780 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2782 let mut res = Vec::with_capacity(2);
2783 node_txn.retain(|tx| {
2784 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2785 check_spends!(tx, chan.3);
2786 if commitment_tx.is_none() {
2787 res.push(tx.clone());
2792 if let Some(explicit_tx) = commitment_tx {
2793 res.push(explicit_tx.clone());
2796 assert_eq!(res.len(), 1);
2798 if has_htlc_tx != HTLCType::NONE {
2799 node_txn.retain(|tx| {
2800 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2801 check_spends!(tx, res[0]);
2802 if has_htlc_tx == HTLCType::TIMEOUT {
2803 assert!(tx.lock_time.0 != 0);
2805 assert!(tx.lock_time.0 == 0);
2807 res.push(tx.clone());
2811 assert!(res.len() == 2 || res.len() == 3);
2813 assert_eq!(res[1], res[2]);
2817 assert!(node_txn.is_empty());
2821 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2822 /// HTLC transaction.
2823 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2824 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2825 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2826 // for revoked htlc outputs
2827 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2828 node_txn.retain(|tx| {
2829 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2830 check_spends!(tx, revoked_tx);
2834 node_txn.retain(|tx| {
2835 check_spends!(tx, commitment_revoked_tx);
2838 assert!(node_txn.is_empty());
2841 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2842 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2843 let mut txn_seen = HashSet::new();
2844 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2846 let mut found_prev = false;
2847 for prev_tx in prev_txn {
2848 for tx in &*node_txn {
2849 if tx.input[0].previous_output.txid == prev_tx.txid() {
2850 check_spends!(tx, prev_tx);
2851 let mut iter = tx.input[0].witness.iter();
2852 iter.next().expect("expected 3 witness items");
2853 iter.next().expect("expected 3 witness items");
2854 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2855 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2862 assert!(found_prev);
2864 let mut res = Vec::new();
2865 mem::swap(&mut *node_txn, &mut res);
2869 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) {
2870 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2871 assert_eq!(events_1.len(), 2);
2872 let as_update = match events_1[0] {
2873 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2876 _ => panic!("Unexpected event"),
2879 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2880 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2881 assert_eq!(msg.data, expected_error);
2882 if needs_err_handle {
2883 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2886 _ => panic!("Unexpected event"),
2889 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2890 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2891 let bs_update = match events_2[0] {
2892 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2895 _ => panic!("Unexpected event"),
2897 if !needs_err_handle {
2899 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2900 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2901 assert_eq!(msg.data, expected_error);
2903 _ => panic!("Unexpected event"),
2908 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2909 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2913 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2914 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2918 macro_rules! get_channel_value_stat {
2919 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2920 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2921 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2922 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
2923 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
2924 ).flatten().unwrap();
2925 chan.get_value_stat()
2929 macro_rules! get_chan_reestablish_msgs {
2930 ($src_node: expr, $dst_node: expr) => {
2932 let mut announcements = $crate::prelude::HashSet::new();
2933 let mut res = Vec::with_capacity(1);
2934 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2935 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2936 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2937 res.push(msg.clone());
2938 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2939 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2940 announcements.insert(msg.contents.short_channel_id);
2942 panic!("Unexpected event")
2945 assert!(announcements.is_empty());
2951 macro_rules! handle_chan_reestablish_msgs {
2952 ($src_node: expr, $dst_node: expr) => {
2954 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2956 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2958 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2964 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2966 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2969 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2970 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2971 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2973 had_channel_update = true;
2976 let mut revoke_and_ack = None;
2977 let mut commitment_update = None;
2978 let order = if let Some(ev) = msg_events.get(idx) {
2980 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2981 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2982 revoke_and_ack = Some(msg.clone());
2984 RAACommitmentOrder::RevokeAndACKFirst
2986 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2987 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2988 commitment_update = Some(updates.clone());
2990 RAACommitmentOrder::CommitmentFirst
2992 _ => RAACommitmentOrder::CommitmentFirst,
2995 RAACommitmentOrder::CommitmentFirst
2998 if let Some(ev) = msg_events.get(idx) {
3000 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3001 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3002 assert!(revoke_and_ack.is_none());
3003 revoke_and_ack = Some(msg.clone());
3006 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3007 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3008 assert!(commitment_update.is_none());
3009 commitment_update = Some(updates.clone());
3016 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3017 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3019 assert!(!had_channel_update);
3022 assert_eq!(msg_events.len(), idx);
3024 (channel_ready, revoke_and_ack, commitment_update, order)
3029 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3030 pub node_a: &'a Node<'b, 'c, 'd>,
3031 pub node_b: &'a Node<'b, 'c, 'd>,
3032 pub send_channel_ready: (bool, bool),
3033 pub pending_htlc_adds: (i64, i64),
3034 pub pending_htlc_claims: (usize, usize),
3035 pub pending_htlc_fails: (usize, usize),
3036 pub pending_cell_htlc_claims: (usize, usize),
3037 pub pending_cell_htlc_fails: (usize, usize),
3038 pub pending_raa: (bool, bool),
3041 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3042 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3046 send_channel_ready: (false, false),
3047 pending_htlc_adds: (0, 0),
3048 pending_htlc_claims: (0, 0),
3049 pending_htlc_fails: (0, 0),
3050 pending_cell_htlc_claims: (0, 0),
3051 pending_cell_htlc_fails: (0, 0),
3052 pending_raa: (false, false),
3057 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3058 /// for claims/fails they are separated out.
3059 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3061 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3062 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa
3064 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3065 features: node_b.node.init_features(), networks: None, remote_network_address: None
3067 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3068 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3069 features: node_a.node.init_features(), networks: None, remote_network_address: None
3071 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3073 if send_channel_ready.0 {
3074 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3076 for reestablish in reestablish_1.iter() {
3077 assert_eq!(reestablish.next_remote_commitment_number, 0);
3080 if send_channel_ready.1 {
3081 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3083 for reestablish in reestablish_2.iter() {
3084 assert_eq!(reestablish.next_remote_commitment_number, 0);
3087 if send_channel_ready.0 || send_channel_ready.1 {
3088 // If we expect any channel_ready's, both sides better have set
3089 // next_holder_commitment_number to 1
3090 for reestablish in reestablish_1.iter() {
3091 assert_eq!(reestablish.next_local_commitment_number, 1);
3093 for reestablish in reestablish_2.iter() {
3094 assert_eq!(reestablish.next_local_commitment_number, 1);
3098 let mut resp_1 = Vec::new();
3099 for msg in reestablish_1 {
3100 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3101 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3103 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3104 check_added_monitors!(node_b, 1);
3106 check_added_monitors!(node_b, 0);
3109 let mut resp_2 = Vec::new();
3110 for msg in reestablish_2 {
3111 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3112 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3114 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3115 check_added_monitors!(node_a, 1);
3117 check_added_monitors!(node_a, 0);
3120 // We don't yet support both needing updates, as that would require a different commitment dance:
3121 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3122 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3123 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3124 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3126 for chan_msgs in resp_1.drain(..) {
3127 if send_channel_ready.0 {
3128 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3129 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3130 if !announcement_event.is_empty() {
3131 assert_eq!(announcement_event.len(), 1);
3132 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3133 //TODO: Test announcement_sigs re-sending
3134 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3137 assert!(chan_msgs.0.is_none());
3140 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3141 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3142 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3143 check_added_monitors!(node_a, 1);
3145 assert!(chan_msgs.1.is_none());
3147 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 {
3148 let commitment_update = chan_msgs.2.unwrap();
3149 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3150 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3152 assert!(commitment_update.update_add_htlcs.is_empty());
3154 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3155 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3156 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3157 for update_add in commitment_update.update_add_htlcs {
3158 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3160 for update_fulfill in commitment_update.update_fulfill_htlcs {
3161 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3163 for update_fail in commitment_update.update_fail_htlcs {
3164 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3167 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3168 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3170 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3171 check_added_monitors!(node_a, 1);
3172 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3173 // No commitment_signed so get_event_msg's assert(len == 1) passes
3174 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3175 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3176 check_added_monitors!(node_b, 1);
3179 assert!(chan_msgs.2.is_none());
3183 for chan_msgs in resp_2.drain(..) {
3184 if send_channel_ready.1 {
3185 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3186 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3187 if !announcement_event.is_empty() {
3188 assert_eq!(announcement_event.len(), 1);
3189 match announcement_event[0] {
3190 MessageSendEvent::SendChannelUpdate { .. } => {},
3191 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3192 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3196 assert!(chan_msgs.0.is_none());
3199 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3200 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3201 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3202 check_added_monitors!(node_b, 1);
3204 assert!(chan_msgs.1.is_none());
3206 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 {
3207 let commitment_update = chan_msgs.2.unwrap();
3208 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3209 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3211 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3212 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3213 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3214 for update_add in commitment_update.update_add_htlcs {
3215 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3217 for update_fulfill in commitment_update.update_fulfill_htlcs {
3218 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3220 for update_fail in commitment_update.update_fail_htlcs {
3221 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3224 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3225 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3227 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3228 check_added_monitors!(node_b, 1);
3229 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3230 // No commitment_signed so get_event_msg's assert(len == 1) passes
3231 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3232 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3233 check_added_monitors!(node_a, 1);
3236 assert!(chan_msgs.2.is_none());