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};
14 use crate::sign::EntropySource;
15 use crate::chain::channelmonitor::ChannelMonitor;
16 use crate::chain::transaction::OutPoint;
17 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
18 use crate::events::bump_transaction::{BumpTransactionEventHandler, Wallet, WalletSource};
19 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
20 use crate::ln::channelmanager::{self, AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
21 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
22 use crate::routing::router::{self, PaymentParameters, Route};
23 use crate::ln::features::InitFeatures;
25 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
26 use crate::util::enforcing_trait_impls::EnforcingSigner;
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};
48 use core::iter::repeat;
49 use bitcoin::{PackedLockTime, 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: Mutex<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<EnforcingSigner>)>::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 = Mutex::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>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], 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>(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, [u8; 32], Transaction) {
578 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
579 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
580 (announcement, as_update, bs_update, channel_id, tx)
583 /// Gets an RAA and CS which were sent in response to a commitment update
584 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
585 let events = node.node().get_and_clear_pending_msg_events();
586 assert_eq!(events.len(), 2);
588 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
589 assert_eq!(node_id, recipient);
592 _ => panic!("Unexpected event"),
594 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
595 assert_eq!(node_id, recipient);
596 assert!(updates.update_add_htlcs.is_empty());
597 assert!(updates.update_fulfill_htlcs.is_empty());
598 assert!(updates.update_fail_htlcs.is_empty());
599 assert!(updates.update_fail_malformed_htlcs.is_empty());
600 assert!(updates.update_fee.is_none());
601 updates.commitment_signed.clone()
603 _ => panic!("Unexpected event"),
608 /// Gets an RAA and CS which were sent in response to a commitment update
610 /// Don't use this, use the identically-named function instead.
611 macro_rules! get_revoke_commit_msgs {
612 ($node: expr, $node_id: expr) => {
613 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
617 /// Get an specific event message from the pending events queue.
619 macro_rules! get_event_msg {
620 ($node: expr, $event_type: path, $node_id: expr) => {
622 let events = $node.node.get_and_clear_pending_msg_events();
623 assert_eq!(events.len(), 1);
625 $event_type { ref node_id, ref msg } => {
626 assert_eq!(*node_id, $node_id);
629 _ => panic!("Unexpected event"),
635 /// Get an error message from the pending events queue.
636 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
637 let events = node.node.get_and_clear_pending_msg_events();
638 assert_eq!(events.len(), 1);
640 MessageSendEvent::HandleError {
641 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
643 assert_eq!(node_id, recipient);
646 _ => panic!("Unexpected event"),
650 /// Get a specific event from the pending events queue.
652 macro_rules! get_event {
653 ($node: expr, $event_type: path) => {
655 let mut events = $node.node.get_and_clear_pending_events();
656 assert_eq!(events.len(), 1);
657 let ev = events.pop().unwrap();
659 $event_type { .. } => {
662 _ => panic!("Unexpected event"),
668 /// Gets an UpdateHTLCs MessageSendEvent
669 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
670 let events = node.node.get_and_clear_pending_msg_events();
671 assert_eq!(events.len(), 1);
673 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
674 assert_eq!(node_id, recipient);
677 _ => panic!("Unexpected event"),
682 /// Gets an UpdateHTLCs MessageSendEvent
684 /// Don't use this, use the identically-named function instead.
685 macro_rules! get_htlc_update_msgs {
686 ($node: expr, $node_id: expr) => {
687 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
691 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
692 /// Returns the `msg_event`.
694 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
695 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
696 /// such messages are intended to all peers.
697 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
698 let ev_index = msg_events.iter().position(|e| { match e {
699 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
700 node_id == msg_node_id
702 MessageSendEvent::SendOpenChannel { node_id, .. } => {
703 node_id == msg_node_id
705 MessageSendEvent::SendFundingCreated { node_id, .. } => {
706 node_id == msg_node_id
708 MessageSendEvent::SendFundingSigned { node_id, .. } => {
709 node_id == msg_node_id
711 MessageSendEvent::SendChannelReady { node_id, .. } => {
712 node_id == msg_node_id
714 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
715 node_id == msg_node_id
717 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
718 node_id == msg_node_id
720 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
721 node_id == msg_node_id
723 MessageSendEvent::SendClosingSigned { node_id, .. } => {
724 node_id == msg_node_id
726 MessageSendEvent::SendShutdown { node_id, .. } => {
727 node_id == msg_node_id
729 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
730 node_id == msg_node_id
732 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
733 node_id == msg_node_id
735 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
738 MessageSendEvent::BroadcastChannelUpdate { .. } => {
741 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
744 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
745 node_id == msg_node_id
747 MessageSendEvent::HandleError { node_id, .. } => {
748 node_id == msg_node_id
750 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
751 node_id == msg_node_id
753 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
754 node_id == msg_node_id
756 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
757 node_id == msg_node_id
759 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
760 node_id == msg_node_id
762 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
763 node_id == msg_node_id
765 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
766 node_id == msg_node_id
768 MessageSendEvent::SendTxAddInput { node_id, .. } => {
769 node_id == msg_node_id
771 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
772 node_id == msg_node_id
774 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
775 node_id == msg_node_id
777 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
778 node_id == msg_node_id
780 MessageSendEvent::SendTxComplete { node_id, .. } => {
781 node_id == msg_node_id
783 MessageSendEvent::SendTxSignatures { node_id, .. } => {
784 node_id == msg_node_id
786 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
787 node_id == msg_node_id
789 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
790 node_id == msg_node_id
792 MessageSendEvent::SendTxAbort { node_id, .. } => {
793 node_id == msg_node_id
796 if ev_index.is_some() {
797 msg_events.remove(ev_index.unwrap())
799 panic!("Couldn't find any MessageSendEvent to the node!")
804 macro_rules! get_channel_ref {
805 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
807 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
808 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
809 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
815 macro_rules! get_outbound_v1_channel_ref {
816 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
818 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
819 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
820 $peer_state_lock.outbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
826 macro_rules! get_inbound_v1_channel_ref {
827 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
829 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
830 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
831 $peer_state_lock.inbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
837 macro_rules! get_feerate {
838 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
840 let mut per_peer_state_lock;
841 let mut peer_state_lock;
842 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
843 chan.context.get_feerate_sat_per_1000_weight()
849 macro_rules! get_channel_type_features {
850 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
852 let mut per_peer_state_lock;
853 let mut peer_state_lock;
854 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
855 chan.context.get_channel_type().clone()
860 /// Returns a channel monitor given a channel id, making some naive assumptions
862 macro_rules! get_monitor {
863 ($node: expr, $channel_id: expr) => {
865 use bitcoin::hashes::Hash;
866 let mut monitor = None;
867 // Assume funding vout is either 0 or 1 blindly
869 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
870 $crate::chain::transaction::OutPoint {
871 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
883 /// Returns any local commitment transactions for the channel.
885 macro_rules! get_local_commitment_txn {
886 ($node: expr, $channel_id: expr) => {
888 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
893 /// Check the error from attempting a payment.
895 macro_rules! unwrap_send_err {
896 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
898 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
899 assert_eq!(fails.len(), 1);
905 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
906 assert_eq!(results.len(), 1);
908 Err($type) => { $check },
917 /// Check whether N channel monitor(s) have been added.
918 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
919 if let Some(chain_monitor) = node.chain_monitor() {
920 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
921 assert_eq!(added_monitors.len(), count);
922 added_monitors.clear();
926 /// Check whether N channel monitor(s) have been added.
928 /// Don't use this, use the identically-named function instead.
930 macro_rules! check_added_monitors {
931 ($node: expr, $count: expr) => {
932 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
936 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> {
937 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
938 for encoded in monitors_encoded {
939 let mut monitor_read = &encoded[..];
940 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
941 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
942 assert!(monitor_read.is_empty());
943 monitors_read.push(monitor);
946 let mut node_read = &chanman_encoded[..];
947 let (_, node_deserialized) = {
948 let mut channel_monitors = HashMap::new();
949 for monitor in monitors_read.iter_mut() {
950 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
952 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
954 entropy_source: node.keys_manager,
955 node_signer: node.keys_manager,
956 signer_provider: node.keys_manager,
957 fee_estimator: node.fee_estimator,
959 chain_monitor: node.chain_monitor,
960 tx_broadcaster: node.tx_broadcaster,
965 assert!(node_read.is_empty());
967 for monitor in monitors_read.drain(..) {
968 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
969 ChannelMonitorUpdateStatus::Completed);
970 check_added_monitors!(node, 1);
977 macro_rules! reload_node {
978 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
979 let chanman_encoded = $chanman_encoded;
981 $persister = test_utils::TestPersister::new();
982 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
983 $node.chain_monitor = &$new_chain_monitor;
985 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
986 $node.node = &$new_channelmanager;
988 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
989 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
993 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128) -> ([u8; 32], Transaction, OutPoint) {
994 let chan_id = *node.network_chan_count.borrow();
996 let events = node.node.get_and_clear_pending_events();
997 assert_eq!(events.len(), 1);
999 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1000 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1001 assert_eq!(*channel_value_satoshis, expected_chan_value);
1002 assert_eq!(user_channel_id, expected_user_chan_id);
1004 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
1005 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1007 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1008 (*temporary_channel_id, tx, funding_outpoint)
1010 _ => panic!("Unexpected event"),
1013 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: [u8; 32]) -> Transaction {
1014 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1015 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1017 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1018 check_added_monitors!(node_a, 0);
1020 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1021 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1022 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1024 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1025 assert_eq!(added_monitors.len(), 1);
1026 assert_eq!(added_monitors[0].0, funding_output);
1027 added_monitors.clear();
1029 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1031 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()));
1033 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1034 assert_eq!(added_monitors.len(), 1);
1035 assert_eq!(added_monitors[0].0, funding_output);
1036 added_monitors.clear();
1038 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1040 let events_4 = node_a.node.get_and_clear_pending_events();
1041 assert_eq!(events_4.len(), 0);
1043 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1044 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1045 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1047 // Ensure that funding_transaction_generated is idempotent.
1048 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1049 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1050 check_added_monitors!(node_a, 0);
1055 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1056 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, [u8; 32]) {
1057 let initiator_channels = initiator.node.list_usable_channels().len();
1058 let receiver_channels = receiver.node.list_usable_channels().len();
1060 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1061 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1063 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1064 let events = receiver.node.get_and_clear_pending_events();
1065 assert_eq!(events.len(), 1);
1067 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1068 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1070 _ => panic!("Unexpected event"),
1073 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1074 assert_eq!(accept_channel.minimum_depth, 0);
1075 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1077 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1078 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1079 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1081 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1082 check_added_monitors!(receiver, 1);
1083 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1084 assert_eq!(bs_signed_locked.len(), 2);
1085 let as_channel_ready;
1086 match &bs_signed_locked[0] {
1087 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1088 assert_eq!(*node_id, initiator.node.get_our_node_id());
1089 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1090 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1091 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1092 check_added_monitors!(initiator, 1);
1094 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1095 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1097 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1099 _ => panic!("Unexpected event"),
1101 match &bs_signed_locked[1] {
1102 MessageSendEvent::SendChannelReady { node_id, msg } => {
1103 assert_eq!(*node_id, initiator.node.get_our_node_id());
1104 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1105 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1107 _ => panic!("Unexpected event"),
1110 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1111 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1113 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1114 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1116 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1117 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1119 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1120 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1122 (tx, as_channel_ready.channel_id)
1125 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 {
1126 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1127 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1128 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1129 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1130 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1131 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1132 let events = node_b.node.get_and_clear_pending_events();
1133 assert_eq!(events.len(), 1);
1135 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1136 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1137 _ => panic!("Unexpected event"),
1140 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1141 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1142 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1143 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1145 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1148 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) {
1149 confirm_transaction_at(node_conf, tx, conf_height);
1150 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1151 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()));
1154 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), [u8; 32]) {
1156 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1157 assert_eq!(events_6.len(), 3);
1158 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1159 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1161 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1162 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1164 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1165 ((match events_6[0] {
1166 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1167 channel_id = msg.channel_id.clone();
1168 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1171 _ => panic!("Unexpected event"),
1172 }, match events_6[announcement_sigs_idx] {
1173 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1174 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1177 _ => panic!("Unexpected event"),
1181 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
1182 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1183 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1184 confirm_transaction_at(node_a, tx, conf_height);
1185 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1186 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1187 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1190 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c, '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), [u8; 32], Transaction) {
1191 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1192 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1196 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) {
1197 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1198 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1199 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1201 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1202 assert_eq!(events_7.len(), 1);
1203 let (announcement, bs_update) = match events_7[0] {
1204 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1205 (msg, update_msg.clone().unwrap())
1207 _ => panic!("Unexpected event"),
1210 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1211 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1212 assert_eq!(events_8.len(), 1);
1213 let as_update = match events_8[0] {
1214 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1215 assert!(*announcement == *msg);
1216 let update_msg = update_msg.clone().unwrap();
1217 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1218 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1221 _ => panic!("Unexpected event"),
1224 *node_a.network_chan_count.borrow_mut() += 1;
1226 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1227 ((*announcement).clone(), as_update, bs_update)
1230 pub fn create_announced_chan_between_nodes<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1231 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1234 pub fn create_announced_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::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1235 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1236 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1237 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1240 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) {
1241 let mut no_announce_cfg = test_default_channel_config();
1242 no_announce_cfg.channel_handshake_config.announced_channel = false;
1243 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1244 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1245 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1246 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1247 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1249 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1250 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1251 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()));
1252 check_added_monitors!(nodes[b], 1);
1254 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1255 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1257 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1258 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1259 check_added_monitors!(nodes[a], 1);
1261 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1262 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1263 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1265 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1266 confirm_transaction_at(&nodes[a], &tx, conf_height);
1267 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1268 confirm_transaction_at(&nodes[b], &tx, conf_height);
1269 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1270 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1271 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()));
1272 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1273 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1274 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1275 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1276 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1278 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1279 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1281 let mut found_a = false;
1282 for chan in nodes[a].node.list_usable_channels() {
1283 if chan.channel_id == as_channel_ready.channel_id {
1286 assert!(!chan.is_public);
1291 let mut found_b = false;
1292 for chan in nodes[b].node.list_usable_channels() {
1293 if chan.channel_id == as_channel_ready.channel_id {
1296 assert!(!chan.is_public);
1301 (as_channel_ready, tx)
1304 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) {
1306 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1307 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1308 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1310 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1311 // forwarding info for local channels even if its not accepted in the network graph.
1312 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1313 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1317 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1318 for outp in tx.output.iter() {
1319 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1321 let mut total_value_in = 0;
1322 for input in tx.input.iter() {
1323 total_value_in += get_output(&input.previous_output).unwrap().value;
1325 let mut total_value_out = 0;
1326 for output in tx.output.iter() {
1327 total_value_out += output.value;
1329 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1330 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1331 assert!(total_value_out + min_fee <= total_value_in);
1332 tx.verify(get_output).unwrap();
1336 macro_rules! check_spends {
1337 ($tx: expr, $($spends_txn: expr),*) => {
1340 for outp in $spends_txn.output.iter() {
1341 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1344 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1346 if out_point.txid == $spends_txn.txid() {
1347 return $spends_txn.output.get(out_point.vout as usize).cloned()
1352 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1357 macro_rules! get_closing_signed_broadcast {
1358 ($node: expr, $dest_pubkey: expr) => {
1360 let events = $node.get_and_clear_pending_msg_events();
1361 assert!(events.len() == 1 || events.len() == 2);
1362 (match events[events.len() - 1] {
1363 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1364 assert_eq!(msg.contents.flags & 2, 2);
1367 _ => panic!("Unexpected event"),
1368 }, if events.len() == 2 {
1370 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1371 assert_eq!(*node_id, $dest_pubkey);
1374 _ => panic!("Unexpected event"),
1382 macro_rules! check_warn_msg {
1383 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1384 let msg_events = $node.node.get_and_clear_pending_msg_events();
1385 assert_eq!(msg_events.len(), 1);
1386 match msg_events[0] {
1387 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1388 assert_eq!(node_id, $recipient_node_id);
1389 assert_eq!(msg.channel_id, $chan_id);
1392 _ => panic!("Unexpected event"),
1397 /// Check that a channel's closing channel update has been broadcasted, and optionally
1398 /// check whether an error message event has occurred.
1399 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1400 let msg_events = node.node.get_and_clear_pending_msg_events();
1401 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1402 msg_events.into_iter().filter_map(|msg_event| {
1404 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1405 assert_eq!(msg.contents.flags & 2, 2);
1408 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1409 assert!(with_error_msg);
1410 // TODO: Check node_id
1413 _ => panic!("Unexpected event"),
1418 /// Check that a channel's closing channel update has been broadcasted, and optionally
1419 /// check whether an error message event has occurred.
1421 /// Don't use this, use the identically-named function instead.
1423 macro_rules! check_closed_broadcast {
1424 ($node: expr, $with_error_msg: expr) => {
1425 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1429 /// Check that a channel's closing channel events has been issued
1430 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1431 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1432 let events = node.node.get_and_clear_pending_events();
1433 assert_eq!(events.len(), events_count, "{:?}", events);
1434 let mut issues_discard_funding = false;
1435 for (idx, event) in events.into_iter().enumerate() {
1437 Event::ChannelClosed { ref reason, counterparty_node_id,
1438 channel_capacity_sats, .. } => {
1439 assert_eq!(*reason, expected_reason);
1440 assert_eq!(counterparty_node_id.unwrap(), expected_counterparty_node_ids[idx]);
1441 assert_eq!(channel_capacity_sats.unwrap(), expected_channel_capacity);
1443 Event::DiscardFunding { .. } => {
1444 issues_discard_funding = true;
1446 _ => panic!("Unexpected event"),
1449 assert_eq!(is_check_discard_funding, issues_discard_funding);
1452 /// Check that a channel's closing channel events has been issued
1454 /// Don't use this, use the identically-named function instead.
1456 macro_rules! check_closed_event {
1457 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1458 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1460 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1461 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1462 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1466 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
1467 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) };
1468 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) };
1471 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1472 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1474 let events_1 = node_b.get_and_clear_pending_msg_events();
1475 assert!(events_1.len() >= 1);
1476 let shutdown_b = match events_1[0] {
1477 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1478 assert_eq!(node_id, &node_a.get_our_node_id());
1481 _ => panic!("Unexpected event"),
1484 let closing_signed_b = if !close_inbound_first {
1485 assert_eq!(events_1.len(), 1);
1488 Some(match events_1[1] {
1489 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1490 assert_eq!(node_id, &node_a.get_our_node_id());
1493 _ => panic!("Unexpected event"),
1497 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1498 let (as_update, bs_update) = if close_inbound_first {
1499 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1500 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1502 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1503 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1504 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1505 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1507 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1508 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1509 assert!(none_a.is_none());
1510 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1511 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1512 (as_update, bs_update)
1514 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1516 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1517 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1519 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1520 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1521 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1523 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1524 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1525 assert!(none_b.is_none());
1526 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1527 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1528 (as_update, bs_update)
1530 assert_eq!(tx_a, tx_b);
1531 check_spends!(tx_a, funding_tx);
1533 (as_update, bs_update, tx_a)
1536 pub struct SendEvent {
1537 pub node_id: PublicKey,
1538 pub msgs: Vec<msgs::UpdateAddHTLC>,
1539 pub commitment_msg: msgs::CommitmentSigned,
1542 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1543 assert!(updates.update_fulfill_htlcs.is_empty());
1544 assert!(updates.update_fail_htlcs.is_empty());
1545 assert!(updates.update_fail_malformed_htlcs.is_empty());
1546 assert!(updates.update_fee.is_none());
1547 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1550 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1552 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1553 _ => panic!("Unexpected event type!"),
1557 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1558 let mut events = node.node.get_and_clear_pending_msg_events();
1559 assert_eq!(events.len(), 1);
1560 SendEvent::from_event(events.pop().unwrap())
1565 /// Don't use this, use the identically-named function instead.
1566 macro_rules! expect_pending_htlcs_forwardable_conditions {
1567 ($node: expr, $expected_failures: expr) => {
1568 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1573 macro_rules! expect_htlc_handling_failed_destinations {
1574 ($events: expr, $expected_failures: expr) => {{
1575 for event in $events {
1577 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1578 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1579 assert!($expected_failures.contains(&failed_next_destination))
1581 _ => panic!("Unexpected destination"),
1587 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1588 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1589 /// `expected_failures` set.
1590 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1592 Event::PendingHTLCsForwardable { .. } => { },
1593 _ => panic!("Unexpected event {:?}", events),
1596 let count = expected_failures.len() + 1;
1597 assert_eq!(events.len(), count);
1599 if expected_failures.len() > 0 {
1600 expect_htlc_handling_failed_destinations!(events, expected_failures)
1605 /// Clears (and ignores) a PendingHTLCsForwardable event
1607 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1609 macro_rules! expect_pending_htlcs_forwardable_ignore {
1611 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1616 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1618 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1619 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1620 ($node: expr, $expected_failures: expr) => {
1621 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1626 /// Handles a PendingHTLCsForwardable event
1627 macro_rules! expect_pending_htlcs_forwardable {
1629 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1630 $node.node.process_pending_htlc_forwards();
1632 // Ensure process_pending_htlc_forwards is idempotent.
1633 $node.node.process_pending_htlc_forwards();
1638 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1639 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1640 ($node: expr, $expected_failures: expr) => {{
1641 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1642 $node.node.process_pending_htlc_forwards();
1644 // Ensure process_pending_htlc_forwards is idempotent.
1645 $node.node.process_pending_htlc_forwards();
1650 macro_rules! expect_pending_htlcs_forwardable_from_events {
1651 ($node: expr, $events: expr, $ignore: expr) => {{
1652 assert_eq!($events.len(), 1);
1654 Event::PendingHTLCsForwardable { .. } => { },
1655 _ => panic!("Unexpected event"),
1658 $node.node.process_pending_htlc_forwards();
1660 // Ensure process_pending_htlc_forwards is idempotent.
1661 $node.node.process_pending_htlc_forwards();
1667 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1668 /// commitment update.
1669 macro_rules! commitment_signed_dance {
1670 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1671 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1673 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1674 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1676 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1678 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1679 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1680 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1681 check_added_monitors(&$node_a, 1);
1682 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1683 assert!(extra_msg_option.is_none());
1687 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1688 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1690 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1691 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1695 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1696 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1697 /// `revoke_and_ack` response to it.
1699 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1700 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1701 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1702 /// the commitment we're exchanging. `includes_claim` provides that information.
1704 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1705 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1706 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1707 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1708 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1712 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1713 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1714 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1716 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1717 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1718 check_added_monitors!(node_b, 0);
1719 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1720 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1721 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1722 check_added_monitors!(node_b, 1);
1723 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1724 let (bs_revoke_and_ack, extra_msg_option) = {
1725 let mut events = node_b.node.get_and_clear_pending_msg_events();
1726 assert!(events.len() <= 2);
1727 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1728 (match node_a_event {
1729 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1730 assert_eq!(*node_id, node_a.node.get_our_node_id());
1733 _ => panic!("Unexpected event"),
1734 }, events.get(0).map(|e| e.clone()))
1736 check_added_monitors!(node_b, 1);
1738 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1739 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1741 (extra_msg_option, bs_revoke_and_ack)
1744 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1745 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1747 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1748 /// on failure or that no new messages are left over on success.
1749 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1750 check_added_monitors!(node_a, 0);
1751 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1752 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1753 check_added_monitors!(node_a, 1);
1755 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1756 let got_claim = node_a.node.pending_events.lock().unwrap().iter().any(|(ev, action)| {
1757 let matching_action = if let Some(channelmanager::EventCompletionAction::ReleaseRAAChannelMonitorUpdate
1758 { channel_funding_outpoint, counterparty_node_id }) = action
1760 if channel_funding_outpoint.to_channel_id() == commitment_signed.channel_id {
1761 assert_eq!(*counterparty_node_id, node_b.node.get_our_node_id());
1765 if matching_action {
1766 if let Event::PaymentSent { .. } = ev {} else { panic!(); }
1770 if fail_backwards { assert!(!got_claim); }
1771 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1773 if skip_last_step { return; }
1776 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1777 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1778 check_added_monitors!(node_a, 1);
1780 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1781 let mut number_of_msg_events = 0;
1782 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1783 let peer_state = peer_state_mutex.lock().unwrap();
1784 let cp_pending_msg_events = &peer_state.pending_msg_events;
1785 number_of_msg_events += cp_pending_msg_events.len();
1786 if cp_pending_msg_events.len() == 1 {
1787 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1788 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1789 } else { panic!("Unexpected event"); }
1792 // Expecting the failure backwards event to the previous hop (not `node_b`)
1793 assert_eq!(number_of_msg_events, 1);
1795 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1799 /// Get a payment preimage and hash.
1800 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1801 let mut payment_count = recipient.network_payment_count.borrow_mut();
1802 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1803 *payment_count += 1;
1804 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1805 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1806 (payment_preimage, payment_hash, payment_secret)
1809 /// Get a payment preimage and hash.
1811 /// Don't use this, use the identically-named function instead.
1813 macro_rules! get_payment_preimage_hash {
1814 ($dest_node: expr) => {
1815 get_payment_preimage_hash!($dest_node, None)
1817 ($dest_node: expr, $min_value_msat: expr) => {
1818 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1820 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1821 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1825 /// Gets a route from the given sender to the node described in `payment_params`.
1826 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1827 let scorer = TestScorer::new();
1828 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1829 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1831 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1832 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1833 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1837 /// Gets a route from the given sender to the node described in `payment_params`.
1839 /// Don't use this, use the identically-named function instead.
1841 macro_rules! get_route {
1842 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1843 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1849 macro_rules! get_route_and_payment_hash {
1850 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1851 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1852 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1853 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1855 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1856 let (payment_preimage, payment_hash, payment_secret) =
1857 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1858 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1859 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1863 pub fn check_payment_claimable(
1864 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
1865 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
1866 expected_receiver_node_id: PublicKey,
1869 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1870 assert_eq!(expected_payment_hash, *payment_hash);
1871 assert_eq!(expected_recv_value, *amount_msat);
1872 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
1874 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1875 assert_eq!(&expected_payment_preimage, payment_preimage);
1876 assert_eq!(expected_payment_secret, *payment_secret);
1881 _ => panic!("Unexpected event"),
1886 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1887 macro_rules! expect_payment_claimable {
1888 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1889 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1891 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1892 let events = $node.node.get_and_clear_pending_events();
1893 assert_eq!(events.len(), 1);
1894 $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)
1899 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1900 macro_rules! expect_payment_claimed {
1901 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1902 let events = $node.node.get_and_clear_pending_events();
1903 assert_eq!(events.len(), 1);
1905 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1906 assert_eq!($expected_payment_hash, *payment_hash);
1907 assert_eq!($expected_recv_value, amount_msat);
1909 _ => panic!("Unexpected event"),
1914 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1915 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1916 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
1918 let events = node.node().get_and_clear_pending_events();
1919 let expected_payment_hash = PaymentHash(
1920 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1921 if expect_per_path_claims {
1922 assert!(events.len() > 1);
1924 assert_eq!(events.len(), 1);
1926 if expect_post_ev_mon_update {
1927 check_added_monitors(node, 1);
1929 let expected_payment_id = match events[0] {
1930 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1931 assert_eq!(expected_payment_preimage, *payment_preimage);
1932 assert_eq!(expected_payment_hash, *payment_hash);
1933 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1934 assert_eq!(*fee_paid_msat, expected_fee_msat);
1936 assert!(fee_paid_msat.is_some());
1940 _ => panic!("Unexpected event"),
1942 if expect_per_path_claims {
1943 for i in 1..events.len() {
1945 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1946 assert_eq!(payment_id, expected_payment_id);
1947 assert_eq!(payment_hash, Some(expected_payment_hash));
1949 _ => panic!("Unexpected event"),
1956 macro_rules! expect_payment_sent {
1957 ($node: expr, $expected_payment_preimage: expr) => {
1958 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1960 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1961 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1963 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1964 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1965 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
1971 macro_rules! expect_payment_path_successful {
1973 let events = $node.node.get_and_clear_pending_events();
1974 assert_eq!(events.len(), 1);
1976 $crate::events::Event::PaymentPathSuccessful { .. } => {},
1977 _ => panic!("Unexpected event"),
1982 macro_rules! expect_payment_forwarded {
1983 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1984 let events = $node.node.get_and_clear_pending_events();
1985 assert_eq!(events.len(), 1);
1987 Event::PaymentForwarded {
1988 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1989 outbound_amount_forwarded_msat: _
1991 assert_eq!(fee_earned_msat, $expected_fee);
1992 if fee_earned_msat.is_some() {
1993 // Is the event prev_channel_id in one of the channels between the two nodes?
1994 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()));
1996 // We check for force closures since a force closed channel is removed from the
1997 // node's channel list
1998 if !$downstream_force_closed {
1999 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()));
2001 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
2003 _ => panic!("Unexpected event"),
2010 macro_rules! expect_channel_shutdown_state {
2011 ($node: expr, $chan_id: expr, $state: path) => {
2012 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2013 assert_eq!(chan_details.len(), 1);
2014 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2018 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2019 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2020 let events = node.node.get_and_clear_pending_events();
2021 assert_eq!(events.len(), 1);
2023 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
2024 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2026 _ => panic!("Unexpected event"),
2030 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2031 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2032 let events = node.node.get_and_clear_pending_events();
2033 assert_eq!(events.len(), 1);
2035 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2036 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2038 _ => panic!("Unexpected event"),
2042 pub struct PaymentFailedConditions<'a> {
2043 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2044 pub(crate) expected_blamed_scid: Option<u64>,
2045 pub(crate) expected_blamed_chan_closed: Option<bool>,
2046 pub(crate) expected_mpp_parts_remain: bool,
2049 impl<'a> PaymentFailedConditions<'a> {
2050 pub fn new() -> Self {
2052 expected_htlc_error_data: None,
2053 expected_blamed_scid: None,
2054 expected_blamed_chan_closed: None,
2055 expected_mpp_parts_remain: false,
2058 pub fn mpp_parts_remain(mut self) -> Self {
2059 self.expected_mpp_parts_remain = true;
2062 pub fn blamed_scid(mut self, scid: u64) -> Self {
2063 self.expected_blamed_scid = Some(scid);
2066 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2067 self.expected_blamed_chan_closed = Some(closed);
2070 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2071 self.expected_htlc_error_data = Some((code, data));
2077 macro_rules! expect_payment_failed_with_update {
2078 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2079 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2080 &$node, $expected_payment_hash, $payment_failed_permanently,
2081 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2082 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2087 macro_rules! expect_payment_failed {
2088 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2089 #[allow(unused_mut)]
2090 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2092 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2094 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2098 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2099 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2100 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2102 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2103 let expected_payment_id = match &payment_failed_events[0] {
2104 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2108 error_data, .. } => {
2109 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2110 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2113 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2114 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2115 if let Some((code, data)) = conditions.expected_htlc_error_data {
2116 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2117 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2121 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2122 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2124 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2125 if let Some(scid) = conditions.expected_blamed_scid {
2126 assert_eq!(msg.contents.short_channel_id, scid);
2128 const CHAN_DISABLED_FLAG: u8 = 2;
2129 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2131 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2132 if let Some(scid) = conditions.expected_blamed_scid {
2133 assert_eq!(*short_channel_id, scid);
2135 assert!(is_permanent);
2137 _ => panic!("Unexpected update type"),
2139 } else { panic!("Expected network update"); }
2144 _ => panic!("Unexpected event"),
2146 if !conditions.expected_mpp_parts_remain {
2147 match &payment_failed_events[1] {
2148 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2149 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2150 assert_eq!(*payment_id, expected_payment_id);
2151 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2152 PaymentFailureReason::RecipientRejected
2154 PaymentFailureReason::RetriesExhausted
2157 _ => panic!("Unexpected second event"),
2162 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2163 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2164 conditions: PaymentFailedConditions<'e>
2166 let events = node.node.get_and_clear_pending_events();
2167 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2170 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 {
2171 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2172 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2173 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2174 check_added_monitors!(origin_node, expected_paths.len());
2175 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2179 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> {
2180 let mut payment_event = SendEvent::from_event(ev);
2181 let mut prev_node = origin_node;
2182 let mut event = None;
2184 for (idx, &node) in expected_path.iter().enumerate() {
2185 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2187 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2188 check_added_monitors!(node, 0);
2189 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2191 expect_pending_htlcs_forwardable!(node);
2193 if idx == expected_path.len() - 1 && clear_recipient_events {
2194 let events_2 = node.node.get_and_clear_pending_events();
2195 if payment_claimable_expected {
2196 assert_eq!(events_2.len(), 1);
2197 match &events_2[0] {
2198 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2199 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2200 claim_deadline, onion_fields, ..
2202 assert_eq!(our_payment_hash, *payment_hash);
2203 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2204 assert!(onion_fields.is_some());
2206 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2207 assert_eq!(expected_preimage, *payment_preimage);
2208 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2209 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2211 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2212 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2213 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2216 assert_eq!(*amount_msat, recv_value);
2217 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2218 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2219 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2221 _ => panic!("Unexpected event"),
2223 event = Some(events_2[0].clone());
2225 assert!(events_2.is_empty());
2227 } else if idx != expected_path.len() - 1 {
2228 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2229 assert_eq!(events_2.len(), 1);
2230 check_added_monitors!(node, 1);
2231 payment_event = SendEvent::from_event(events_2.remove(0));
2232 assert_eq!(payment_event.msgs.len(), 1);
2240 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> {
2241 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2244 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) {
2245 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2246 assert_eq!(events.len(), expected_route.len());
2247 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2248 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2249 // Once we've gotten through all the HTLCs, the last one should result in a
2250 // PaymentClaimable (but each previous one should not!), .
2251 let expect_payment = path_idx == expected_route.len() - 1;
2252 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2256 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) {
2257 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2258 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2259 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2262 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2263 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2264 our_payment_preimage: PaymentPreimage
2266 let extra_fees = vec![0; expected_paths.len()];
2267 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2268 &extra_fees[..], skip_last, our_payment_preimage)
2271 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2272 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2273 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2275 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2276 for path in expected_paths.iter() {
2277 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2279 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2280 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2283 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 {
2284 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2285 assert_eq!(claim_event.len(), 1);
2286 match claim_event[0] {
2287 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2288 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2289 assert_eq!(preimage, our_payment_preimage),
2290 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2291 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2295 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2297 let mut expected_total_fee_msat = 0;
2299 macro_rules! msgs_from_ev {
2302 &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 } } => {
2303 assert!(update_add_htlcs.is_empty());
2304 assert_eq!(update_fulfill_htlcs.len(), 1);
2305 assert!(update_fail_htlcs.is_empty());
2306 assert!(update_fail_malformed_htlcs.is_empty());
2307 assert!(update_fee.is_none());
2308 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2310 _ => panic!("Unexpected event"),
2314 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2315 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2316 assert_eq!(events.len(), expected_paths.len());
2318 if events.len() == 1 {
2319 per_path_msgs.push(msgs_from_ev!(&events[0]));
2321 for expected_path in expected_paths.iter() {
2322 // For MPP payments, we always want the message to the first node in the path.
2323 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2324 per_path_msgs.push(msgs_from_ev!(&ev));
2328 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2329 let mut next_msgs = Some(path_msgs);
2330 let mut expected_next_node = next_hop;
2332 macro_rules! last_update_fulfill_dance {
2333 ($node: expr, $prev_node: expr) => {
2335 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2336 check_added_monitors!($node, 0);
2337 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2338 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2342 macro_rules! mid_update_fulfill_dance {
2343 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2345 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2347 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2348 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2349 .unwrap().lock().unwrap();
2350 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2351 if let Some(prev_config) = channel.context.prev_config() {
2352 prev_config.forwarding_fee_base_msat
2354 channel.context.config().forwarding_fee_base_msat
2357 if $idx == 1 { fee += expected_extra_fees[i]; }
2358 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2359 expected_total_fee_msat += fee as u64;
2360 check_added_monitors!($node, 1);
2361 let new_next_msgs = if $new_msgs {
2362 let events = $node.node.get_and_clear_pending_msg_events();
2363 assert_eq!(events.len(), 1);
2364 let (res, nexthop) = msgs_from_ev!(&events[0]);
2365 expected_next_node = nexthop;
2368 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2371 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2372 next_msgs = new_next_msgs;
2377 let mut prev_node = expected_route.last().unwrap();
2378 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2379 assert_eq!(expected_next_node, node.node.get_our_node_id());
2380 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2381 if next_msgs.is_some() {
2382 // Since we are traversing in reverse, next_node is actually the previous node
2383 let next_node: &Node;
2384 if idx == expected_route.len() - 1 {
2385 next_node = origin_node;
2387 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2389 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2391 assert!(!update_next_msgs);
2392 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2394 if !skip_last && idx == expected_route.len() - 1 {
2395 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2402 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2406 // Ensure that claim_funds is idempotent.
2407 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2408 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2409 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2411 expected_total_fee_msat
2413 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) {
2414 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2416 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2420 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2421 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2424 pub const TEST_FINAL_CLTV: u32 = 70;
2426 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) {
2427 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2428 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2429 let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2430 assert_eq!(route.paths.len(), 1);
2431 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2432 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2433 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2436 let res = send_along_route(origin_node, route, expected_route, recv_value);
2437 (res.0, res.1, res.2)
2440 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2441 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2442 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2443 let network_graph = origin_node.network_graph.read_only();
2444 let scorer = test_utils::TestScorer::new();
2445 let seed = [0u8; 32];
2446 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2447 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2448 let route = router::get_route(
2449 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2450 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2451 assert_eq!(route.paths.len(), 1);
2452 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2453 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2454 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2457 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2458 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2459 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2460 true, APIError::ChannelUnavailable { ref err },
2461 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2464 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2465 let res = route_payment(&origin, expected_route, recv_value);
2466 claim_payment(&origin, expected_route, res.0);
2470 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) {
2471 for path in expected_paths.iter() {
2472 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2474 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2475 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2476 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2478 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2481 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) {
2482 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2483 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2485 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2486 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2487 assert_eq!(events.len(), expected_paths.len());
2488 for ev in events.iter() {
2489 let (update_fail, commitment_signed, node_id) = match ev {
2490 &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 } } => {
2491 assert!(update_add_htlcs.is_empty());
2492 assert!(update_fulfill_htlcs.is_empty());
2493 assert_eq!(update_fail_htlcs.len(), 1);
2494 assert!(update_fail_malformed_htlcs.is_empty());
2495 assert!(update_fee.is_none());
2496 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2498 _ => panic!("Unexpected event"),
2500 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2502 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2503 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()));
2505 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2506 let mut next_msgs = Some(path_msgs);
2507 let mut expected_next_node = next_hop;
2508 let mut prev_node = expected_route.last().unwrap();
2510 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2511 assert_eq!(expected_next_node, node.node.get_our_node_id());
2512 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2513 if next_msgs.is_some() {
2514 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2515 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2516 if !update_next_node {
2517 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 }]);
2520 let events = node.node.get_and_clear_pending_msg_events();
2521 if update_next_node {
2522 assert_eq!(events.len(), 1);
2524 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 } } => {
2525 assert!(update_add_htlcs.is_empty());
2526 assert!(update_fulfill_htlcs.is_empty());
2527 assert_eq!(update_fail_htlcs.len(), 1);
2528 assert!(update_fail_malformed_htlcs.is_empty());
2529 assert!(update_fee.is_none());
2530 expected_next_node = node_id.clone();
2531 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2533 _ => panic!("Unexpected event"),
2536 assert!(events.is_empty());
2538 if !skip_last && idx == expected_route.len() - 1 {
2539 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2546 let prev_node = expected_route.first().unwrap();
2547 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2548 check_added_monitors!(origin_node, 0);
2549 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2550 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2551 let events = origin_node.node.get_and_clear_pending_events();
2552 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2554 let expected_payment_id = match events[0] {
2555 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2556 assert_eq!(payment_hash, our_payment_hash);
2557 assert!(payment_failed_permanently);
2558 for (idx, hop) in expected_route.iter().enumerate() {
2559 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2563 _ => panic!("Unexpected event"),
2565 if i == expected_paths.len() - 1 {
2567 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2568 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2569 assert_eq!(*payment_id, expected_payment_id);
2570 assert_eq!(reason.unwrap(), expected_fail_reason);
2572 _ => panic!("Unexpected second event"),
2578 // Ensure that fail_htlc_backwards is idempotent.
2579 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2580 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2581 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2582 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2585 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2586 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2589 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2590 let mut chan_mon_cfgs = Vec::new();
2591 for i in 0..node_count {
2592 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2593 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2594 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2595 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2596 let persister = test_utils::TestPersister::new();
2597 let seed = [i as u8; 32];
2598 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2599 let scorer = Mutex::new(test_utils::TestScorer::new());
2601 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2607 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2608 let mut nodes = Vec::new();
2610 for i in 0..node_count {
2611 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, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
2612 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2613 let seed = [i as u8; 32];
2614 nodes.push(NodeCfg {
2615 chain_source: &chanmon_cfgs[i].chain_source,
2616 logger: &chanmon_cfgs[i].logger,
2617 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2618 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2619 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2621 keys_manager: &chanmon_cfgs[i].keys_manager,
2624 override_init_features: Rc::new(RefCell::new(None)),
2631 pub fn test_default_channel_config() -> UserConfig {
2632 let mut default_config = UserConfig::default();
2633 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2634 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2635 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2636 default_config.channel_handshake_config.announced_channel = true;
2637 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2638 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2639 // It now defaults to 1, so we simply set it to the expected value here.
2640 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2641 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2642 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2644 default_config.channel_config.max_dust_htlc_exposure =
2645 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2649 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>> {
2650 let mut chanmgrs = Vec::new();
2651 for i in 0..node_count {
2652 let network = Network::Testnet;
2653 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2654 let params = ChainParameters {
2656 best_block: BestBlock::from_network(network),
2658 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,
2659 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);
2660 chanmgrs.push(node);
2666 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>> {
2667 let mut nodes = Vec::new();
2668 let chan_count = Rc::new(RefCell::new(0));
2669 let payment_count = Rc::new(RefCell::new(0));
2670 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2672 for i in 0..node_count {
2673 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2674 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2676 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2677 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2678 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2679 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2680 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2681 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2682 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2683 connect_style: Rc::clone(&connect_style),
2684 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2685 wallet_source: Arc::clone(&wallet_source),
2686 bump_tx_handler: BumpTransactionEventHandler::new(
2687 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2688 &cfgs[i].keys_manager, cfgs[i].logger,
2693 for i in 0..node_count {
2694 for j in (i+1)..node_count {
2695 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2696 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2698 remote_network_address: None,
2700 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2701 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2703 remote_network_address: None,
2711 // Note that the following only works for CLTV values up to 128
2712 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2714 #[derive(PartialEq)]
2715 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2716 /// Tests that the given node has broadcast transactions for the given Channel
2718 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2719 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2720 /// broadcast and the revoked outputs were claimed.
2722 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2723 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2725 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2727 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2728 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2729 let mut txn_seen = HashSet::new();
2730 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2731 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2733 let mut res = Vec::with_capacity(2);
2734 node_txn.retain(|tx| {
2735 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2736 check_spends!(tx, chan.3);
2737 if commitment_tx.is_none() {
2738 res.push(tx.clone());
2743 if let Some(explicit_tx) = commitment_tx {
2744 res.push(explicit_tx.clone());
2747 assert_eq!(res.len(), 1);
2749 if has_htlc_tx != HTLCType::NONE {
2750 node_txn.retain(|tx| {
2751 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2752 check_spends!(tx, res[0]);
2753 if has_htlc_tx == HTLCType::TIMEOUT {
2754 assert!(tx.lock_time.0 != 0);
2756 assert!(tx.lock_time.0 == 0);
2758 res.push(tx.clone());
2762 assert!(res.len() == 2 || res.len() == 3);
2764 assert_eq!(res[1], res[2]);
2768 assert!(node_txn.is_empty());
2772 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2773 /// HTLC transaction.
2774 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2775 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2776 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2777 // for revoked htlc outputs
2778 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2779 node_txn.retain(|tx| {
2780 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2781 check_spends!(tx, revoked_tx);
2785 node_txn.retain(|tx| {
2786 check_spends!(tx, commitment_revoked_tx);
2789 assert!(node_txn.is_empty());
2792 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2793 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2794 let mut txn_seen = HashSet::new();
2795 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2797 let mut found_prev = false;
2798 for prev_tx in prev_txn {
2799 for tx in &*node_txn {
2800 if tx.input[0].previous_output.txid == prev_tx.txid() {
2801 check_spends!(tx, prev_tx);
2802 let mut iter = tx.input[0].witness.iter();
2803 iter.next().expect("expected 3 witness items");
2804 iter.next().expect("expected 3 witness items");
2805 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2806 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2813 assert!(found_prev);
2815 let mut res = Vec::new();
2816 mem::swap(&mut *node_txn, &mut res);
2820 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) {
2821 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2822 assert_eq!(events_1.len(), 2);
2823 let as_update = match events_1[0] {
2824 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2827 _ => panic!("Unexpected event"),
2830 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2831 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2832 assert_eq!(msg.data, expected_error);
2833 if needs_err_handle {
2834 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2837 _ => panic!("Unexpected event"),
2840 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2841 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2842 let bs_update = match events_2[0] {
2843 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2846 _ => panic!("Unexpected event"),
2848 if !needs_err_handle {
2850 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2851 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2852 assert_eq!(msg.data, expected_error);
2854 _ => panic!("Unexpected event"),
2859 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2860 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2864 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2865 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2869 macro_rules! get_channel_value_stat {
2870 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2871 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2872 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2873 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2874 chan.get_value_stat()
2878 macro_rules! get_chan_reestablish_msgs {
2879 ($src_node: expr, $dst_node: expr) => {
2881 let mut announcements = $crate::prelude::HashSet::new();
2882 let mut res = Vec::with_capacity(1);
2883 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2884 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2885 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2886 res.push(msg.clone());
2887 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2888 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2889 announcements.insert(msg.contents.short_channel_id);
2891 panic!("Unexpected event")
2894 assert!(announcements.is_empty());
2900 macro_rules! handle_chan_reestablish_msgs {
2901 ($src_node: expr, $dst_node: expr) => {
2903 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2905 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2907 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2913 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2915 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2918 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2919 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2920 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2922 had_channel_update = true;
2925 let mut revoke_and_ack = None;
2926 let mut commitment_update = None;
2927 let order = if let Some(ev) = msg_events.get(idx) {
2929 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2930 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2931 revoke_and_ack = Some(msg.clone());
2933 RAACommitmentOrder::RevokeAndACKFirst
2935 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2936 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2937 commitment_update = Some(updates.clone());
2939 RAACommitmentOrder::CommitmentFirst
2941 _ => RAACommitmentOrder::CommitmentFirst,
2944 RAACommitmentOrder::CommitmentFirst
2947 if let Some(ev) = msg_events.get(idx) {
2949 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2950 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2951 assert!(revoke_and_ack.is_none());
2952 revoke_and_ack = Some(msg.clone());
2955 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2956 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2957 assert!(commitment_update.is_none());
2958 commitment_update = Some(updates.clone());
2965 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2966 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2968 assert!(!had_channel_update);
2971 assert_eq!(msg_events.len(), idx);
2973 (channel_ready, revoke_and_ack, commitment_update, order)
2978 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
2979 pub node_a: &'a Node<'b, 'c, 'd>,
2980 pub node_b: &'a Node<'b, 'c, 'd>,
2981 pub send_channel_ready: (bool, bool),
2982 pub pending_htlc_adds: (i64, i64),
2983 pub pending_htlc_claims: (usize, usize),
2984 pub pending_htlc_fails: (usize, usize),
2985 pub pending_cell_htlc_claims: (usize, usize),
2986 pub pending_cell_htlc_fails: (usize, usize),
2987 pub pending_raa: (bool, bool),
2990 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
2991 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
2995 send_channel_ready: (false, false),
2996 pending_htlc_adds: (0, 0),
2997 pending_htlc_claims: (0, 0),
2998 pending_htlc_fails: (0, 0),
2999 pending_cell_htlc_claims: (0, 0),
3000 pending_cell_htlc_fails: (0, 0),
3001 pending_raa: (false, false),
3006 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3007 /// for claims/fails they are separated out.
3008 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3010 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3011 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa
3013 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3014 features: node_b.node.init_features(), networks: None, remote_network_address: None
3016 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3017 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3018 features: node_a.node.init_features(), networks: None, remote_network_address: None
3020 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3022 if send_channel_ready.0 {
3023 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3025 for reestablish in reestablish_1.iter() {
3026 assert_eq!(reestablish.next_remote_commitment_number, 0);
3029 if send_channel_ready.1 {
3030 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3032 for reestablish in reestablish_2.iter() {
3033 assert_eq!(reestablish.next_remote_commitment_number, 0);
3036 if send_channel_ready.0 || send_channel_ready.1 {
3037 // If we expect any channel_ready's, both sides better have set
3038 // next_holder_commitment_number to 1
3039 for reestablish in reestablish_1.iter() {
3040 assert_eq!(reestablish.next_local_commitment_number, 1);
3042 for reestablish in reestablish_2.iter() {
3043 assert_eq!(reestablish.next_local_commitment_number, 1);
3047 let mut resp_1 = Vec::new();
3048 for msg in reestablish_1 {
3049 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3050 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3052 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3053 check_added_monitors!(node_b, 1);
3055 check_added_monitors!(node_b, 0);
3058 let mut resp_2 = Vec::new();
3059 for msg in reestablish_2 {
3060 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3061 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3063 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3064 check_added_monitors!(node_a, 1);
3066 check_added_monitors!(node_a, 0);
3069 // We don't yet support both needing updates, as that would require a different commitment dance:
3070 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3071 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3072 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3073 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3075 for chan_msgs in resp_1.drain(..) {
3076 if send_channel_ready.0 {
3077 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3078 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3079 if !announcement_event.is_empty() {
3080 assert_eq!(announcement_event.len(), 1);
3081 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3082 //TODO: Test announcement_sigs re-sending
3083 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3086 assert!(chan_msgs.0.is_none());
3089 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3090 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3091 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3092 check_added_monitors!(node_a, 1);
3094 assert!(chan_msgs.1.is_none());
3096 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 {
3097 let commitment_update = chan_msgs.2.unwrap();
3098 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3099 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3101 assert!(commitment_update.update_add_htlcs.is_empty());
3103 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3104 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3105 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3106 for update_add in commitment_update.update_add_htlcs {
3107 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3109 for update_fulfill in commitment_update.update_fulfill_htlcs {
3110 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3112 for update_fail in commitment_update.update_fail_htlcs {
3113 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3116 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3117 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3119 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3120 check_added_monitors!(node_a, 1);
3121 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3122 // No commitment_signed so get_event_msg's assert(len == 1) passes
3123 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3124 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3125 check_added_monitors!(node_b, 1);
3128 assert!(chan_msgs.2.is_none());
3132 for chan_msgs in resp_2.drain(..) {
3133 if send_channel_ready.1 {
3134 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3135 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3136 if !announcement_event.is_empty() {
3137 assert_eq!(announcement_event.len(), 1);
3138 match announcement_event[0] {
3139 MessageSendEvent::SendChannelUpdate { .. } => {},
3140 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3141 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3145 assert!(chan_msgs.0.is_none());
3148 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3149 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3150 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3151 check_added_monitors!(node_b, 1);
3153 assert!(chan_msgs.1.is_none());
3155 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 {
3156 let commitment_update = chan_msgs.2.unwrap();
3157 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3158 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3160 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3161 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3162 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3163 for update_add in commitment_update.update_add_htlcs {
3164 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3166 for update_fulfill in commitment_update.update_fulfill_htlcs {
3167 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3169 for update_fail in commitment_update.update_fail_htlcs {
3170 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3173 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3174 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3176 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3177 check_added_monitors!(node_b, 1);
3178 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3179 // No commitment_signed so get_event_msg's assert(len == 1) passes
3180 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3181 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3182 check_added_monitors!(node_a, 1);
3185 assert!(chan_msgs.2.is_none());