1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch, chainmonitor::Persist};
14 use crate::sign::EntropySource;
15 use crate::chain::channelmonitor::ChannelMonitor;
16 use crate::chain::transaction::OutPoint;
17 use crate::events::{ClaimedHTLC, ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
18 use crate::events::bump_transaction::{BumpTransactionEvent, BumpTransactionEventHandler, Wallet, WalletSource};
19 use crate::ln::{ChannelId, PaymentPreimage, PaymentHash, PaymentSecret};
20 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
21 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
22 use crate::routing::router::{self, PaymentParameters, Route, RouteParameters};
23 use crate::ln::features::InitFeatures;
25 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
26 use crate::util::test_channel_signer::TestChannelSigner;
27 use crate::util::scid_utils;
28 use crate::util::test_utils;
29 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
30 use crate::util::errors::APIError;
31 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
32 use crate::util::ser::{ReadableArgs, Writeable};
34 use crate::util::logger::Logger;
36 use bitcoin::blockdata::block::{Block, BlockHeader};
37 use bitcoin::blockdata::transaction::{Transaction, TxOut};
38 use bitcoin::hash_types::BlockHash;
39 use bitcoin::hashes::sha256::Hash as Sha256;
40 use bitcoin::hashes::Hash as _;
41 use bitcoin::network::constants::Network;
42 use bitcoin::secp256k1::{PublicKey, SecretKey};
45 use crate::prelude::*;
46 use core::cell::RefCell;
48 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
50 use core::iter::repeat;
51 use bitcoin::{PackedLockTime, TxIn, TxMerkleNode};
53 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
55 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
56 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
58 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
59 /// output is the 1st output in the transaction.
60 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
61 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
62 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
65 /// Mine a single block containing the given transaction
67 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
68 /// output is the 1st output in the transaction.
69 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
70 let height = node.best_block_info().1 + 1;
71 confirm_transaction_at(node, tx, height)
73 /// Mine a single block containing the given transactions
74 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
75 let height = node.best_block_info().1 + 1;
76 confirm_transactions_at(node, txn, height);
78 /// Mine a single block containing the given transaction without extra consistency checks which may
79 /// impact ChannelManager state.
80 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
81 let height = node.best_block_info().1 + 1;
82 let mut block = Block {
83 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
86 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
87 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
89 block.txdata.push((*tx).clone());
90 do_connect_block_without_consistency_checks(node, block, false);
92 /// Mine the given transaction at the given height, mining blocks as required to build to that
95 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
96 /// output is the 1st output in the transaction.
97 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
98 let first_connect_height = node.best_block_info().1 + 1;
99 assert!(first_connect_height <= conf_height);
100 if conf_height > first_connect_height {
101 connect_blocks(node, conf_height - first_connect_height);
103 let mut txdata = Vec::new();
104 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
105 txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
108 txdata.push((*tx).clone());
110 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
111 connect_block(node, &block);
112 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
114 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
115 confirm_transactions_at(node, &[tx], conf_height)
118 /// The possible ways we may notify a ChannelManager of a new block
119 #[derive(Clone, Copy, Debug, PartialEq)]
120 pub enum ConnectStyle {
121 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
122 /// the header and height information.
124 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
125 /// make a single `best_block_updated` call.
126 BestBlockFirstSkippingBlocks,
127 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
128 /// `transaction_unconfirmed` is called.
129 BestBlockFirstReorgsOnlyTip,
130 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
131 /// the header and height information.
133 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
134 /// make a single `best_block_updated` call.
135 TransactionsFirstSkippingBlocks,
136 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
137 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
138 /// times to ensure it's idempotent.
139 TransactionsDuplicativelyFirstSkippingBlocks,
140 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
141 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
142 /// times to ensure it's idempotent.
143 HighlyRedundantTransactionsFirstSkippingBlocks,
144 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
145 /// `transaction_unconfirmed` is called.
146 TransactionsFirstReorgsOnlyTip,
147 /// Provides the full block via the `chain::Listen` interface. In the current code this is
148 /// equivalent to `TransactionsFirst` with some additional assertions.
153 pub fn skips_blocks(&self) -> bool {
155 ConnectStyle::BestBlockFirst => false,
156 ConnectStyle::BestBlockFirstSkippingBlocks => true,
157 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
158 ConnectStyle::TransactionsFirst => false,
159 ConnectStyle::TransactionsFirstSkippingBlocks => true,
160 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
161 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
162 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
163 ConnectStyle::FullBlockViaListen => false,
167 pub fn updates_best_block_first(&self) -> bool {
169 ConnectStyle::BestBlockFirst => true,
170 ConnectStyle::BestBlockFirstSkippingBlocks => true,
171 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
172 ConnectStyle::TransactionsFirst => false,
173 ConnectStyle::TransactionsFirstSkippingBlocks => false,
174 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
175 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
176 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
177 ConnectStyle::FullBlockViaListen => false,
181 fn random_style() -> ConnectStyle {
182 #[cfg(feature = "std")] {
183 use core::hash::{BuildHasher, Hasher};
184 // Get a random value using the only std API to do so - the DefaultHasher
185 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
186 let res = match rand_val % 9 {
187 0 => ConnectStyle::BestBlockFirst,
188 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
189 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
190 3 => ConnectStyle::TransactionsFirst,
191 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
192 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
193 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
194 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
195 8 => ConnectStyle::FullBlockViaListen,
198 eprintln!("Using Block Connection Style: {:?}", res);
201 #[cfg(not(feature = "std"))] {
202 ConnectStyle::FullBlockViaListen
207 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> BlockHeader {
209 version: 0x2000_0000,
211 merkle_root: TxMerkleNode::all_zeros(),
218 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
219 Block { header: create_dummy_header(prev_blockhash, time), txdata }
222 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
223 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
225 let height = node.best_block_info().1 + 1;
226 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
229 let prev_blockhash = block.header.block_hash();
230 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
231 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
233 let hash = block.header.block_hash();
234 do_connect_block_with_consistency_checks(node, block, false);
238 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
239 do_connect_block_with_consistency_checks(node, block.clone(), false);
242 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
243 // Ensure `get_claimable_balances`' self-tests never panic
244 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
245 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
249 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
250 call_claimable_balances(node);
251 do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
252 call_claimable_balances(node);
253 node.node.test_process_background_events();
256 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
257 let height = node.best_block_info().1 + 1;
258 #[cfg(feature = "std")] {
259 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
261 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
262 // transaction broadcast are correct.
263 node.blocks.lock().unwrap().push((block.clone(), height));
264 if !skip_intermediaries {
265 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
266 match *node.connect_style.borrow() {
267 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
268 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
269 call_claimable_balances(node);
270 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
271 node.node.best_block_updated(&block.header, height);
272 node.node.transactions_confirmed(&block.header, &txdata, height);
274 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
275 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
276 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
277 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
278 let mut connections = Vec::new();
279 for (block, height) in node.blocks.lock().unwrap().iter() {
280 if !block.txdata.is_empty() {
281 // Reconnect all transactions we've ever seen to ensure transaction connection
282 // is *really* idempotent. This is a somewhat likely deployment for some
283 // esplora implementations of chain sync which try to reduce state and
284 // complexity as much as possible.
286 // Sadly we have to clone the block here to maintain lockorder. In the
287 // future we should consider Arc'ing the blocks to avoid this.
288 connections.push((block.clone(), *height));
291 for (old_block, height) in connections {
292 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
293 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
296 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
297 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
298 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
300 call_claimable_balances(node);
301 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
302 node.node.transactions_confirmed(&block.header, &txdata, height);
303 node.node.best_block_updated(&block.header, height);
305 ConnectStyle::FullBlockViaListen => {
306 node.chain_monitor.chain_monitor.block_connected(&block, height);
307 node.node.block_connected(&block, height);
312 for tx in &block.txdata {
313 for input in &tx.input {
314 node.wallet_source.remove_utxo(input.previous_output);
316 let wallet_script = node.wallet_source.get_change_script().unwrap();
317 for (idx, output) in tx.output.iter().enumerate() {
318 if output.script_pubkey == wallet_script {
319 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
320 node.wallet_source.add_utxo(outpoint, output.value);
326 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
327 call_claimable_balances(node);
328 #[cfg(feature = "std")] {
329 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
332 let orig = node.blocks.lock().unwrap().pop().unwrap();
333 assert!(orig.1 > 0); // Cannot disconnect genesis
334 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
336 match *node.connect_style.borrow() {
337 ConnectStyle::FullBlockViaListen => {
338 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
339 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
341 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
342 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
344 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
345 node.node.best_block_updated(&prev.0.header, prev.1);
348 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
349 for tx in orig.0.txdata {
350 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
351 node.node.transaction_unconfirmed(&tx.txid());
355 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
356 node.node.best_block_updated(&prev.0.header, prev.1);
359 call_claimable_balances(node);
363 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
364 let count = node.blocks.lock().unwrap().len() as u32 - 1;
365 disconnect_blocks(node, count);
368 pub struct TestChanMonCfg {
369 pub tx_broadcaster: test_utils::TestBroadcaster,
370 pub fee_estimator: test_utils::TestFeeEstimator,
371 pub chain_source: test_utils::TestChainSource,
372 pub persister: test_utils::TestPersister,
373 pub logger: test_utils::TestLogger,
374 pub keys_manager: test_utils::TestKeysInterface,
375 pub scorer: RwLock<test_utils::TestScorer>,
378 pub struct NodeCfg<'a> {
379 pub chain_source: &'a test_utils::TestChainSource,
380 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
381 pub fee_estimator: &'a test_utils::TestFeeEstimator,
382 pub router: test_utils::TestRouter<'a>,
383 pub chain_monitor: test_utils::TestChainMonitor<'a>,
384 pub keys_manager: &'a test_utils::TestKeysInterface,
385 pub logger: &'a test_utils::TestLogger,
386 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
387 pub node_seed: [u8; 32],
388 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
391 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
392 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
393 &'chan_mon_cfg test_utils::TestBroadcaster,
394 &'node_cfg test_utils::TestKeysInterface,
395 &'node_cfg test_utils::TestKeysInterface,
396 &'node_cfg test_utils::TestKeysInterface,
397 &'chan_mon_cfg test_utils::TestFeeEstimator,
398 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
399 &'chan_mon_cfg test_utils::TestLogger,
402 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
403 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
404 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
405 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
406 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
407 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
408 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
409 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
410 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
411 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>,
412 pub node_seed: [u8; 32],
413 pub network_payment_count: Rc<RefCell<u8>>,
414 pub network_chan_count: Rc<RefCell<u32>>,
415 pub logger: &'chan_mon_cfg test_utils::TestLogger,
416 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
417 pub connect_style: Rc<RefCell<ConnectStyle>>,
418 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
419 pub wallet_source: Arc<test_utils::TestWalletSource>,
420 pub bump_tx_handler: BumpTransactionEventHandler<
421 &'chan_mon_cfg test_utils::TestBroadcaster,
422 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
423 &'chan_mon_cfg test_utils::TestKeysInterface,
424 &'chan_mon_cfg test_utils::TestLogger,
427 #[cfg(feature = "std")]
428 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
429 #[cfg(feature = "std")]
430 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
431 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
432 pub fn best_block_hash(&self) -> BlockHash {
433 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
435 pub fn best_block_info(&self) -> (BlockHash, u32) {
436 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
438 pub fn get_block_header(&self, height: u32) -> BlockHeader {
439 self.blocks.lock().unwrap()[height as usize].0.header
441 /// Changes the channel signer's availability for the specified peer and channel.
443 /// When `available` is set to `true`, the channel signer will behave normally. When set to
444 /// `false`, the channel signer will act like an off-line remote signer and will return `Err` for
445 /// several of the signing methods. Currently, only `get_per_commitment_point` and
446 /// `release_commitment_secret` are affected by this setting.
448 pub fn set_channel_signer_available(&self, peer_id: &PublicKey, chan_id: &ChannelId, available: bool) {
449 let per_peer_state = self.node.per_peer_state.read().unwrap();
450 let chan_lock = per_peer_state.get(peer_id).unwrap().lock().unwrap();
452 match chan_lock.channel_by_id.get(chan_id) {
453 Some(phase) => phase.context().get_signer(),
454 None => panic!("Couldn't find a channel with id {}", chan_id),
457 log_debug!(self.logger, "Setting channel signer for {} as available={}", chan_id, available);
458 signer.as_ecdsa().unwrap().set_available(available);
462 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
463 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
464 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
466 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
468 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
469 Self((node as *const Node<'a, 'b, 'c>).cast())
472 unsafe impl Send for NodePtr {}
473 unsafe impl Sync for NodePtr {}
476 pub trait NodeHolder {
477 type CM: AChannelManager;
478 fn node(&self) -> &ChannelManager<
479 <Self::CM as AChannelManager>::M,
480 <Self::CM as AChannelManager>::T,
481 <Self::CM as AChannelManager>::ES,
482 <Self::CM as AChannelManager>::NS,
483 <Self::CM as AChannelManager>::SP,
484 <Self::CM as AChannelManager>::F,
485 <Self::CM as AChannelManager>::R,
486 <Self::CM as AChannelManager>::L>;
487 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
489 impl<H: NodeHolder> NodeHolder for &H {
491 fn node(&self) -> &ChannelManager<
492 <Self::CM as AChannelManager>::M,
493 <Self::CM as AChannelManager>::T,
494 <Self::CM as AChannelManager>::ES,
495 <Self::CM as AChannelManager>::NS,
496 <Self::CM as AChannelManager>::SP,
497 <Self::CM as AChannelManager>::F,
498 <Self::CM as AChannelManager>::R,
499 <Self::CM as AChannelManager>::L> { (*self).node() }
500 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
502 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
503 type CM = TestChannelManager<'b, 'c>;
504 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
505 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
508 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
511 // Check that we processed all pending events
512 let msg_events = self.node.get_and_clear_pending_msg_events();
513 if !msg_events.is_empty() {
514 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
516 let events = self.node.get_and_clear_pending_events();
517 if !events.is_empty() {
518 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
520 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
521 if !added_monitors.is_empty() {
522 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
525 // Check that if we serialize the network graph, we can deserialize it again.
526 let network_graph = {
527 let mut w = test_utils::TestVecWriter(Vec::new());
528 self.network_graph.write(&mut w).unwrap();
529 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
530 assert!(network_graph_deser == *self.network_graph);
531 let gossip_sync = P2PGossipSync::new(
532 &network_graph_deser, Some(self.chain_source), self.logger
534 let mut chan_progress = 0;
536 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
537 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
538 assert!(orig_announcements == deserialized_announcements);
539 chan_progress = match orig_announcements {
540 Some(announcement) => announcement.0.contents.short_channel_id + 1,
544 let mut node_progress = None;
546 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
547 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
548 assert!(orig_announcements == deserialized_announcements);
549 node_progress = match orig_announcements {
550 Some(announcement) => Some(announcement.contents.node_id),
557 // Check that if we serialize and then deserialize all our channel monitors we get the
558 // same set of outputs to watch for on chain as we have now. Note that if we write
559 // tests that fully close channels and remove the monitors at some point this may break.
560 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
561 let mut deserialized_monitors = Vec::new();
563 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
564 let mut w = test_utils::TestVecWriter(Vec::new());
565 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
566 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
567 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
568 deserialized_monitors.push(deserialized_monitor);
572 let broadcaster = test_utils::TestBroadcaster {
573 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
574 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
577 // Before using all the new monitors to check the watch outpoints, use the full set of
578 // them to ensure we can write and reload our ChannelManager.
580 let mut channel_monitors = HashMap::new();
581 for monitor in deserialized_monitors.iter_mut() {
582 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
585 let scorer = RwLock::new(test_utils::TestScorer::new());
586 let mut w = test_utils::TestVecWriter(Vec::new());
587 self.node.write(&mut w).unwrap();
588 <(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 {
589 default_config: *self.node.get_current_default_configuration(),
590 entropy_source: self.keys_manager,
591 node_signer: self.keys_manager,
592 signer_provider: self.keys_manager,
593 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
594 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
595 chain_monitor: self.chain_monitor,
596 tx_broadcaster: &broadcaster,
597 logger: &self.logger,
602 let persister = test_utils::TestPersister::new();
603 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
604 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
605 for deserialized_monitor in deserialized_monitors.drain(..) {
606 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
610 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
611 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
616 pub fn create_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
617 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
620 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
621 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
622 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
623 (announcement, as_update, bs_update, channel_id, tx)
626 /// Gets an RAA and CS which were sent in response to a commitment update
627 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
628 let events = node.node().get_and_clear_pending_msg_events();
629 assert_eq!(events.len(), 2);
631 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
632 assert_eq!(node_id, recipient);
635 _ => panic!("Unexpected event"),
637 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
638 assert_eq!(node_id, recipient);
639 assert!(updates.update_add_htlcs.is_empty());
640 assert!(updates.update_fulfill_htlcs.is_empty());
641 assert!(updates.update_fail_htlcs.is_empty());
642 assert!(updates.update_fail_malformed_htlcs.is_empty());
643 assert!(updates.update_fee.is_none());
644 updates.commitment_signed.clone()
646 _ => panic!("Unexpected event"),
651 /// Gets an RAA and CS which were sent in response to a commitment update
653 /// Don't use this, use the identically-named function instead.
654 macro_rules! get_revoke_commit_msgs {
655 ($node: expr, $node_id: expr) => {
656 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
660 /// Get an specific event message from the pending events queue.
662 macro_rules! get_event_msg {
663 ($node: expr, $event_type: path, $node_id: expr) => {
665 let events = $node.node.get_and_clear_pending_msg_events();
666 assert_eq!(events.len(), 1);
668 $event_type { ref node_id, ref msg } => {
669 assert_eq!(*node_id, $node_id);
672 _ => panic!("Unexpected event"),
678 /// Get an error message from the pending events queue.
679 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
680 let events = node.node.get_and_clear_pending_msg_events();
681 assert_eq!(events.len(), 1);
683 MessageSendEvent::HandleError {
684 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
686 assert_eq!(node_id, recipient);
689 MessageSendEvent::HandleError {
690 action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
692 assert_eq!(node_id, recipient);
693 msg.as_ref().unwrap().clone()
695 _ => panic!("Unexpected event"),
699 /// Get a specific event from the pending events queue.
701 macro_rules! get_event {
702 ($node: expr, $event_type: path) => {
704 let mut events = $node.node.get_and_clear_pending_events();
705 assert_eq!(events.len(), 1);
706 let ev = events.pop().unwrap();
708 $event_type { .. } => {
711 _ => panic!("Unexpected event"),
717 /// Gets an UpdateHTLCs MessageSendEvent
718 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
719 let events = node.node.get_and_clear_pending_msg_events();
720 assert_eq!(events.len(), 1);
722 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
723 assert_eq!(node_id, recipient);
726 _ => panic!("Unexpected event"),
731 /// Gets an UpdateHTLCs MessageSendEvent
733 /// Don't use this, use the identically-named function instead.
734 macro_rules! get_htlc_update_msgs {
735 ($node: expr, $node_id: expr) => {
736 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
740 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
741 /// Returns the `msg_event`.
743 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
744 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
745 /// such messages are intended to all peers.
746 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
747 let ev_index = msg_events.iter().position(|e| { match e {
748 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
749 node_id == msg_node_id
751 MessageSendEvent::SendOpenChannel { node_id, .. } => {
752 node_id == msg_node_id
754 MessageSendEvent::SendFundingCreated { node_id, .. } => {
755 node_id == msg_node_id
757 MessageSendEvent::SendFundingSigned { node_id, .. } => {
758 node_id == msg_node_id
760 MessageSendEvent::SendChannelReady { node_id, .. } => {
761 node_id == msg_node_id
763 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
764 node_id == msg_node_id
766 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
767 node_id == msg_node_id
769 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
770 node_id == msg_node_id
772 MessageSendEvent::SendClosingSigned { node_id, .. } => {
773 node_id == msg_node_id
775 MessageSendEvent::SendShutdown { node_id, .. } => {
776 node_id == msg_node_id
778 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
779 node_id == msg_node_id
781 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
782 node_id == msg_node_id
784 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
787 MessageSendEvent::BroadcastChannelUpdate { .. } => {
790 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
793 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
794 node_id == msg_node_id
796 MessageSendEvent::HandleError { node_id, .. } => {
797 node_id == msg_node_id
799 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
800 node_id == msg_node_id
802 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
803 node_id == msg_node_id
805 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
806 node_id == msg_node_id
808 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
809 node_id == msg_node_id
811 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
812 node_id == msg_node_id
814 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
815 node_id == msg_node_id
817 MessageSendEvent::SendStfu { node_id, .. } => {
818 node_id == msg_node_id
820 MessageSendEvent::SendSplice { node_id, .. } => {
821 node_id == msg_node_id
823 MessageSendEvent::SendSpliceAck { node_id, .. } => {
824 node_id == msg_node_id
826 MessageSendEvent::SendSpliceLocked { node_id, .. } => {
827 node_id == msg_node_id
829 MessageSendEvent::SendTxAddInput { node_id, .. } => {
830 node_id == msg_node_id
832 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
833 node_id == msg_node_id
835 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
836 node_id == msg_node_id
838 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
839 node_id == msg_node_id
841 MessageSendEvent::SendTxComplete { node_id, .. } => {
842 node_id == msg_node_id
844 MessageSendEvent::SendTxSignatures { node_id, .. } => {
845 node_id == msg_node_id
847 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
848 node_id == msg_node_id
850 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
851 node_id == msg_node_id
853 MessageSendEvent::SendTxAbort { node_id, .. } => {
854 node_id == msg_node_id
857 if ev_index.is_some() {
858 msg_events.remove(ev_index.unwrap())
860 panic!("Couldn't find any MessageSendEvent to the node!")
865 macro_rules! get_channel_ref {
866 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
868 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
869 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
870 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
876 macro_rules! get_feerate {
877 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
879 let mut per_peer_state_lock;
880 let mut peer_state_lock;
881 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
882 phase.context().get_feerate_sat_per_1000_weight()
888 macro_rules! get_channel_type_features {
889 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
891 let mut per_peer_state_lock;
892 let mut peer_state_lock;
893 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
894 chan.context().get_channel_type().clone()
899 /// Returns a channel monitor given a channel id, making some naive assumptions
901 macro_rules! get_monitor {
902 ($node: expr, $channel_id: expr) => {
904 use bitcoin::hashes::Hash;
905 let mut monitor = None;
906 // Assume funding vout is either 0 or 1 blindly
908 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
909 $crate::chain::transaction::OutPoint {
910 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
922 /// Returns any local commitment transactions for the channel.
924 macro_rules! get_local_commitment_txn {
925 ($node: expr, $channel_id: expr) => {
927 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
932 /// Check the error from attempting a payment.
934 macro_rules! unwrap_send_err {
935 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
937 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
938 assert_eq!(fails.len(), 1);
944 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
945 assert_eq!(results.len(), 1);
947 Err($type) => { $check },
951 &Err(PaymentSendFailure::PathParameterError(ref result)) if !$all_failed => {
952 assert_eq!(result.len(), 1);
954 Err($type) => { $check },
963 /// Check whether N channel monitor(s) have been added.
964 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
965 if let Some(chain_monitor) = node.chain_monitor() {
966 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
967 let n = added_monitors.len();
968 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
969 added_monitors.clear();
973 /// Check whether N channel monitor(s) have been added.
975 /// Don't use this, use the identically-named function instead.
977 macro_rules! check_added_monitors {
978 ($node: expr, $count: expr) => {
979 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
983 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
985 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
986 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
987 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
988 let mut nodes = path.iter().rev();
989 let dest = nodes.next().expect("path should have a destination").node;
990 let prev = nodes.next().unwrap_or(&origin_node).node;
991 let dest_channels = dest.list_channels();
992 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
993 .expect("HTLC's channel should be one of destination node's channels");
994 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
995 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
998 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> {
999 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1000 for encoded in monitors_encoded {
1001 let mut monitor_read = &encoded[..];
1002 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1003 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1004 assert!(monitor_read.is_empty());
1005 monitors_read.push(monitor);
1008 let mut node_read = &chanman_encoded[..];
1009 let (_, node_deserialized) = {
1010 let mut channel_monitors = HashMap::new();
1011 for monitor in monitors_read.iter_mut() {
1012 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1014 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1016 entropy_source: node.keys_manager,
1017 node_signer: node.keys_manager,
1018 signer_provider: node.keys_manager,
1019 fee_estimator: node.fee_estimator,
1020 router: node.router,
1021 chain_monitor: node.chain_monitor,
1022 tx_broadcaster: node.tx_broadcaster,
1023 logger: node.logger,
1027 assert!(node_read.is_empty());
1029 for monitor in monitors_read.drain(..) {
1030 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
1031 Ok(ChannelMonitorUpdateStatus::Completed));
1032 check_added_monitors!(node, 1);
1039 macro_rules! reload_node {
1040 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1041 let chanman_encoded = $chanman_encoded;
1043 $persister = test_utils::TestPersister::new();
1044 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1045 $node.chain_monitor = &$new_chain_monitor;
1047 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1048 $node.node = &$new_channelmanager;
1050 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1051 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1055 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1056 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1057 -> (ChannelId, Transaction, OutPoint)
1059 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1062 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1063 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1064 -> (ChannelId, Transaction, OutPoint)
1066 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1069 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1070 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1071 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1072 let chan_id = *node.network_chan_count.borrow();
1074 let events = node.node.get_and_clear_pending_events();
1075 assert_eq!(events.len(), 1);
1077 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1078 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1079 assert_eq!(*channel_value_satoshis, expected_chan_value);
1080 assert_eq!(user_channel_id, expected_user_chan_id);
1082 let input = if coinbase {
1084 previous_output: bitcoin::OutPoint::null(),
1085 ..Default::default()
1091 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input, output: vec![TxOut {
1092 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1094 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1095 (*temporary_channel_id, tx, funding_outpoint)
1097 _ => panic!("Unexpected event"),
1101 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: ChannelId) -> Transaction {
1102 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1103 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1105 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1106 check_added_monitors!(node_a, 0);
1108 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1109 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1110 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1112 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1113 assert_eq!(added_monitors.len(), 1);
1114 assert_eq!(added_monitors[0].0, funding_output);
1115 added_monitors.clear();
1117 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1119 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()));
1121 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1122 assert_eq!(added_monitors.len(), 1);
1123 assert_eq!(added_monitors[0].0, funding_output);
1124 added_monitors.clear();
1126 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1128 let events_4 = node_a.node.get_and_clear_pending_events();
1129 assert_eq!(events_4.len(), 0);
1131 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1132 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1133 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1135 // Ensure that funding_transaction_generated is idempotent.
1136 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1137 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1138 check_added_monitors!(node_a, 0);
1143 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1144 pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, receiver: &'a Node<'b, 'c, 'd>, initiator_config: Option<UserConfig>) -> (bitcoin::Transaction, ChannelId) {
1145 let initiator_channels = initiator.node.list_usable_channels().len();
1146 let receiver_channels = receiver.node.list_usable_channels().len();
1148 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1149 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1151 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1152 let events = receiver.node.get_and_clear_pending_events();
1153 assert_eq!(events.len(), 1);
1155 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1156 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1158 _ => panic!("Unexpected event"),
1161 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1162 assert_eq!(accept_channel.minimum_depth, 0);
1163 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1165 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1166 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1167 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1169 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1170 check_added_monitors!(receiver, 1);
1171 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1172 assert_eq!(bs_signed_locked.len(), 2);
1173 let as_channel_ready;
1174 match &bs_signed_locked[0] {
1175 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1176 assert_eq!(*node_id, initiator.node.get_our_node_id());
1177 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1178 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1179 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1180 check_added_monitors!(initiator, 1);
1182 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1183 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1185 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1187 _ => panic!("Unexpected event"),
1189 match &bs_signed_locked[1] {
1190 MessageSendEvent::SendChannelReady { node_id, msg } => {
1191 assert_eq!(*node_id, initiator.node.get_our_node_id());
1192 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1193 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1195 _ => panic!("Unexpected event"),
1198 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1199 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1201 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1202 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1204 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1205 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1207 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1208 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1210 (tx, as_channel_ready.channel_id)
1213 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 {
1214 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1215 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1216 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1217 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1218 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1219 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1220 let events = node_b.node.get_and_clear_pending_events();
1221 assert_eq!(events.len(), 1);
1223 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1224 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1225 _ => panic!("Unexpected event"),
1228 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1229 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1230 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1231 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1233 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1236 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) {
1237 confirm_transaction_at(node_conf, tx, conf_height);
1238 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1239 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()));
1242 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b, 'c>(node_recv: &Node<'a, 'b, 'c>, node_conf: &Node<'a, 'b, 'c>) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId) {
1244 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1245 assert_eq!(events_6.len(), 3);
1246 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1247 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1249 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1250 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1252 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1253 ((match events_6[0] {
1254 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1255 channel_id = msg.channel_id.clone();
1256 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1259 _ => panic!("Unexpected event"),
1260 }, match events_6[announcement_sigs_idx] {
1261 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1262 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1265 _ => panic!("Unexpected event"),
1269 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId) {
1270 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1271 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1272 confirm_transaction_at(node_a, tx, conf_height);
1273 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1274 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1275 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1278 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c: 'd, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), ChannelId, Transaction) {
1279 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1280 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1284 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) {
1285 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1286 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1287 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1289 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1290 assert_eq!(events_7.len(), 1);
1291 let (announcement, bs_update) = match events_7[0] {
1292 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1293 (msg, update_msg.clone().unwrap())
1295 _ => panic!("Unexpected event"),
1298 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1299 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1300 assert_eq!(events_8.len(), 1);
1301 let as_update = match events_8[0] {
1302 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1303 assert!(*announcement == *msg);
1304 let update_msg = update_msg.clone().unwrap();
1305 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1306 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1309 _ => panic!("Unexpected event"),
1312 *node_a.network_chan_count.borrow_mut() += 1;
1314 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1315 ((*announcement).clone(), as_update, bs_update)
1318 pub fn create_announced_chan_between_nodes<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1319 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1322 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c: 'd, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction) {
1323 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1324 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1325 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1328 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) {
1329 let mut no_announce_cfg = test_default_channel_config();
1330 no_announce_cfg.channel_handshake_config.announced_channel = false;
1331 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1332 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1333 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1334 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1335 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1337 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1338 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1339 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()));
1340 check_added_monitors!(nodes[b], 1);
1342 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1343 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1345 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1346 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1347 check_added_monitors!(nodes[a], 1);
1349 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1350 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1351 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1353 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1354 confirm_transaction_at(&nodes[a], &tx, conf_height);
1355 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1356 confirm_transaction_at(&nodes[b], &tx, conf_height);
1357 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1358 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1359 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()));
1360 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1361 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1362 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1363 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1364 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1366 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1367 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1369 let mut found_a = false;
1370 for chan in nodes[a].node.list_usable_channels() {
1371 if chan.channel_id == as_channel_ready.channel_id {
1374 assert!(!chan.is_public);
1379 let mut found_b = false;
1380 for chan in nodes[b].node.list_usable_channels() {
1381 if chan.channel_id == as_channel_ready.channel_id {
1384 assert!(!chan.is_public);
1389 (as_channel_ready, tx)
1392 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) {
1394 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1395 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1396 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1398 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1399 // forwarding info for local channels even if its not accepted in the network graph.
1400 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1401 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1405 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1406 for outp in tx.output.iter() {
1407 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1409 let mut total_value_in = 0;
1410 for input in tx.input.iter() {
1411 total_value_in += get_output(&input.previous_output).unwrap().value;
1413 let mut total_value_out = 0;
1414 for output in tx.output.iter() {
1415 total_value_out += output.value;
1417 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1418 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1419 assert!(total_value_out + min_fee <= total_value_in);
1420 tx.verify(get_output).unwrap();
1424 macro_rules! check_spends {
1425 ($tx: expr, $($spends_txn: expr),*) => {
1428 for outp in $spends_txn.output.iter() {
1429 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1432 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1434 if out_point.txid == $spends_txn.txid() {
1435 return $spends_txn.output.get(out_point.vout as usize).cloned()
1440 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1445 macro_rules! get_closing_signed_broadcast {
1446 ($node: expr, $dest_pubkey: expr) => {
1448 let events = $node.get_and_clear_pending_msg_events();
1449 assert!(events.len() == 1 || events.len() == 2);
1450 (match events[events.len() - 1] {
1451 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1452 assert_eq!(msg.contents.flags & 2, 2);
1455 _ => panic!("Unexpected event"),
1456 }, if events.len() == 2 {
1458 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1459 assert_eq!(*node_id, $dest_pubkey);
1462 _ => panic!("Unexpected event"),
1470 macro_rules! check_warn_msg {
1471 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1472 let msg_events = $node.node.get_and_clear_pending_msg_events();
1473 assert_eq!(msg_events.len(), 1);
1474 match msg_events[0] {
1475 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1476 assert_eq!(node_id, $recipient_node_id);
1477 assert_eq!(msg.channel_id, $chan_id);
1480 _ => panic!("Unexpected event"),
1485 /// Check that a channel's closing channel update has been broadcasted, and optionally
1486 /// check whether an error message event has occurred.
1487 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1488 let msg_events = node.node.get_and_clear_pending_msg_events();
1489 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1490 msg_events.into_iter().filter_map(|msg_event| {
1492 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1493 assert_eq!(msg.contents.flags & 2, 2);
1496 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1497 assert!(with_error_msg);
1498 // TODO: Check node_id
1501 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1502 assert!(with_error_msg);
1503 // TODO: Check node_id
1506 _ => panic!("Unexpected event"),
1511 /// Check that a channel's closing channel update has been broadcasted, and optionally
1512 /// check whether an error message event has occurred.
1514 /// Don't use this, use the identically-named function instead.
1516 macro_rules! check_closed_broadcast {
1517 ($node: expr, $with_error_msg: expr) => {
1518 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1523 pub struct ExpectedCloseEvent {
1524 pub channel_capacity_sats: Option<u64>,
1525 pub channel_id: Option<ChannelId>,
1526 pub counterparty_node_id: Option<PublicKey>,
1527 pub discard_funding: bool,
1528 pub reason: Option<ClosureReason>,
1531 /// Check that multiple channel closing events have been issued.
1532 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1533 let closed_events_count = expected_close_events.len();
1534 let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1535 let events = node.node.get_and_clear_pending_events();
1536 assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1537 for expected_event in expected_close_events {
1538 assert!(events.iter().any(|e| matches!(
1540 Event::ChannelClosed {
1543 counterparty_node_id,
1544 channel_capacity_sats,
1547 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1548 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1549 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1550 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
1554 assert_eq!(events.iter().filter(|e| matches!(
1556 Event::DiscardFunding { .. },
1557 )).count(), discard_events_count);
1560 /// Check that a channel's closing channel events has been issued
1561 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1562 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1563 let expected_events_count = if is_check_discard_funding {
1564 2 * expected_counterparty_node_ids.len()
1566 expected_counterparty_node_ids.len()
1568 assert_eq!(events_count, expected_events_count);
1569 let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1570 channel_capacity_sats: Some(expected_channel_capacity),
1572 counterparty_node_id: Some(*node_id),
1573 discard_funding: is_check_discard_funding,
1574 reason: Some(expected_reason.clone()),
1575 }).collect::<Vec<_>>();
1576 check_closed_events(node, expected_close_events.as_slice());
1579 /// Check that a channel's closing channel events has been issued
1581 /// Don't use this, use the identically-named function instead.
1583 macro_rules! check_closed_event {
1584 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1585 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1587 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1588 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1589 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1593 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1594 let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1595 assert_eq!(events.len(), count);
1596 for event in events {
1598 Event::BumpTransaction(bump_event) => {
1599 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1601 node.bump_tx_handler.handle_event(&bump_event);
1608 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &ChannelId, funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
1609 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) };
1610 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) };
1613 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1614 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1616 let events_1 = node_b.get_and_clear_pending_msg_events();
1617 assert!(events_1.len() >= 1);
1618 let shutdown_b = match events_1[0] {
1619 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1620 assert_eq!(node_id, &node_a.get_our_node_id());
1623 _ => panic!("Unexpected event"),
1626 let closing_signed_b = if !close_inbound_first {
1627 assert_eq!(events_1.len(), 1);
1630 Some(match events_1[1] {
1631 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1632 assert_eq!(node_id, &node_a.get_our_node_id());
1635 _ => panic!("Unexpected event"),
1639 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1640 let (as_update, bs_update) = if close_inbound_first {
1641 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1642 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1644 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1645 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1646 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1647 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1649 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1650 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1651 assert!(none_a.is_none());
1652 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1653 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1654 (as_update, bs_update)
1656 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1658 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1659 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1661 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1662 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1663 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1665 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1666 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1667 assert!(none_b.is_none());
1668 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1669 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1670 (as_update, bs_update)
1672 assert_eq!(tx_a, tx_b);
1673 check_spends!(tx_a, funding_tx);
1675 (as_update, bs_update, tx_a)
1678 pub struct SendEvent {
1679 pub node_id: PublicKey,
1680 pub msgs: Vec<msgs::UpdateAddHTLC>,
1681 pub commitment_msg: msgs::CommitmentSigned,
1684 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1685 assert!(updates.update_fulfill_htlcs.is_empty());
1686 assert!(updates.update_fail_htlcs.is_empty());
1687 assert!(updates.update_fail_malformed_htlcs.is_empty());
1688 assert!(updates.update_fee.is_none());
1689 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1692 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1694 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1695 _ => panic!("Unexpected event type!"),
1699 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1700 let mut events = node.node.get_and_clear_pending_msg_events();
1701 assert_eq!(events.len(), 1);
1702 SendEvent::from_event(events.pop().unwrap())
1707 /// Don't use this, use the identically-named function instead.
1708 macro_rules! expect_pending_htlcs_forwardable_conditions {
1709 ($node: expr, $expected_failures: expr) => {
1710 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1715 macro_rules! expect_htlc_handling_failed_destinations {
1716 ($events: expr, $expected_failures: expr) => {{
1717 for event in $events {
1719 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1720 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1721 assert!($expected_failures.contains(&failed_next_destination))
1723 _ => panic!("Unexpected destination"),
1729 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1730 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1731 /// `expected_failures` set.
1732 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1734 Event::PendingHTLCsForwardable { .. } => { },
1735 _ => panic!("Unexpected event {:?}", events),
1738 let count = expected_failures.len() + 1;
1739 assert_eq!(events.len(), count);
1741 if expected_failures.len() > 0 {
1742 expect_htlc_handling_failed_destinations!(events, expected_failures)
1747 /// Clears (and ignores) a PendingHTLCsForwardable event
1749 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1751 macro_rules! expect_pending_htlcs_forwardable_ignore {
1753 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1758 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1760 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1761 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1762 ($node: expr, $expected_failures: expr) => {
1763 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1768 /// Handles a PendingHTLCsForwardable event
1769 macro_rules! expect_pending_htlcs_forwardable {
1771 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1772 $node.node.process_pending_htlc_forwards();
1774 // Ensure process_pending_htlc_forwards is idempotent.
1775 $node.node.process_pending_htlc_forwards();
1780 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1781 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1782 ($node: expr, $expected_failures: expr) => {{
1783 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1784 $node.node.process_pending_htlc_forwards();
1786 // Ensure process_pending_htlc_forwards is idempotent.
1787 $node.node.process_pending_htlc_forwards();
1792 macro_rules! expect_pending_htlcs_forwardable_from_events {
1793 ($node: expr, $events: expr, $ignore: expr) => {{
1794 assert_eq!($events.len(), 1);
1796 Event::PendingHTLCsForwardable { .. } => { },
1797 _ => panic!("Unexpected event"),
1800 $node.node.process_pending_htlc_forwards();
1802 // Ensure process_pending_htlc_forwards is idempotent.
1803 $node.node.process_pending_htlc_forwards();
1809 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1810 /// commitment update.
1811 macro_rules! commitment_signed_dance {
1812 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1813 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1815 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1816 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1818 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1820 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1821 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1822 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1823 check_added_monitors(&$node_a, 1);
1824 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1825 assert!(extra_msg_option.is_none());
1829 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1830 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1832 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1833 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1837 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1838 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1839 /// `revoke_and_ack` response to it.
1841 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1842 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1843 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1844 /// the commitment we're exchanging. `includes_claim` provides that information.
1846 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1847 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1848 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1849 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1850 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1854 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1855 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1856 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1858 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1859 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1860 check_added_monitors!(node_b, 0);
1861 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1862 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1863 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1864 check_added_monitors!(node_b, 1);
1865 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1866 let (bs_revoke_and_ack, extra_msg_option) = {
1867 let mut events = node_b.node.get_and_clear_pending_msg_events();
1868 assert!(events.len() <= 2);
1869 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1870 (match node_a_event {
1871 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1872 assert_eq!(*node_id, node_a.node.get_our_node_id());
1875 _ => panic!("Unexpected event"),
1876 }, events.get(0).map(|e| e.clone()))
1878 check_added_monitors!(node_b, 1);
1880 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1881 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1883 (extra_msg_option, bs_revoke_and_ack)
1886 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1887 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1889 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1890 /// on failure or that no new messages are left over on success.
1891 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1892 check_added_monitors!(node_a, 0);
1893 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1894 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1895 check_added_monitors!(node_a, 1);
1897 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1898 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1899 if fail_backwards { assert!(!got_claim); }
1900 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1902 if skip_last_step { return; }
1905 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1906 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1907 check_added_monitors!(node_a, 1);
1909 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1910 let mut number_of_msg_events = 0;
1911 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1912 let peer_state = peer_state_mutex.lock().unwrap();
1913 let cp_pending_msg_events = &peer_state.pending_msg_events;
1914 number_of_msg_events += cp_pending_msg_events.len();
1915 if cp_pending_msg_events.len() == 1 {
1916 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1917 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1918 } else { panic!("Unexpected event"); }
1921 // Expecting the failure backwards event to the previous hop (not `node_b`)
1922 assert_eq!(number_of_msg_events, 1);
1924 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1928 /// Get a payment preimage and hash.
1929 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1930 let mut payment_count = recipient.network_payment_count.borrow_mut();
1931 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1932 *payment_count += 1;
1933 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1934 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1935 (payment_preimage, payment_hash, payment_secret)
1938 /// Get a payment preimage and hash.
1940 /// Don't use this, use the identically-named function instead.
1942 macro_rules! get_payment_preimage_hash {
1943 ($dest_node: expr) => {
1944 get_payment_preimage_hash!($dest_node, None)
1946 ($dest_node: expr, $min_value_msat: expr) => {
1947 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1949 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1950 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1954 /// Gets a route from the given sender to the node described in `payment_params`.
1955 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1956 let scorer = TestScorer::new();
1957 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1958 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1960 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1961 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1962 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
1966 /// Gets a route from the given sender to the node described in `payment_params`.
1968 /// Don't use this, use the identically-named function instead.
1970 macro_rules! get_route {
1971 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1972 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1973 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1979 macro_rules! get_route_and_payment_hash {
1980 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1981 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1982 .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
1983 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1985 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1986 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
1988 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
1989 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1990 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
1991 let (payment_preimage, payment_hash, payment_secret) =
1992 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1993 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
1994 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1998 pub fn check_payment_claimable(
1999 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2000 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2001 expected_receiver_node_id: PublicKey,
2004 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2005 assert_eq!(expected_payment_hash, *payment_hash);
2006 assert_eq!(expected_recv_value, *amount_msat);
2007 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2009 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2010 assert_eq!(&expected_payment_preimage, payment_preimage);
2011 assert_eq!(expected_payment_secret, *payment_secret);
2016 _ => panic!("Unexpected event"),
2021 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2022 macro_rules! expect_payment_claimable {
2023 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2024 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2026 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2027 let events = $node.node.get_and_clear_pending_events();
2028 assert_eq!(events.len(), 1);
2029 $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)
2034 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2035 macro_rules! expect_payment_claimed {
2036 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2037 let events = $node.node.get_and_clear_pending_events();
2038 assert_eq!(events.len(), 1);
2040 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2041 assert_eq!($expected_payment_hash, *payment_hash);
2042 assert_eq!($expected_recv_value, amount_msat);
2044 _ => panic!("Unexpected event"),
2049 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2050 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2051 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2053 let events = node.node().get_and_clear_pending_events();
2054 let expected_payment_hash = PaymentHash(
2055 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
2056 if expect_per_path_claims {
2057 assert!(events.len() > 1);
2059 assert_eq!(events.len(), 1);
2061 if expect_post_ev_mon_update {
2062 check_added_monitors(node, 1);
2064 let expected_payment_id = match events[0] {
2065 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2066 assert_eq!(expected_payment_preimage, *payment_preimage);
2067 assert_eq!(expected_payment_hash, *payment_hash);
2068 if let Some(expected_fee_msat) = expected_fee_msat_opt {
2069 assert_eq!(*fee_paid_msat, expected_fee_msat);
2071 assert!(fee_paid_msat.is_some());
2075 _ => panic!("Unexpected event"),
2077 if expect_per_path_claims {
2078 for i in 1..events.len() {
2080 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2081 assert_eq!(payment_id, expected_payment_id);
2082 assert_eq!(payment_hash, Some(expected_payment_hash));
2084 _ => panic!("Unexpected event"),
2091 macro_rules! expect_payment_sent {
2092 ($node: expr, $expected_payment_preimage: expr) => {
2093 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2095 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2096 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2098 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2099 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2100 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2106 macro_rules! expect_payment_path_successful {
2108 let events = $node.node.get_and_clear_pending_events();
2109 assert_eq!(events.len(), 1);
2111 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2112 _ => panic!("Unexpected event"),
2117 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2118 event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2119 upstream_force_closed: bool, downstream_force_closed: bool
2122 Event::PaymentForwarded {
2123 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2124 outbound_amount_forwarded_msat: _
2126 assert_eq!(fee_earned_msat, expected_fee);
2127 if !upstream_force_closed {
2128 // Is the event prev_channel_id in one of the channels between the two nodes?
2129 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()));
2131 // We check for force closures since a force closed channel is removed from the
2132 // node's channel list
2133 if !downstream_force_closed {
2134 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()));
2136 assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2138 _ => panic!("Unexpected event"),
2142 macro_rules! expect_payment_forwarded {
2143 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2144 let mut events = $node.node.get_and_clear_pending_events();
2145 assert_eq!(events.len(), 1);
2146 $crate::ln::functional_test_utils::expect_payment_forwarded(
2147 events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee,
2148 $upstream_force_closed, $downstream_force_closed);
2154 macro_rules! expect_channel_shutdown_state {
2155 ($node: expr, $chan_id: expr, $state: path) => {
2156 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2157 assert_eq!(chan_details.len(), 1);
2158 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2162 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2163 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2164 let events = node.node.get_and_clear_pending_events();
2165 assert_eq!(events.len(), 1);
2167 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2168 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2171 _ => panic!("Unexpected event"),
2175 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2176 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2177 let events = node.node.get_and_clear_pending_events();
2178 assert_eq!(events.len(), 1);
2180 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2181 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2183 _ => panic!("Unexpected event"),
2187 #[cfg(any(test, feature = "_test_utils"))]
2188 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2189 let mut events = node.node.get_and_clear_pending_events();
2191 for event in events.drain(..) {
2193 Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2194 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2195 assert!(result_idx.is_some());
2197 probe_results.remove(result_idx.unwrap());
2203 // Ensure that we received a ProbeSuccessful event for each probe result.
2204 assert!(probe_results.is_empty());
2207 pub struct PaymentFailedConditions<'a> {
2208 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2209 pub(crate) expected_blamed_scid: Option<u64>,
2210 pub(crate) expected_blamed_chan_closed: Option<bool>,
2211 pub(crate) expected_mpp_parts_remain: bool,
2214 impl<'a> PaymentFailedConditions<'a> {
2215 pub fn new() -> Self {
2217 expected_htlc_error_data: None,
2218 expected_blamed_scid: None,
2219 expected_blamed_chan_closed: None,
2220 expected_mpp_parts_remain: false,
2223 pub fn mpp_parts_remain(mut self) -> Self {
2224 self.expected_mpp_parts_remain = true;
2227 pub fn blamed_scid(mut self, scid: u64) -> Self {
2228 self.expected_blamed_scid = Some(scid);
2231 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2232 self.expected_blamed_chan_closed = Some(closed);
2235 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2236 self.expected_htlc_error_data = Some((code, data));
2242 macro_rules! expect_payment_failed_with_update {
2243 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2244 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2245 &$node, $expected_payment_hash, $payment_failed_permanently,
2246 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2247 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2252 macro_rules! expect_payment_failed {
2253 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2254 #[allow(unused_mut)]
2255 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2257 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2259 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2263 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2264 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2265 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2267 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2268 let expected_payment_id = match &payment_failed_events[0] {
2269 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2273 error_data, .. } => {
2274 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2275 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2278 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2279 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2280 if let Some((code, data)) = conditions.expected_htlc_error_data {
2281 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2282 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2286 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2287 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2289 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2290 if let Some(scid) = conditions.expected_blamed_scid {
2291 assert_eq!(msg.contents.short_channel_id, scid);
2293 const CHAN_DISABLED_FLAG: u8 = 2;
2294 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2296 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2297 if let Some(scid) = conditions.expected_blamed_scid {
2298 assert_eq!(*short_channel_id, scid);
2300 assert!(is_permanent);
2302 _ => panic!("Unexpected update type"),
2304 } else { panic!("Expected network update"); }
2309 _ => panic!("Unexpected event"),
2311 if !conditions.expected_mpp_parts_remain {
2312 match &payment_failed_events[1] {
2313 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2314 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2315 assert_eq!(*payment_id, expected_payment_id);
2316 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2317 PaymentFailureReason::RecipientRejected
2319 PaymentFailureReason::RetriesExhausted
2322 _ => panic!("Unexpected second event"),
2327 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2328 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2329 conditions: PaymentFailedConditions<'e>
2331 let events = node.node.get_and_clear_pending_events();
2332 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2335 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 {
2336 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2337 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2338 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2339 check_added_monitors!(origin_node, expected_paths.len());
2340 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2344 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2345 let origin_node_id = expected_path[0].node.get_our_node_id();
2347 // iterate from the receiving node to the origin node and handle update fail htlc.
2348 for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2349 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2350 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2351 check_added_monitors!(prev_node, 0);
2353 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2354 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2355 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2359 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>, is_probe: bool) -> Option<Event> {
2360 let mut payment_event = SendEvent::from_event(ev);
2361 let mut prev_node = origin_node;
2362 let mut event = None;
2364 for (idx, &node) in expected_path.iter().enumerate() {
2365 let is_last_hop = idx == expected_path.len() - 1;
2366 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2368 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2369 check_added_monitors!(node, 0);
2371 if is_last_hop && is_probe {
2372 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2374 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2375 expect_pending_htlcs_forwardable!(node);
2378 if is_last_hop && clear_recipient_events {
2379 let events_2 = node.node.get_and_clear_pending_events();
2380 if payment_claimable_expected {
2381 assert_eq!(events_2.len(), 1);
2382 match &events_2[0] {
2383 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2384 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2385 claim_deadline, onion_fields, ..
2387 assert_eq!(our_payment_hash, *payment_hash);
2388 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2389 assert!(onion_fields.is_some());
2391 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2392 assert_eq!(expected_preimage, *payment_preimage);
2393 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2394 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2396 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2397 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2398 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2401 assert_eq!(*amount_msat, recv_value);
2402 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2403 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2404 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2406 _ => panic!("Unexpected event"),
2408 event = Some(events_2[0].clone());
2410 assert!(events_2.is_empty());
2412 } else if !is_last_hop {
2413 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2414 assert_eq!(events_2.len(), 1);
2415 check_added_monitors!(node, 1);
2416 payment_event = SendEvent::from_event(events_2.remove(0));
2417 assert_eq!(payment_event.msgs.len(), 1);
2425 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> {
2426 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage, false)
2429 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2430 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2431 assert_eq!(events.len(), expected_route.len());
2433 check_added_monitors!(origin_node, expected_route.len());
2435 for path in expected_route.iter() {
2436 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2438 do_pass_along_path(origin_node, path, 0, PaymentHash([0_u8; 32]), None, ev, false, false, None, true);
2439 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2441 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2445 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) {
2446 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2447 assert_eq!(events.len(), expected_route.len());
2449 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2450 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2451 // Once we've gotten through all the HTLCs, the last one should result in a
2452 // PaymentClaimable (but each previous one should not!).
2453 let expect_payment = path_idx == expected_route.len() - 1;
2454 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2458 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) {
2459 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2460 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2461 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2464 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2465 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2466 our_payment_preimage: PaymentPreimage
2468 let extra_fees = vec![0; expected_paths.len()];
2469 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2470 &extra_fees[..], skip_last, our_payment_preimage)
2473 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2474 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2475 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2477 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2478 for path in expected_paths.iter() {
2479 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2481 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2482 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2485 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 {
2486 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2487 assert_eq!(claim_event.len(), 1);
2488 match claim_event[0] {
2489 Event::PaymentClaimed {
2490 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2494 | Event::PaymentClaimed {
2495 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2500 assert_eq!(preimage, our_payment_preimage);
2501 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2502 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2503 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2505 Event::PaymentClaimed {
2506 purpose: PaymentPurpose::InvoicePayment { .. },
2512 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2513 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2514 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2515 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2520 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2522 let mut expected_total_fee_msat = 0;
2524 macro_rules! msgs_from_ev {
2527 &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 } } => {
2528 assert!(update_add_htlcs.is_empty());
2529 assert_eq!(update_fulfill_htlcs.len(), 1);
2530 assert!(update_fail_htlcs.is_empty());
2531 assert!(update_fail_malformed_htlcs.is_empty());
2532 assert!(update_fee.is_none());
2533 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2535 _ => panic!("Unexpected event"),
2539 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2540 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2541 assert_eq!(events.len(), expected_paths.len());
2543 if events.len() == 1 {
2544 per_path_msgs.push(msgs_from_ev!(&events[0]));
2546 for expected_path in expected_paths.iter() {
2547 // For MPP payments, we always want the message to the first node in the path.
2548 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2549 per_path_msgs.push(msgs_from_ev!(&ev));
2553 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2554 let mut next_msgs = Some(path_msgs);
2555 let mut expected_next_node = next_hop;
2557 macro_rules! last_update_fulfill_dance {
2558 ($node: expr, $prev_node: expr) => {
2560 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2561 check_added_monitors!($node, 0);
2562 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2563 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2567 macro_rules! mid_update_fulfill_dance {
2568 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2570 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2572 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2573 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2574 .unwrap().lock().unwrap();
2575 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2576 if let Some(prev_config) = channel.context().prev_config() {
2577 prev_config.forwarding_fee_base_msat
2579 channel.context().config().forwarding_fee_base_msat
2582 if $idx == 1 { fee += expected_extra_fees[i]; }
2583 expect_payment_forwarded!(*$node, $next_node, $prev_node, Some(fee as u64), false, false);
2584 expected_total_fee_msat += fee as u64;
2585 check_added_monitors!($node, 1);
2586 let new_next_msgs = if $new_msgs {
2587 let events = $node.node.get_and_clear_pending_msg_events();
2588 assert_eq!(events.len(), 1);
2589 let (res, nexthop) = msgs_from_ev!(&events[0]);
2590 expected_next_node = nexthop;
2593 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2596 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2597 next_msgs = new_next_msgs;
2602 let mut prev_node = expected_route.last().unwrap();
2603 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2604 assert_eq!(expected_next_node, node.node.get_our_node_id());
2605 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2606 if next_msgs.is_some() {
2607 // Since we are traversing in reverse, next_node is actually the previous node
2608 let next_node: &Node;
2609 if idx == expected_route.len() - 1 {
2610 next_node = origin_node;
2612 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2614 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2616 assert!(!update_next_msgs);
2617 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2619 if !skip_last && idx == expected_route.len() - 1 {
2620 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2627 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2631 // Ensure that claim_funds is idempotent.
2632 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2633 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2634 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2636 expected_total_fee_msat
2638 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) {
2639 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2641 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2645 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2646 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2649 pub const TEST_FINAL_CLTV: u32 = 70;
2651 pub fn route_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
2652 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2653 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2654 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2655 let route = get_route(origin_node, &route_params).unwrap();
2656 assert_eq!(route.paths.len(), 1);
2657 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2658 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2659 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2662 let res = send_along_route(origin_node, route, expected_route, recv_value);
2663 (res.0, res.1, res.2, res.3)
2666 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2667 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2668 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2669 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2670 let network_graph = origin_node.network_graph.read_only();
2671 let scorer = test_utils::TestScorer::new();
2672 let seed = [0u8; 32];
2673 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2674 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2675 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2676 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2677 assert_eq!(route.paths.len(), 1);
2678 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2679 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2680 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2683 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2684 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2685 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2686 true, APIError::ChannelUnavailable { ref err },
2687 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2690 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret, PaymentId) {
2691 let res = route_payment(&origin, expected_route, recv_value);
2692 claim_payment(&origin, expected_route, res.0);
2696 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) {
2697 for path in expected_paths.iter() {
2698 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2700 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2701 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2702 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2704 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2707 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) {
2708 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2709 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2711 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2712 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2713 assert_eq!(events.len(), expected_paths.len());
2714 for ev in events.iter() {
2715 let (update_fail, commitment_signed, node_id) = match ev {
2716 &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 } } => {
2717 assert!(update_add_htlcs.is_empty());
2718 assert!(update_fulfill_htlcs.is_empty());
2719 assert_eq!(update_fail_htlcs.len(), 1);
2720 assert!(update_fail_malformed_htlcs.is_empty());
2721 assert!(update_fee.is_none());
2722 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2724 _ => panic!("Unexpected event"),
2726 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2728 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2729 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()));
2731 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2732 let mut next_msgs = Some(path_msgs);
2733 let mut expected_next_node = next_hop;
2734 let mut prev_node = expected_route.last().unwrap();
2736 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2737 assert_eq!(expected_next_node, node.node.get_our_node_id());
2738 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2739 if next_msgs.is_some() {
2740 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2741 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2742 if !update_next_node {
2743 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 }]);
2746 let events = node.node.get_and_clear_pending_msg_events();
2747 if update_next_node {
2748 assert_eq!(events.len(), 1);
2750 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 } } => {
2751 assert!(update_add_htlcs.is_empty());
2752 assert!(update_fulfill_htlcs.is_empty());
2753 assert_eq!(update_fail_htlcs.len(), 1);
2754 assert!(update_fail_malformed_htlcs.is_empty());
2755 assert!(update_fee.is_none());
2756 expected_next_node = node_id.clone();
2757 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2759 _ => panic!("Unexpected event"),
2762 assert!(events.is_empty());
2764 if !skip_last && idx == expected_route.len() - 1 {
2765 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2772 let prev_node = expected_route.first().unwrap();
2773 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2774 check_added_monitors!(origin_node, 0);
2775 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2776 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2777 let events = origin_node.node.get_and_clear_pending_events();
2778 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2780 let expected_payment_id = match events[0] {
2781 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2782 assert_eq!(payment_hash, our_payment_hash);
2783 assert!(payment_failed_permanently);
2784 for (idx, hop) in expected_route.iter().enumerate() {
2785 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2789 _ => panic!("Unexpected event"),
2791 if i == expected_paths.len() - 1 {
2793 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2794 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2795 assert_eq!(*payment_id, expected_payment_id);
2796 assert_eq!(reason.unwrap(), expected_fail_reason);
2798 _ => panic!("Unexpected second event"),
2804 // Ensure that fail_htlc_backwards is idempotent.
2805 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2806 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2807 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2808 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2811 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2812 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2815 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2816 let mut chan_mon_cfgs = Vec::new();
2817 for i in 0..node_count {
2818 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2819 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2820 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2821 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2822 let persister = test_utils::TestPersister::new();
2823 let seed = [i as u8; 32];
2824 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2825 let scorer = RwLock::new(test_utils::TestScorer::new());
2827 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2833 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2834 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2837 pub fn create_node_cfgs_with_persisters<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>, persisters: Vec<&'a impl Persist<TestChannelSigner>>) -> Vec<NodeCfg<'a>> {
2838 let mut nodes = Vec::new();
2840 for i in 0..node_count {
2841 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, persisters[i], &chanmon_cfgs[i].keys_manager);
2842 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2843 let seed = [i as u8; 32];
2844 nodes.push(NodeCfg {
2845 chain_source: &chanmon_cfgs[i].chain_source,
2846 logger: &chanmon_cfgs[i].logger,
2847 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2848 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2849 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2851 keys_manager: &chanmon_cfgs[i].keys_manager,
2854 override_init_features: Rc::new(RefCell::new(None)),
2861 pub fn test_default_channel_config() -> UserConfig {
2862 let mut default_config = UserConfig::default();
2863 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2864 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2865 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2866 default_config.channel_handshake_config.announced_channel = true;
2867 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2868 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2869 // It now defaults to 1, so we simply set it to the expected value here.
2870 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2871 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2872 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2874 default_config.channel_config.max_dust_htlc_exposure =
2875 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2879 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>> {
2880 let mut chanmgrs = Vec::new();
2881 for i in 0..node_count {
2882 let network = Network::Testnet;
2883 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2884 let params = ChainParameters {
2886 best_block: BestBlock::from_network(network),
2888 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,
2889 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);
2890 chanmgrs.push(node);
2896 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>> {
2897 let mut nodes = Vec::new();
2898 let chan_count = Rc::new(RefCell::new(0));
2899 let payment_count = Rc::new(RefCell::new(0));
2900 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2902 for i in 0..node_count {
2903 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2904 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2906 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2907 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2908 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2909 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2910 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2911 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2912 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2913 connect_style: Rc::clone(&connect_style),
2914 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2915 wallet_source: Arc::clone(&wallet_source),
2916 bump_tx_handler: BumpTransactionEventHandler::new(
2917 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2918 &cfgs[i].keys_manager, cfgs[i].logger,
2923 for i in 0..node_count {
2924 for j in (i+1)..node_count {
2925 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2926 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2928 remote_network_address: None,
2930 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2931 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2933 remote_network_address: None,
2941 // Note that the following only works for CLTV values up to 128
2942 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2943 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2945 #[derive(PartialEq)]
2946 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2947 /// Tests that the given node has broadcast transactions for the given Channel
2949 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2950 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2951 /// broadcast and the revoked outputs were claimed.
2953 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2954 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2956 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2958 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, ChannelId, Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2959 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2960 let mut txn_seen = HashSet::new();
2961 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2962 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2964 let mut res = Vec::with_capacity(2);
2965 node_txn.retain(|tx| {
2966 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2967 check_spends!(tx, chan.3);
2968 if commitment_tx.is_none() {
2969 res.push(tx.clone());
2974 if let Some(explicit_tx) = commitment_tx {
2975 res.push(explicit_tx.clone());
2978 assert_eq!(res.len(), 1);
2980 if has_htlc_tx != HTLCType::NONE {
2981 node_txn.retain(|tx| {
2982 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2983 check_spends!(tx, res[0]);
2984 if has_htlc_tx == HTLCType::TIMEOUT {
2985 assert!(tx.lock_time.0 != 0);
2987 assert!(tx.lock_time.0 == 0);
2989 res.push(tx.clone());
2993 assert!(res.len() == 2 || res.len() == 3);
2995 assert_eq!(res[1], res[2]);
2999 assert!(node_txn.is_empty());
3003 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3004 /// HTLC transaction.
3005 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
3006 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3007 // We may issue multiple claiming transaction on revoked outputs due to block rescan
3008 // for revoked htlc outputs
3009 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3010 node_txn.retain(|tx| {
3011 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3012 check_spends!(tx, revoked_tx);
3016 node_txn.retain(|tx| {
3017 check_spends!(tx, commitment_revoked_tx);
3020 assert!(node_txn.is_empty());
3023 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3024 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3025 let mut txn_seen = HashSet::new();
3026 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3028 let mut found_prev = false;
3029 for prev_tx in prev_txn {
3030 for tx in &*node_txn {
3031 if tx.input[0].previous_output.txid == prev_tx.txid() {
3032 check_spends!(tx, prev_tx);
3033 let mut iter = tx.input[0].witness.iter();
3034 iter.next().expect("expected 3 witness items");
3035 iter.next().expect("expected 3 witness items");
3036 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3037 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3044 assert!(found_prev);
3046 let mut res = Vec::new();
3047 mem::swap(&mut *node_txn, &mut res);
3051 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) {
3052 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3053 assert_eq!(events_1.len(), 2);
3054 let as_update = match events_1[0] {
3055 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3058 _ => panic!("Unexpected event"),
3061 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3062 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3063 assert_eq!(msg.data, expected_error);
3064 if needs_err_handle {
3065 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3068 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3069 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3070 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3071 if needs_err_handle {
3072 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3075 _ => panic!("Unexpected event"),
3078 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3079 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3080 let bs_update = match events_2[0] {
3081 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3084 _ => panic!("Unexpected event"),
3086 if !needs_err_handle {
3088 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3089 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3090 assert_eq!(msg.data, expected_error);
3092 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3093 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3094 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3096 _ => panic!("Unexpected event"),
3101 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3102 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3106 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
3107 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3111 macro_rules! get_channel_value_stat {
3112 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3113 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3114 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3115 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3116 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3117 ).flatten().unwrap();
3118 chan.get_value_stat()
3122 macro_rules! get_chan_reestablish_msgs {
3123 ($src_node: expr, $dst_node: expr) => {
3125 let mut announcements = $crate::prelude::HashSet::new();
3126 let mut res = Vec::with_capacity(1);
3127 for msg in $src_node.node.get_and_clear_pending_msg_events() {
3128 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3129 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3130 res.push(msg.clone());
3131 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3132 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3133 announcements.insert(msg.contents.short_channel_id);
3135 panic!("Unexpected event")
3138 assert!(announcements.is_empty());
3144 macro_rules! handle_chan_reestablish_msgs {
3145 ($src_node: expr, $dst_node: expr) => {
3147 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3149 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3151 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3157 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3159 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3162 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3163 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3164 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3166 had_channel_update = true;
3169 let mut revoke_and_ack = None;
3170 let mut commitment_update = None;
3171 let order = if let Some(ev) = msg_events.get(idx) {
3173 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3174 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3175 revoke_and_ack = Some(msg.clone());
3177 RAACommitmentOrder::RevokeAndACKFirst
3179 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3180 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3181 commitment_update = Some(updates.clone());
3183 RAACommitmentOrder::CommitmentFirst
3185 _ => RAACommitmentOrder::CommitmentFirst,
3188 RAACommitmentOrder::CommitmentFirst
3191 if let Some(ev) = msg_events.get(idx) {
3193 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3194 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3195 assert!(revoke_and_ack.is_none());
3196 revoke_and_ack = Some(msg.clone());
3199 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3200 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3201 assert!(commitment_update.is_none());
3202 commitment_update = Some(updates.clone());
3209 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3210 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3212 assert!(!had_channel_update);
3215 assert_eq!(msg_events.len(), idx);
3217 (channel_ready, revoke_and_ack, commitment_update, order)
3222 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3223 pub node_a: &'a Node<'b, 'c, 'd>,
3224 pub node_b: &'a Node<'b, 'c, 'd>,
3225 pub send_channel_ready: (bool, bool),
3226 pub pending_responding_commitment_signed: (bool, bool),
3227 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3228 /// and no monitor update is expected
3229 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3230 pub pending_htlc_adds: (usize, usize),
3231 pub pending_htlc_claims: (usize, usize),
3232 pub pending_htlc_fails: (usize, usize),
3233 pub pending_cell_htlc_claims: (usize, usize),
3234 pub pending_cell_htlc_fails: (usize, usize),
3235 pub pending_raa: (bool, bool),
3238 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3239 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3243 send_channel_ready: (false, false),
3244 pending_responding_commitment_signed: (false, false),
3245 pending_responding_commitment_signed_dup_monitor: (false, false),
3246 pending_htlc_adds: (0, 0),
3247 pending_htlc_claims: (0, 0),
3248 pending_htlc_fails: (0, 0),
3249 pending_cell_htlc_claims: (0, 0),
3250 pending_cell_htlc_fails: (0, 0),
3251 pending_raa: (false, false),
3256 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3257 /// for claims/fails they are separated out.
3258 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3260 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3261 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3262 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3264 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3265 features: node_b.node.init_features(), networks: None, remote_network_address: None
3267 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3268 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3269 features: node_a.node.init_features(), networks: None, remote_network_address: None
3271 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3273 if send_channel_ready.0 {
3274 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3276 for reestablish in reestablish_1.iter() {
3277 let n = reestablish.next_remote_commitment_number;
3278 assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3281 if send_channel_ready.1 {
3282 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3284 for reestablish in reestablish_2.iter() {
3285 let n = reestablish.next_remote_commitment_number;
3286 assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3289 if send_channel_ready.0 || send_channel_ready.1 {
3290 // If we expect any channel_ready's, both sides better have set
3291 // next_holder_commitment_number to 1
3292 for reestablish in reestablish_1.iter() {
3293 let n = reestablish.next_local_commitment_number;
3294 assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3296 for reestablish in reestablish_2.iter() {
3297 let n = reestablish.next_local_commitment_number;
3298 assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3302 let mut resp_1 = Vec::new();
3303 for msg in reestablish_1 {
3304 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3305 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3307 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3308 check_added_monitors!(node_b, 1);
3310 check_added_monitors!(node_b, 0);
3313 let mut resp_2 = Vec::new();
3314 for msg in reestablish_2 {
3315 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3316 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3318 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3319 check_added_monitors!(node_a, 1);
3321 check_added_monitors!(node_a, 0);
3324 // We don't yet support both needing updates, as that would require a different commitment dance:
3325 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3326 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3327 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3328 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3330 for chan_msgs in resp_1.drain(..) {
3331 if send_channel_ready.0 {
3332 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3333 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3334 if !announcement_event.is_empty() {
3335 assert_eq!(announcement_event.len(), 1);
3336 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3337 //TODO: Test announcement_sigs re-sending
3338 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3341 assert!(chan_msgs.0.is_none());
3344 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3345 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3346 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3347 check_added_monitors!(node_a, 1);
3349 assert!(chan_msgs.1.is_none());
3351 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3352 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3353 pending_responding_commitment_signed.0
3355 let commitment_update = chan_msgs.2.unwrap();
3356 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3357 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3358 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3359 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3360 for update_add in commitment_update.update_add_htlcs {
3361 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3363 for update_fulfill in commitment_update.update_fulfill_htlcs {
3364 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3366 for update_fail in commitment_update.update_fail_htlcs {
3367 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3370 if !pending_responding_commitment_signed.0 {
3371 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3373 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3374 check_added_monitors!(node_a, 1);
3375 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3376 // No commitment_signed so get_event_msg's assert(len == 1) passes
3377 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3378 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3379 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3382 assert!(chan_msgs.2.is_none());
3386 for chan_msgs in resp_2.drain(..) {
3387 if send_channel_ready.1 {
3388 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3389 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3390 if !announcement_event.is_empty() {
3391 assert_eq!(announcement_event.len(), 1);
3392 match announcement_event[0] {
3393 MessageSendEvent::SendChannelUpdate { .. } => {},
3394 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3395 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3399 assert!(chan_msgs.0.is_none());
3402 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3403 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3404 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3405 check_added_monitors!(node_b, 1);
3407 assert!(chan_msgs.1.is_none());
3409 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3410 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3411 pending_responding_commitment_signed.1
3413 let commitment_update = chan_msgs.2.unwrap();
3414 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3415 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3416 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3417 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3418 for update_add in commitment_update.update_add_htlcs {
3419 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3421 for update_fulfill in commitment_update.update_fulfill_htlcs {
3422 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3424 for update_fail in commitment_update.update_fail_htlcs {
3425 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3428 if !pending_responding_commitment_signed.1 {
3429 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3431 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3432 check_added_monitors!(node_b, 1);
3433 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3434 // No commitment_signed so get_event_msg's assert(len == 1) passes
3435 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3436 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3437 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3440 assert!(chan_msgs.2.is_none());
3445 /// Initiates channel opening and creates a single batch funding transaction.
3446 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3447 /// transaction with corresponding funding_created messages.
3448 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3449 funding_node: &Node<'a, 'b, 'c>,
3450 params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3451 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3452 let mut tx_outs = Vec::new();
3453 let mut temp_chan_ids = Vec::new();
3454 let mut funding_created_msgs = Vec::new();
3456 for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3457 // Initialize channel opening.
3458 let temp_chan_id = funding_node.node.create_channel(
3459 other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3463 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3464 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3465 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3466 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3468 // Create the corresponding funding output.
3469 let events = funding_node.node.get_and_clear_pending_events();
3470 assert_eq!(events.len(), 1);
3472 Event::FundingGenerationReady {
3473 ref temporary_channel_id,
3474 ref counterparty_node_id,
3475 channel_value_satoshis: ref event_channel_value_satoshis,
3477 user_channel_id: ref event_user_channel_id
3479 assert_eq!(temporary_channel_id, &temp_chan_id);
3480 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3481 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3482 assert_eq!(user_channel_id, event_user_channel_id);
3483 tx_outs.push(TxOut {
3484 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3487 _ => panic!("Unexpected event"),
3489 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3492 // Compose the batch funding transaction and give it to the ChannelManager.
3493 let tx = Transaction {
3495 lock_time: PackedLockTime::ZERO,
3499 assert!(funding_node.node.batch_funding_transaction_generated(
3500 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3503 check_added_monitors!(funding_node, 0);
3504 let events = funding_node.node.get_and_clear_pending_msg_events();
3505 assert_eq!(events.len(), params.len());
3506 for (other_node, ..) in params {
3507 let funding_created = events
3509 .find_map(|event| match event {
3510 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3514 funding_created_msgs.push(funding_created);
3516 return (tx, funding_created_msgs);