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, Header, Version};
37 use bitcoin::blockdata::locktime::absolute::LockTime;
38 use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut};
39 use bitcoin::hash_types::{BlockHash, TxMerkleNode};
40 use bitcoin::hashes::sha256::Hash as Sha256;
41 use bitcoin::hashes::Hash as _;
42 use bitcoin::network::constants::Network;
43 use bitcoin::pow::CompactTarget;
44 use bitcoin::secp256k1::{PublicKey, SecretKey};
47 use crate::prelude::*;
48 use core::cell::RefCell;
50 use crate::sync::{Arc, Mutex, LockTestExt, RwLock};
52 use core::iter::repeat;
54 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
56 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
57 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
59 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
60 /// output is the 1st output in the transaction.
61 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
62 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
63 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
66 /// Mine a single block containing the given transaction
68 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
69 /// output is the 1st output in the transaction.
70 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
71 let height = node.best_block_info().1 + 1;
72 confirm_transaction_at(node, tx, height)
74 /// Mine a single block containing the given transactions
75 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
76 let height = node.best_block_info().1 + 1;
77 confirm_transactions_at(node, txn, height);
79 /// Mine a single block containing the given transaction without extra consistency checks which may
80 /// impact ChannelManager state.
81 pub fn mine_transaction_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
82 let height = node.best_block_info().1 + 1;
83 let mut block = Block {
85 version: Version::NO_SOFT_FORK_SIGNALLING,
86 prev_blockhash: node.best_block_hash(),
87 merkle_root: TxMerkleNode::all_zeros(),
89 bits: CompactTarget::from_consensus(42),
94 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
95 block.txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
97 block.txdata.push((*tx).clone());
98 do_connect_block_without_consistency_checks(node, block, false);
100 /// Mine the given transaction at the given height, mining blocks as required to build to that
103 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
104 /// output is the 1st output in the transaction.
105 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
106 let first_connect_height = node.best_block_info().1 + 1;
107 assert!(first_connect_height <= conf_height);
108 if conf_height > first_connect_height {
109 connect_blocks(node, conf_height - first_connect_height);
111 let mut txdata = Vec::new();
112 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
113 txdata.push(Transaction { version: 0, lock_time: LockTime::ZERO, input: Vec::new(), output: Vec::new() });
116 txdata.push((*tx).clone());
118 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
119 connect_block(node, &block);
120 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
122 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
123 confirm_transactions_at(node, &[tx], conf_height)
126 /// The possible ways we may notify a ChannelManager of a new block
127 #[derive(Clone, Copy, Debug, PartialEq)]
128 pub enum ConnectStyle {
129 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
130 /// the header and height information.
132 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
133 /// make a single `best_block_updated` call.
134 BestBlockFirstSkippingBlocks,
135 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
136 /// `transaction_unconfirmed` is called.
137 BestBlockFirstReorgsOnlyTip,
138 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
139 /// the header and height information.
141 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
142 /// make a single `best_block_updated` call.
143 TransactionsFirstSkippingBlocks,
144 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
145 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
146 /// times to ensure it's idempotent.
147 TransactionsDuplicativelyFirstSkippingBlocks,
148 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
149 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
150 /// times to ensure it's idempotent.
151 HighlyRedundantTransactionsFirstSkippingBlocks,
152 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
153 /// `transaction_unconfirmed` is called.
154 TransactionsFirstReorgsOnlyTip,
155 /// Provides the full block via the `chain::Listen` interface. In the current code this is
156 /// equivalent to `TransactionsFirst` with some additional assertions.
161 pub fn skips_blocks(&self) -> bool {
163 ConnectStyle::BestBlockFirst => false,
164 ConnectStyle::BestBlockFirstSkippingBlocks => true,
165 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
166 ConnectStyle::TransactionsFirst => false,
167 ConnectStyle::TransactionsFirstSkippingBlocks => true,
168 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
169 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
170 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
171 ConnectStyle::FullBlockViaListen => false,
175 pub fn updates_best_block_first(&self) -> bool {
177 ConnectStyle::BestBlockFirst => true,
178 ConnectStyle::BestBlockFirstSkippingBlocks => true,
179 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
180 ConnectStyle::TransactionsFirst => false,
181 ConnectStyle::TransactionsFirstSkippingBlocks => false,
182 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
183 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
184 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
185 ConnectStyle::FullBlockViaListen => false,
189 fn random_style() -> ConnectStyle {
190 #[cfg(feature = "std")] {
191 use core::hash::{BuildHasher, Hasher};
192 // Get a random value using the only std API to do so - the DefaultHasher
193 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
194 let res = match rand_val % 9 {
195 0 => ConnectStyle::BestBlockFirst,
196 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
197 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
198 3 => ConnectStyle::TransactionsFirst,
199 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
200 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
201 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
202 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
203 8 => ConnectStyle::FullBlockViaListen,
206 eprintln!("Using Block Connection Style: {:?}", res);
209 #[cfg(not(feature = "std"))] {
210 ConnectStyle::FullBlockViaListen
215 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> Header {
217 version: Version::NO_SOFT_FORK_SIGNALLING,
219 merkle_root: TxMerkleNode::all_zeros(),
221 bits: CompactTarget::from_consensus(42),
226 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
227 Block { header: create_dummy_header(prev_blockhash, time), txdata }
230 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
231 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
233 let height = node.best_block_info().1 + 1;
234 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
237 let prev_blockhash = block.header.block_hash();
238 do_connect_block_with_consistency_checks(node, block, skip_intermediaries);
239 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
241 let hash = block.header.block_hash();
242 do_connect_block_with_consistency_checks(node, block, false);
246 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
247 do_connect_block_with_consistency_checks(node, block.clone(), false);
250 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
251 // Ensure `get_claimable_balances`' self-tests never panic
252 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
253 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
257 fn do_connect_block_with_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
258 call_claimable_balances(node);
259 do_connect_block_without_consistency_checks(node, block, skip_intermediaries);
260 call_claimable_balances(node);
261 node.node.test_process_background_events();
264 fn do_connect_block_without_consistency_checks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
265 let height = node.best_block_info().1 + 1;
266 #[cfg(feature = "std")] {
267 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
269 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
270 // transaction broadcast are correct.
271 node.blocks.lock().unwrap().push((block.clone(), height));
272 if !skip_intermediaries {
273 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
274 match *node.connect_style.borrow() {
275 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
276 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
277 call_claimable_balances(node);
278 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
279 node.node.best_block_updated(&block.header, height);
280 node.node.transactions_confirmed(&block.header, &txdata, height);
282 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
283 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
284 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
285 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
286 let mut connections = Vec::new();
287 for (block, height) in node.blocks.lock().unwrap().iter() {
288 if !block.txdata.is_empty() {
289 // Reconnect all transactions we've ever seen to ensure transaction connection
290 // is *really* idempotent. This is a somewhat likely deployment for some
291 // esplora implementations of chain sync which try to reduce state and
292 // complexity as much as possible.
294 // Sadly we have to clone the block here to maintain lockorder. In the
295 // future we should consider Arc'ing the blocks to avoid this.
296 connections.push((block.clone(), *height));
299 for (old_block, height) in connections {
300 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
301 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
304 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
305 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
306 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
308 call_claimable_balances(node);
309 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
310 node.node.transactions_confirmed(&block.header, &txdata, height);
311 node.node.best_block_updated(&block.header, height);
313 ConnectStyle::FullBlockViaListen => {
314 node.chain_monitor.chain_monitor.block_connected(&block, height);
315 node.node.block_connected(&block, height);
320 for tx in &block.txdata {
321 for input in &tx.input {
322 node.wallet_source.remove_utxo(input.previous_output);
324 let wallet_script = node.wallet_source.get_change_script().unwrap();
325 for (idx, output) in tx.output.iter().enumerate() {
326 if output.script_pubkey == wallet_script {
327 let outpoint = bitcoin::OutPoint { txid: tx.txid(), vout: idx as u32 };
328 node.wallet_source.add_utxo(outpoint, output.value);
334 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
335 call_claimable_balances(node);
336 #[cfg(feature = "std")] {
337 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
340 let orig = node.blocks.lock().unwrap().pop().unwrap();
341 assert!(orig.1 > 0); // Cannot disconnect genesis
342 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
344 match *node.connect_style.borrow() {
345 ConnectStyle::FullBlockViaListen => {
346 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
347 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
349 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
350 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
352 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
353 node.node.best_block_updated(&prev.0.header, prev.1);
356 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
357 for tx in orig.0.txdata {
358 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
359 node.node.transaction_unconfirmed(&tx.txid());
363 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
364 node.node.best_block_updated(&prev.0.header, prev.1);
367 call_claimable_balances(node);
371 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
372 let count = node.blocks.lock().unwrap().len() as u32 - 1;
373 disconnect_blocks(node, count);
376 pub struct TestChanMonCfg {
377 pub tx_broadcaster: test_utils::TestBroadcaster,
378 pub fee_estimator: test_utils::TestFeeEstimator,
379 pub chain_source: test_utils::TestChainSource,
380 pub persister: test_utils::TestPersister,
381 pub logger: test_utils::TestLogger,
382 pub keys_manager: test_utils::TestKeysInterface,
383 pub scorer: RwLock<test_utils::TestScorer>,
386 pub struct NodeCfg<'a> {
387 pub chain_source: &'a test_utils::TestChainSource,
388 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
389 pub fee_estimator: &'a test_utils::TestFeeEstimator,
390 pub router: test_utils::TestRouter<'a>,
391 pub chain_monitor: test_utils::TestChainMonitor<'a>,
392 pub keys_manager: &'a test_utils::TestKeysInterface,
393 pub logger: &'a test_utils::TestLogger,
394 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
395 pub node_seed: [u8; 32],
396 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
399 type TestChannelManager<'node_cfg, 'chan_mon_cfg> = ChannelManager<
400 &'node_cfg TestChainMonitor<'chan_mon_cfg>,
401 &'chan_mon_cfg test_utils::TestBroadcaster,
402 &'node_cfg test_utils::TestKeysInterface,
403 &'node_cfg test_utils::TestKeysInterface,
404 &'node_cfg test_utils::TestKeysInterface,
405 &'chan_mon_cfg test_utils::TestFeeEstimator,
406 &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
407 &'chan_mon_cfg test_utils::TestLogger,
410 pub struct Node<'chan_man, 'node_cfg: 'chan_man, 'chan_mon_cfg: 'node_cfg> {
411 pub chain_source: &'chan_mon_cfg test_utils::TestChainSource,
412 pub tx_broadcaster: &'chan_mon_cfg test_utils::TestBroadcaster,
413 pub fee_estimator: &'chan_mon_cfg test_utils::TestFeeEstimator,
414 pub router: &'node_cfg test_utils::TestRouter<'chan_mon_cfg>,
415 pub chain_monitor: &'node_cfg test_utils::TestChainMonitor<'chan_mon_cfg>,
416 pub keys_manager: &'chan_mon_cfg test_utils::TestKeysInterface,
417 pub node: &'chan_man TestChannelManager<'node_cfg, 'chan_mon_cfg>,
418 pub network_graph: &'node_cfg NetworkGraph<&'chan_mon_cfg test_utils::TestLogger>,
419 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>,
420 pub node_seed: [u8; 32],
421 pub network_payment_count: Rc<RefCell<u8>>,
422 pub network_chan_count: Rc<RefCell<u32>>,
423 pub logger: &'chan_mon_cfg test_utils::TestLogger,
424 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
425 pub connect_style: Rc<RefCell<ConnectStyle>>,
426 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
427 pub wallet_source: Arc<test_utils::TestWalletSource>,
428 pub bump_tx_handler: BumpTransactionEventHandler<
429 &'chan_mon_cfg test_utils::TestBroadcaster,
430 Arc<Wallet<Arc<test_utils::TestWalletSource>, &'chan_mon_cfg test_utils::TestLogger>>,
431 &'chan_mon_cfg test_utils::TestKeysInterface,
432 &'chan_mon_cfg test_utils::TestLogger,
435 #[cfg(feature = "std")]
436 impl<'a, 'b, 'c> std::panic::UnwindSafe for Node<'a, 'b, 'c> {}
437 #[cfg(feature = "std")]
438 impl<'a, 'b, 'c> std::panic::RefUnwindSafe for Node<'a, 'b, 'c> {}
439 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
440 pub fn best_block_hash(&self) -> BlockHash {
441 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
443 pub fn best_block_info(&self) -> (BlockHash, u32) {
444 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
446 pub fn get_block_header(&self, height: u32) -> Header {
447 self.blocks.lock().unwrap()[height as usize].0.header
449 /// Changes the channel signer's availability for the specified peer and channel.
451 /// When `available` is set to `true`, the channel signer will behave normally. When set to
452 /// `false`, the channel signer will act like an off-line remote signer and will return `Err` for
453 /// several of the signing methods. Currently, only `get_per_commitment_point` and
454 /// `release_commitment_secret` are affected by this setting.
456 pub fn set_channel_signer_available(&self, peer_id: &PublicKey, chan_id: &ChannelId, available: bool) {
457 let per_peer_state = self.node.per_peer_state.read().unwrap();
458 let chan_lock = per_peer_state.get(peer_id).unwrap().lock().unwrap();
460 match chan_lock.channel_by_id.get(chan_id) {
461 Some(phase) => phase.context().get_signer(),
462 None => panic!("Couldn't find a channel with id {}", chan_id),
465 log_debug!(self.logger, "Setting channel signer for {} as available={}", chan_id, available);
466 signer.as_ecdsa().unwrap().set_available(available);
470 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
471 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
472 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
474 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
476 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
477 Self((node as *const Node<'a, 'b, 'c>).cast())
480 unsafe impl Send for NodePtr {}
481 unsafe impl Sync for NodePtr {}
484 pub trait NodeHolder {
485 type CM: AChannelManager;
486 fn node(&self) -> &ChannelManager<
487 <Self::CM as AChannelManager>::M,
488 <Self::CM as AChannelManager>::T,
489 <Self::CM as AChannelManager>::ES,
490 <Self::CM as AChannelManager>::NS,
491 <Self::CM as AChannelManager>::SP,
492 <Self::CM as AChannelManager>::F,
493 <Self::CM as AChannelManager>::R,
494 <Self::CM as AChannelManager>::L>;
495 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
497 impl<H: NodeHolder> NodeHolder for &H {
499 fn node(&self) -> &ChannelManager<
500 <Self::CM as AChannelManager>::M,
501 <Self::CM as AChannelManager>::T,
502 <Self::CM as AChannelManager>::ES,
503 <Self::CM as AChannelManager>::NS,
504 <Self::CM as AChannelManager>::SP,
505 <Self::CM as AChannelManager>::F,
506 <Self::CM as AChannelManager>::R,
507 <Self::CM as AChannelManager>::L> { (*self).node() }
508 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
510 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
511 type CM = TestChannelManager<'b, 'c>;
512 fn node(&self) -> &TestChannelManager<'b, 'c> { &self.node }
513 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
516 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
519 // Check that we processed all pending events
520 let msg_events = self.node.get_and_clear_pending_msg_events();
521 if !msg_events.is_empty() {
522 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
524 let events = self.node.get_and_clear_pending_events();
525 if !events.is_empty() {
526 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
528 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
529 if !added_monitors.is_empty() {
530 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
533 // Check that if we serialize the network graph, we can deserialize it again.
534 let network_graph = {
535 let mut w = test_utils::TestVecWriter(Vec::new());
536 self.network_graph.write(&mut w).unwrap();
537 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
538 assert!(network_graph_deser == *self.network_graph);
539 let gossip_sync = P2PGossipSync::new(
540 &network_graph_deser, Some(self.chain_source), self.logger
542 let mut chan_progress = 0;
544 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
545 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
546 assert!(orig_announcements == deserialized_announcements);
547 chan_progress = match orig_announcements {
548 Some(announcement) => announcement.0.contents.short_channel_id + 1,
552 let mut node_progress = None;
554 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
555 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
556 assert!(orig_announcements == deserialized_announcements);
557 node_progress = match orig_announcements {
558 Some(announcement) => Some(announcement.contents.node_id),
565 // Check that if we serialize and then deserialize all our channel monitors we get the
566 // same set of outputs to watch for on chain as we have now. Note that if we write
567 // tests that fully close channels and remove the monitors at some point this may break.
568 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
569 let mut deserialized_monitors = Vec::new();
571 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
572 let mut w = test_utils::TestVecWriter(Vec::new());
573 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
574 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>::read(
575 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
576 deserialized_monitors.push(deserialized_monitor);
580 let broadcaster = test_utils::TestBroadcaster {
581 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
582 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
585 // Before using all the new monitors to check the watch outpoints, use the full set of
586 // them to ensure we can write and reload our ChannelManager.
588 let mut channel_monitors = HashMap::new();
589 for monitor in deserialized_monitors.iter_mut() {
590 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
593 let scorer = RwLock::new(test_utils::TestScorer::new());
594 let mut w = test_utils::TestVecWriter(Vec::new());
595 self.node.write(&mut w).unwrap();
596 <(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 {
597 default_config: *self.node.get_current_default_configuration(),
598 entropy_source: self.keys_manager,
599 node_signer: self.keys_manager,
600 signer_provider: self.keys_manager,
601 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
602 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
603 chain_monitor: self.chain_monitor,
604 tx_broadcaster: &broadcaster,
605 logger: &self.logger,
610 let persister = test_utils::TestPersister::new();
611 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
612 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
613 for deserialized_monitor in deserialized_monitors.drain(..) {
614 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != Ok(ChannelMonitorUpdateStatus::Completed) {
618 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
619 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
624 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) {
625 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
628 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) {
629 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
630 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
631 (announcement, as_update, bs_update, channel_id, tx)
634 /// Gets an RAA and CS which were sent in response to a commitment update
635 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
636 let events = node.node().get_and_clear_pending_msg_events();
637 assert_eq!(events.len(), 2);
639 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
640 assert_eq!(node_id, recipient);
643 _ => panic!("Unexpected event"),
645 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
646 assert_eq!(node_id, recipient);
647 assert!(updates.update_add_htlcs.is_empty());
648 assert!(updates.update_fulfill_htlcs.is_empty());
649 assert!(updates.update_fail_htlcs.is_empty());
650 assert!(updates.update_fail_malformed_htlcs.is_empty());
651 assert!(updates.update_fee.is_none());
652 updates.commitment_signed.clone()
654 _ => panic!("Unexpected event"),
659 /// Gets an RAA and CS which were sent in response to a commitment update
661 /// Don't use this, use the identically-named function instead.
662 macro_rules! get_revoke_commit_msgs {
663 ($node: expr, $node_id: expr) => {
664 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
668 /// Get an specific event message from the pending events queue.
670 macro_rules! get_event_msg {
671 ($node: expr, $event_type: path, $node_id: expr) => {
673 let events = $node.node.get_and_clear_pending_msg_events();
674 assert_eq!(events.len(), 1);
676 $event_type { ref node_id, ref msg } => {
677 assert_eq!(*node_id, $node_id);
680 _ => panic!("Unexpected event"),
686 /// Get an error message from the pending events queue.
687 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
688 let events = node.node.get_and_clear_pending_msg_events();
689 assert_eq!(events.len(), 1);
691 MessageSendEvent::HandleError {
692 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
694 assert_eq!(node_id, recipient);
697 MessageSendEvent::HandleError {
698 action: msgs::ErrorAction::DisconnectPeer { ref msg }, ref node_id
700 assert_eq!(node_id, recipient);
701 msg.as_ref().unwrap().clone()
703 _ => panic!("Unexpected event"),
707 /// Get a specific event from the pending events queue.
709 macro_rules! get_event {
710 ($node: expr, $event_type: path) => {
712 let mut events = $node.node.get_and_clear_pending_events();
713 assert_eq!(events.len(), 1);
714 let ev = events.pop().unwrap();
716 $event_type { .. } => {
719 _ => panic!("Unexpected event"),
725 /// Gets an UpdateHTLCs MessageSendEvent
726 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
727 let events = node.node.get_and_clear_pending_msg_events();
728 assert_eq!(events.len(), 1);
730 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
731 assert_eq!(node_id, recipient);
734 _ => panic!("Unexpected event"),
739 /// Gets an UpdateHTLCs MessageSendEvent
741 /// Don't use this, use the identically-named function instead.
742 macro_rules! get_htlc_update_msgs {
743 ($node: expr, $node_id: expr) => {
744 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
748 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
749 /// Returns the `msg_event`.
751 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
752 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
753 /// such messages are intended to all peers.
754 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
755 let ev_index = msg_events.iter().position(|e| { match e {
756 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
757 node_id == msg_node_id
759 MessageSendEvent::SendOpenChannel { node_id, .. } => {
760 node_id == msg_node_id
762 MessageSendEvent::SendFundingCreated { node_id, .. } => {
763 node_id == msg_node_id
765 MessageSendEvent::SendFundingSigned { node_id, .. } => {
766 node_id == msg_node_id
768 MessageSendEvent::SendChannelReady { node_id, .. } => {
769 node_id == msg_node_id
771 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
772 node_id == msg_node_id
774 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
775 node_id == msg_node_id
777 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
778 node_id == msg_node_id
780 MessageSendEvent::SendClosingSigned { node_id, .. } => {
781 node_id == msg_node_id
783 MessageSendEvent::SendShutdown { node_id, .. } => {
784 node_id == msg_node_id
786 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
787 node_id == msg_node_id
789 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
790 node_id == msg_node_id
792 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
795 MessageSendEvent::BroadcastChannelUpdate { .. } => {
798 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
801 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
802 node_id == msg_node_id
804 MessageSendEvent::HandleError { node_id, .. } => {
805 node_id == msg_node_id
807 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
808 node_id == msg_node_id
810 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
811 node_id == msg_node_id
813 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
814 node_id == msg_node_id
816 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
817 node_id == msg_node_id
819 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
820 node_id == msg_node_id
822 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
823 node_id == msg_node_id
825 MessageSendEvent::SendStfu { node_id, .. } => {
826 node_id == msg_node_id
828 MessageSendEvent::SendSplice { node_id, .. } => {
829 node_id == msg_node_id
831 MessageSendEvent::SendSpliceAck { node_id, .. } => {
832 node_id == msg_node_id
834 MessageSendEvent::SendSpliceLocked { node_id, .. } => {
835 node_id == msg_node_id
837 MessageSendEvent::SendTxAddInput { node_id, .. } => {
838 node_id == msg_node_id
840 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
841 node_id == msg_node_id
843 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
844 node_id == msg_node_id
846 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
847 node_id == msg_node_id
849 MessageSendEvent::SendTxComplete { node_id, .. } => {
850 node_id == msg_node_id
852 MessageSendEvent::SendTxSignatures { node_id, .. } => {
853 node_id == msg_node_id
855 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
856 node_id == msg_node_id
858 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
859 node_id == msg_node_id
861 MessageSendEvent::SendTxAbort { node_id, .. } => {
862 node_id == msg_node_id
865 if ev_index.is_some() {
866 msg_events.remove(ev_index.unwrap())
868 panic!("Couldn't find any MessageSendEvent to the node!")
873 macro_rules! get_channel_ref {
874 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
876 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
877 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
878 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
884 macro_rules! get_feerate {
885 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
887 let mut per_peer_state_lock;
888 let mut peer_state_lock;
889 let phase = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
890 phase.context().get_feerate_sat_per_1000_weight()
896 macro_rules! get_channel_type_features {
897 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
899 let mut per_peer_state_lock;
900 let mut peer_state_lock;
901 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
902 chan.context().get_channel_type().clone()
907 /// Returns a channel monitor given a channel id, making some naive assumptions
909 macro_rules! get_monitor {
910 ($node: expr, $channel_id: expr) => {
912 use bitcoin::hashes::Hash;
913 let mut monitor = None;
914 // Assume funding vout is either 0 or 1 blindly
916 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
917 $crate::chain::transaction::OutPoint {
918 txid: bitcoin::Txid::from_slice(&$channel_id.0[..]).unwrap(), index
930 /// Returns any local commitment transactions for the channel.
932 macro_rules! get_local_commitment_txn {
933 ($node: expr, $channel_id: expr) => {
935 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
940 /// Check the error from attempting a payment.
942 macro_rules! unwrap_send_err {
943 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
945 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
946 assert_eq!(fails.len(), 1);
952 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
953 assert_eq!(results.len(), 1);
955 Err($type) => { $check },
959 &Err(PaymentSendFailure::PathParameterError(ref result)) if !$all_failed => {
960 assert_eq!(result.len(), 1);
962 Err($type) => { $check },
971 /// Check whether N channel monitor(s) have been added.
972 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
973 if let Some(chain_monitor) = node.chain_monitor() {
974 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
975 let n = added_monitors.len();
976 assert_eq!(n, count, "expected {} monitors to be added, not {}", count, n);
977 added_monitors.clear();
981 /// Check whether N channel monitor(s) have been added.
983 /// Don't use this, use the identically-named function instead.
985 macro_rules! check_added_monitors {
986 ($node: expr, $count: expr) => {
987 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
991 /// Checks whether the claimed HTLC for the specified path has the correct channel information.
993 /// This will panic if the path is empty, if the HTLC's channel ID is not actually a channel that
994 /// connects the final two nodes in the path, or if the `user_channel_id` is incorrect.
995 pub fn check_claimed_htlc_channel<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, path: &[&Node<'a, 'b, 'c>], htlc: &ClaimedHTLC) {
996 let mut nodes = path.iter().rev();
997 let dest = nodes.next().expect("path should have a destination").node;
998 let prev = nodes.next().unwrap_or(&origin_node).node;
999 let dest_channels = dest.list_channels();
1000 let ch = dest_channels.iter().find(|ch| ch.channel_id == htlc.channel_id)
1001 .expect("HTLC's channel should be one of destination node's channels");
1002 assert_eq!(htlc.user_channel_id, ch.user_channel_id);
1003 assert_eq!(ch.counterparty.node_id, prev.get_our_node_id());
1006 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> {
1007 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
1008 for encoded in monitors_encoded {
1009 let mut monitor_read = &encoded[..];
1010 let (_, monitor) = <(BlockHash, ChannelMonitor<TestChannelSigner>)>
1011 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
1012 assert!(monitor_read.is_empty());
1013 monitors_read.push(monitor);
1016 let mut node_read = &chanman_encoded[..];
1017 let (_, node_deserialized) = {
1018 let mut channel_monitors = HashMap::new();
1019 for monitor in monitors_read.iter_mut() {
1020 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
1022 <(BlockHash, TestChannelManager<'b, 'c>)>::read(&mut node_read, ChannelManagerReadArgs {
1024 entropy_source: node.keys_manager,
1025 node_signer: node.keys_manager,
1026 signer_provider: node.keys_manager,
1027 fee_estimator: node.fee_estimator,
1028 router: node.router,
1029 chain_monitor: node.chain_monitor,
1030 tx_broadcaster: node.tx_broadcaster,
1031 logger: node.logger,
1035 assert!(node_read.is_empty());
1037 for monitor in monitors_read.drain(..) {
1038 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
1039 Ok(ChannelMonitorUpdateStatus::Completed));
1040 check_added_monitors!(node, 1);
1047 macro_rules! reload_node {
1048 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1049 let chanman_encoded = $chanman_encoded;
1051 $persister = test_utils::TestPersister::new();
1052 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
1053 $node.chain_monitor = &$new_chain_monitor;
1055 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
1056 $node.node = &$new_channelmanager;
1058 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
1059 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
1063 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1064 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1065 -> (ChannelId, Transaction, OutPoint)
1067 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, false)
1070 pub fn create_coinbase_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1071 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128)
1072 -> (ChannelId, Transaction, OutPoint)
1074 internal_create_funding_transaction(node, expected_counterparty_node_id, expected_chan_value, expected_user_chan_id, true)
1077 fn internal_create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>,
1078 expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128,
1079 coinbase: bool) -> (ChannelId, Transaction, OutPoint) {
1080 let chan_id = *node.network_chan_count.borrow();
1082 let events = node.node.get_and_clear_pending_events();
1083 assert_eq!(events.len(), 1);
1085 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
1086 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
1087 assert_eq!(*channel_value_satoshis, expected_chan_value);
1088 assert_eq!(user_channel_id, expected_user_chan_id);
1090 let input = if coinbase {
1092 previous_output: bitcoin::OutPoint::null(),
1093 ..Default::default()
1099 let tx = Transaction { version: chan_id as i32, lock_time: LockTime::ZERO, input, output: vec![TxOut {
1100 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
1102 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
1103 (*temporary_channel_id, tx, funding_outpoint)
1105 _ => panic!("Unexpected event"),
1109 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 {
1110 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
1111 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
1113 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
1114 check_added_monitors!(node_a, 0);
1116 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
1117 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
1118 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
1120 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
1121 assert_eq!(added_monitors.len(), 1);
1122 assert_eq!(added_monitors[0].0, funding_output);
1123 added_monitors.clear();
1125 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1127 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()));
1129 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1130 assert_eq!(added_monitors.len(), 1);
1131 assert_eq!(added_monitors[0].0, funding_output);
1132 added_monitors.clear();
1134 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1136 let events_4 = node_a.node.get_and_clear_pending_events();
1137 assert_eq!(events_4.len(), 0);
1139 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1140 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1141 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1143 // Ensure that funding_transaction_generated is idempotent.
1144 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1145 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1146 check_added_monitors!(node_a, 0);
1151 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1152 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) {
1153 let initiator_channels = initiator.node.list_usable_channels().len();
1154 let receiver_channels = receiver.node.list_usable_channels().len();
1156 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, None, initiator_config).unwrap();
1157 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1159 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1160 let events = receiver.node.get_and_clear_pending_events();
1161 assert_eq!(events.len(), 1);
1163 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1164 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1166 _ => panic!("Unexpected event"),
1169 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1170 assert_eq!(accept_channel.minimum_depth, 0);
1171 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1173 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1174 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1175 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1177 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1178 check_added_monitors!(receiver, 1);
1179 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1180 assert_eq!(bs_signed_locked.len(), 2);
1181 let as_channel_ready;
1182 match &bs_signed_locked[0] {
1183 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1184 assert_eq!(*node_id, initiator.node.get_our_node_id());
1185 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1186 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1187 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1188 check_added_monitors!(initiator, 1);
1190 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1191 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1193 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1195 _ => panic!("Unexpected event"),
1197 match &bs_signed_locked[1] {
1198 MessageSendEvent::SendChannelReady { node_id, msg } => {
1199 assert_eq!(*node_id, initiator.node.get_our_node_id());
1200 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1201 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1203 _ => panic!("Unexpected event"),
1206 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1207 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1209 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1210 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1212 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1213 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1215 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1216 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1218 (tx, as_channel_ready.channel_id)
1221 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 {
1222 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None, None).unwrap();
1223 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1224 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1225 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1226 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1227 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1228 let events = node_b.node.get_and_clear_pending_events();
1229 assert_eq!(events.len(), 1);
1231 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1232 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1233 _ => panic!("Unexpected event"),
1236 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1237 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1238 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1239 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1241 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1244 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) {
1245 confirm_transaction_at(node_conf, tx, conf_height);
1246 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1247 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()));
1250 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) {
1252 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1253 assert_eq!(events_6.len(), 3);
1254 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1255 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1257 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1258 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1260 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1261 ((match events_6[0] {
1262 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1263 channel_id = msg.channel_id.clone();
1264 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1267 _ => panic!("Unexpected event"),
1268 }, match events_6[announcement_sigs_idx] {
1269 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1270 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1273 _ => panic!("Unexpected event"),
1277 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) {
1278 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1279 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1280 confirm_transaction_at(node_a, tx, conf_height);
1281 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1282 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1283 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1286 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) {
1287 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1288 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1292 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) {
1293 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1294 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1295 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1297 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1298 assert_eq!(events_7.len(), 1);
1299 let (announcement, bs_update) = match events_7[0] {
1300 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1301 (msg, update_msg.clone().unwrap())
1303 _ => panic!("Unexpected event"),
1306 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1307 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1308 assert_eq!(events_8.len(), 1);
1309 let as_update = match events_8[0] {
1310 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1311 assert!(*announcement == *msg);
1312 let update_msg = update_msg.clone().unwrap();
1313 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1314 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1317 _ => panic!("Unexpected event"),
1320 *node_a.network_chan_count.borrow_mut() += 1;
1322 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1323 ((*announcement).clone(), as_update, bs_update)
1326 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) {
1327 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1330 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) {
1331 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1332 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1333 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1336 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) {
1337 let mut no_announce_cfg = test_default_channel_config();
1338 no_announce_cfg.channel_handshake_config.announced_channel = false;
1339 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, None, Some(no_announce_cfg)).unwrap();
1340 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1341 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1342 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1343 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1345 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1346 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1347 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()));
1348 check_added_monitors!(nodes[b], 1);
1350 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1351 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1353 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1354 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1355 check_added_monitors!(nodes[a], 1);
1357 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1358 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1359 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1361 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1362 confirm_transaction_at(&nodes[a], &tx, conf_height);
1363 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1364 confirm_transaction_at(&nodes[b], &tx, conf_height);
1365 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1366 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1367 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()));
1368 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1369 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1370 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1371 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1372 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1374 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1375 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1377 let mut found_a = false;
1378 for chan in nodes[a].node.list_usable_channels() {
1379 if chan.channel_id == as_channel_ready.channel_id {
1382 assert!(!chan.is_public);
1387 let mut found_b = false;
1388 for chan in nodes[b].node.list_usable_channels() {
1389 if chan.channel_id == as_channel_ready.channel_id {
1392 assert!(!chan.is_public);
1397 (as_channel_ready, tx)
1400 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) {
1402 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1403 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1404 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1406 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1407 // forwarding info for local channels even if its not accepted in the network graph.
1408 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1409 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1413 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1414 for outp in tx.output.iter() {
1415 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1417 let mut total_value_in = 0;
1418 for input in tx.input.iter() {
1419 total_value_in += get_output(&input.previous_output).unwrap().value;
1421 let mut total_value_out = 0;
1422 for output in tx.output.iter() {
1423 total_value_out += output.value;
1425 let min_fee = (tx.weight().to_wu() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1426 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1427 assert!(total_value_out + min_fee <= total_value_in);
1428 tx.verify(get_output).unwrap();
1432 macro_rules! check_spends {
1433 ($tx: expr, $($spends_txn: expr),*) => {
1436 for outp in $spends_txn.output.iter() {
1437 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1440 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1442 if out_point.txid == $spends_txn.txid() {
1443 return $spends_txn.output.get(out_point.vout as usize).cloned()
1448 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1453 macro_rules! get_closing_signed_broadcast {
1454 ($node: expr, $dest_pubkey: expr) => {
1456 let events = $node.get_and_clear_pending_msg_events();
1457 assert!(events.len() == 1 || events.len() == 2);
1458 (match events[events.len() - 1] {
1459 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1460 assert_eq!(msg.contents.flags & 2, 2);
1463 _ => panic!("Unexpected event"),
1464 }, if events.len() == 2 {
1466 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1467 assert_eq!(*node_id, $dest_pubkey);
1470 _ => panic!("Unexpected event"),
1478 macro_rules! check_warn_msg {
1479 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1480 let msg_events = $node.node.get_and_clear_pending_msg_events();
1481 assert_eq!(msg_events.len(), 1);
1482 match msg_events[0] {
1483 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1484 assert_eq!(node_id, $recipient_node_id);
1485 assert_eq!(msg.channel_id, $chan_id);
1488 _ => panic!("Unexpected event"),
1493 /// Check that a channel's closing channel update has been broadcasted, and optionally
1494 /// check whether an error message event has occurred.
1495 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1496 let msg_events = node.node.get_and_clear_pending_msg_events();
1497 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1498 msg_events.into_iter().filter_map(|msg_event| {
1500 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1501 assert_eq!(msg.contents.flags & 2, 2);
1504 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { msg }, node_id: _ } => {
1505 assert!(with_error_msg);
1506 // TODO: Check node_id
1509 MessageSendEvent::HandleError { action: msgs::ErrorAction::DisconnectPeer { msg }, node_id: _ } => {
1510 assert!(with_error_msg);
1511 // TODO: Check node_id
1514 _ => panic!("Unexpected event"),
1519 /// Check that a channel's closing channel update has been broadcasted, and optionally
1520 /// check whether an error message event has occurred.
1522 /// Don't use this, use the identically-named function instead.
1524 macro_rules! check_closed_broadcast {
1525 ($node: expr, $with_error_msg: expr) => {
1526 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1531 pub struct ExpectedCloseEvent {
1532 pub channel_capacity_sats: Option<u64>,
1533 pub channel_id: Option<ChannelId>,
1534 pub counterparty_node_id: Option<PublicKey>,
1535 pub discard_funding: bool,
1536 pub reason: Option<ClosureReason>,
1539 /// Check that multiple channel closing events have been issued.
1540 pub fn check_closed_events(node: &Node, expected_close_events: &[ExpectedCloseEvent]) {
1541 let closed_events_count = expected_close_events.len();
1542 let discard_events_count = expected_close_events.iter().filter(|e| e.discard_funding).count();
1543 let events = node.node.get_and_clear_pending_events();
1544 assert_eq!(events.len(), closed_events_count + discard_events_count, "{:?}", events);
1545 for expected_event in expected_close_events {
1546 assert!(events.iter().any(|e| matches!(
1548 Event::ChannelClosed {
1551 counterparty_node_id,
1552 channel_capacity_sats,
1555 expected_event.channel_id.map(|expected| *channel_id == expected).unwrap_or(true) &&
1556 expected_event.reason.as_ref().map(|expected| reason == expected).unwrap_or(true) &&
1557 expected_event.counterparty_node_id.map(|expected| *counterparty_node_id == Some(expected)).unwrap_or(true) &&
1558 expected_event.channel_capacity_sats.map(|expected| *channel_capacity_sats == Some(expected)).unwrap_or(true)
1562 assert_eq!(events.iter().filter(|e| matches!(
1564 Event::DiscardFunding { .. },
1565 )).count(), discard_events_count);
1568 /// Check that a channel's closing channel events has been issued
1569 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool,
1570 expected_counterparty_node_ids: &[PublicKey], expected_channel_capacity: u64) {
1571 let expected_events_count = if is_check_discard_funding {
1572 2 * expected_counterparty_node_ids.len()
1574 expected_counterparty_node_ids.len()
1576 assert_eq!(events_count, expected_events_count);
1577 let expected_close_events = expected_counterparty_node_ids.iter().map(|node_id| ExpectedCloseEvent {
1578 channel_capacity_sats: Some(expected_channel_capacity),
1580 counterparty_node_id: Some(*node_id),
1581 discard_funding: is_check_discard_funding,
1582 reason: Some(expected_reason.clone()),
1583 }).collect::<Vec<_>>();
1584 check_closed_events(node, expected_close_events.as_slice());
1587 /// Check that a channel's closing channel events has been issued
1589 /// Don't use this, use the identically-named function instead.
1591 macro_rules! check_closed_event {
1592 ($node: expr, $events: expr, $reason: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1593 check_closed_event!($node, $events, $reason, false, $counterparty_node_ids, $channel_capacity);
1595 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr, $counterparty_node_ids: expr, $channel_capacity: expr) => {
1596 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason,
1597 $is_check_discard_funding, &$counterparty_node_ids, $channel_capacity);
1601 pub fn handle_bump_htlc_event(node: &Node, count: usize) {
1602 let events = node.chain_monitor.chain_monitor.get_and_clear_pending_events();
1603 assert_eq!(events.len(), count);
1604 for event in events {
1606 Event::BumpTransaction(bump_event) => {
1607 if let BumpTransactionEvent::HTLCResolution { .. } = &bump_event {}
1609 node.bump_tx_handler.handle_event(&bump_event);
1616 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) {
1617 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) };
1618 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) };
1621 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1622 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1624 let events_1 = node_b.get_and_clear_pending_msg_events();
1625 assert!(events_1.len() >= 1);
1626 let shutdown_b = match events_1[0] {
1627 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1628 assert_eq!(node_id, &node_a.get_our_node_id());
1631 _ => panic!("Unexpected event"),
1634 let closing_signed_b = if !close_inbound_first {
1635 assert_eq!(events_1.len(), 1);
1638 Some(match events_1[1] {
1639 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1640 assert_eq!(node_id, &node_a.get_our_node_id());
1643 _ => panic!("Unexpected event"),
1647 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1648 let (as_update, bs_update) = if close_inbound_first {
1649 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1650 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1652 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1653 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1654 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1655 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1657 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1658 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1659 assert!(none_a.is_none());
1660 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1661 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1662 (as_update, bs_update)
1664 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1666 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1667 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1669 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1670 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1671 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1673 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1674 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1675 assert!(none_b.is_none());
1676 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1677 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1678 (as_update, bs_update)
1680 assert_eq!(tx_a, tx_b);
1681 check_spends!(tx_a, funding_tx);
1683 (as_update, bs_update, tx_a)
1686 pub struct SendEvent {
1687 pub node_id: PublicKey,
1688 pub msgs: Vec<msgs::UpdateAddHTLC>,
1689 pub commitment_msg: msgs::CommitmentSigned,
1692 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1693 assert!(updates.update_fulfill_htlcs.is_empty());
1694 assert!(updates.update_fail_htlcs.is_empty());
1695 assert!(updates.update_fail_malformed_htlcs.is_empty());
1696 assert!(updates.update_fee.is_none());
1697 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1700 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1702 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1703 _ => panic!("Unexpected event type!"),
1707 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1708 let mut events = node.node.get_and_clear_pending_msg_events();
1709 assert_eq!(events.len(), 1);
1710 SendEvent::from_event(events.pop().unwrap())
1715 /// Don't use this, use the identically-named function instead.
1716 macro_rules! expect_pending_htlcs_forwardable_conditions {
1717 ($node: expr, $expected_failures: expr) => {
1718 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1723 macro_rules! expect_htlc_handling_failed_destinations {
1724 ($events: expr, $expected_failures: expr) => {{
1725 for event in $events {
1727 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1728 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1729 assert!($expected_failures.contains(&failed_next_destination))
1731 _ => panic!("Unexpected destination"),
1737 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1738 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1739 /// `expected_failures` set.
1740 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1742 Event::PendingHTLCsForwardable { .. } => { },
1743 _ => panic!("Unexpected event {:?}", events),
1746 let count = expected_failures.len() + 1;
1747 assert_eq!(events.len(), count);
1749 if expected_failures.len() > 0 {
1750 expect_htlc_handling_failed_destinations!(events, expected_failures)
1755 /// Clears (and ignores) a PendingHTLCsForwardable event
1757 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1759 macro_rules! expect_pending_htlcs_forwardable_ignore {
1761 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1766 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1768 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1769 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1770 ($node: expr, $expected_failures: expr) => {
1771 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1776 /// Handles a PendingHTLCsForwardable event
1777 macro_rules! expect_pending_htlcs_forwardable {
1779 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1780 $node.node.process_pending_htlc_forwards();
1782 // Ensure process_pending_htlc_forwards is idempotent.
1783 $node.node.process_pending_htlc_forwards();
1788 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1789 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1790 ($node: expr, $expected_failures: expr) => {{
1791 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1792 $node.node.process_pending_htlc_forwards();
1794 // Ensure process_pending_htlc_forwards is idempotent.
1795 $node.node.process_pending_htlc_forwards();
1800 macro_rules! expect_pending_htlcs_forwardable_from_events {
1801 ($node: expr, $events: expr, $ignore: expr) => {{
1802 assert_eq!($events.len(), 1);
1804 Event::PendingHTLCsForwardable { .. } => { },
1805 _ => panic!("Unexpected event"),
1808 $node.node.process_pending_htlc_forwards();
1810 // Ensure process_pending_htlc_forwards is idempotent.
1811 $node.node.process_pending_htlc_forwards();
1817 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1818 /// commitment update.
1819 macro_rules! commitment_signed_dance {
1820 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1821 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1823 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1824 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1826 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1828 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1829 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1830 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1831 check_added_monitors(&$node_a, 1);
1832 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1833 assert!(extra_msg_option.is_none());
1837 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */, $incl_claim: expr) => {
1838 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards, $incl_claim).is_none());
1840 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1841 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1845 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1846 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1847 /// `revoke_and_ack` response to it.
1849 /// An HTLC claim on one channel blocks the RAA channel monitor update for the outbound edge
1850 /// channel until the inbound edge channel preimage monitor update completes. Thus, when checking
1851 /// for channel monitor updates, we need to know if an `update_fulfill_htlc` was included in the
1852 /// the commitment we're exchanging. `includes_claim` provides that information.
1854 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1855 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool, includes_claim: bool) -> Option<MessageSendEvent> {
1856 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1857 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1858 check_added_monitors(node_a, if includes_claim { 0 } else { 1 });
1862 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1863 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1864 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1866 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1867 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1868 check_added_monitors!(node_b, 0);
1869 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1870 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1871 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1872 check_added_monitors!(node_b, 1);
1873 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1874 let (bs_revoke_and_ack, extra_msg_option) = {
1875 let mut events = node_b.node.get_and_clear_pending_msg_events();
1876 assert!(events.len() <= 2);
1877 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1878 (match node_a_event {
1879 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1880 assert_eq!(*node_id, node_a.node.get_our_node_id());
1883 _ => panic!("Unexpected event"),
1884 }, events.get(0).map(|e| e.clone()))
1886 check_added_monitors!(node_b, 1);
1888 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1889 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1891 (extra_msg_option, bs_revoke_and_ack)
1894 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1895 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1897 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1898 /// on failure or that no new messages are left over on success.
1899 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1900 check_added_monitors!(node_a, 0);
1901 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1902 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1903 check_added_monitors!(node_a, 1);
1905 // If this commitment signed dance was due to a claim, don't check for an RAA monitor update.
1906 let got_claim = node_a.node.test_raa_monitor_updates_held(node_b.node.get_our_node_id(), commitment_signed.channel_id);
1907 if fail_backwards { assert!(!got_claim); }
1908 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false, got_claim);
1910 if skip_last_step { return; }
1913 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1914 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1915 check_added_monitors!(node_a, 1);
1917 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1918 let mut number_of_msg_events = 0;
1919 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1920 let peer_state = peer_state_mutex.lock().unwrap();
1921 let cp_pending_msg_events = &peer_state.pending_msg_events;
1922 number_of_msg_events += cp_pending_msg_events.len();
1923 if cp_pending_msg_events.len() == 1 {
1924 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1925 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1926 } else { panic!("Unexpected event"); }
1929 // Expecting the failure backwards event to the previous hop (not `node_b`)
1930 assert_eq!(number_of_msg_events, 1);
1932 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1936 /// Get a payment preimage and hash.
1937 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1938 let mut payment_count = recipient.network_payment_count.borrow_mut();
1939 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1940 *payment_count += 1;
1941 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).to_byte_array());
1942 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1943 (payment_preimage, payment_hash, payment_secret)
1946 /// Get a payment preimage and hash.
1948 /// Don't use this, use the identically-named function instead.
1950 macro_rules! get_payment_preimage_hash {
1951 ($dest_node: expr) => {
1952 get_payment_preimage_hash!($dest_node, None)
1954 ($dest_node: expr, $min_value_msat: expr) => {
1955 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1957 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1958 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1962 /// Gets a route from the given sender to the node described in `payment_params`.
1963 pub fn get_route(send_node: &Node, route_params: &RouteParameters) -> Result<Route, msgs::LightningError> {
1964 let scorer = TestScorer::new();
1965 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1966 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1968 &send_node.node.get_our_node_id(), route_params, &send_node.network_graph.read_only(),
1969 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1970 send_node.logger, &scorer, &Default::default(), &random_seed_bytes
1974 /// Gets a route from the given sender to the node described in `payment_params`.
1976 /// Don't use this, use the identically-named function instead.
1978 macro_rules! get_route {
1979 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {{
1980 let route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1981 $crate::ln::functional_test_utils::get_route(&$send_node, &route_params)
1987 macro_rules! get_route_and_payment_hash {
1988 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1989 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1990 .with_bolt11_features($recv_node.node.bolt11_invoice_features()).unwrap();
1991 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1993 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1994 $crate::get_route_and_payment_hash!($send_node, $recv_node, $payment_params, $recv_value, None)
1996 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $max_total_routing_fee_msat: expr) => {{
1997 let mut route_params = $crate::routing::router::RouteParameters::from_payment_params_and_value($payment_params, $recv_value);
1998 route_params.max_total_routing_fee_msat = $max_total_routing_fee_msat;
1999 let (payment_preimage, payment_hash, payment_secret) =
2000 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
2001 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &route_params);
2002 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
2006 pub fn check_payment_claimable(
2007 event: &Event, expected_payment_hash: PaymentHash, expected_payment_secret: PaymentSecret,
2008 expected_recv_value: u64, expected_payment_preimage: Option<PaymentPreimage>,
2009 expected_receiver_node_id: PublicKey,
2012 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
2013 assert_eq!(expected_payment_hash, *payment_hash);
2014 assert_eq!(expected_recv_value, *amount_msat);
2015 assert_eq!(expected_receiver_node_id, receiver_node_id.unwrap());
2017 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2018 assert_eq!(&expected_payment_preimage, payment_preimage);
2019 assert_eq!(expected_payment_secret, *payment_secret);
2024 _ => panic!("Unexpected event"),
2029 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2030 macro_rules! expect_payment_claimable {
2031 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
2032 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
2034 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
2035 let events = $node.node.get_and_clear_pending_events();
2036 assert_eq!(events.len(), 1);
2037 $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)
2042 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2043 macro_rules! expect_payment_claimed {
2044 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
2045 let events = $node.node.get_and_clear_pending_events();
2046 assert_eq!(events.len(), 1);
2048 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
2049 assert_eq!($expected_payment_hash, *payment_hash);
2050 assert_eq!($expected_recv_value, amount_msat);
2052 _ => panic!("Unexpected event"),
2057 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
2058 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
2059 expect_per_path_claims: bool, expect_post_ev_mon_update: bool,
2061 let events = node.node().get_and_clear_pending_events();
2062 let expected_payment_hash = PaymentHash(
2063 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).to_byte_array());
2064 if expect_per_path_claims {
2065 assert!(events.len() > 1);
2067 assert_eq!(events.len(), 1);
2069 if expect_post_ev_mon_update {
2070 check_added_monitors(node, 1);
2072 let expected_payment_id = match events[0] {
2073 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
2074 assert_eq!(expected_payment_preimage, *payment_preimage);
2075 assert_eq!(expected_payment_hash, *payment_hash);
2076 if let Some(expected_fee_msat) = expected_fee_msat_opt {
2077 assert_eq!(*fee_paid_msat, expected_fee_msat);
2079 assert!(fee_paid_msat.is_some());
2083 _ => panic!("Unexpected event"),
2085 if expect_per_path_claims {
2086 for i in 1..events.len() {
2088 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
2089 assert_eq!(payment_id, expected_payment_id);
2090 assert_eq!(payment_hash, Some(expected_payment_hash));
2092 _ => panic!("Unexpected event"),
2099 macro_rules! expect_payment_sent {
2100 ($node: expr, $expected_payment_preimage: expr) => {
2101 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
2103 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
2104 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
2106 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
2107 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
2108 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths, true);
2114 macro_rules! expect_payment_path_successful {
2116 let events = $node.node.get_and_clear_pending_events();
2117 assert_eq!(events.len(), 1);
2119 $crate::events::Event::PaymentPathSuccessful { .. } => {},
2120 _ => panic!("Unexpected event"),
2125 pub fn expect_payment_forwarded<CM: AChannelManager, H: NodeHolder<CM=CM>>(
2126 event: Event, node: &H, prev_node: &H, next_node: &H, expected_fee: Option<u64>,
2127 upstream_force_closed: bool, downstream_force_closed: bool
2130 Event::PaymentForwarded {
2131 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
2132 outbound_amount_forwarded_msat: _
2134 assert_eq!(fee_earned_msat, expected_fee);
2135 if !upstream_force_closed {
2136 // Is the event prev_channel_id in one of the channels between the two nodes?
2137 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()));
2139 // We check for force closures since a force closed channel is removed from the
2140 // node's channel list
2141 if !downstream_force_closed {
2142 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()));
2144 assert_eq!(claim_from_onchain_tx, downstream_force_closed);
2146 _ => panic!("Unexpected event"),
2150 macro_rules! expect_payment_forwarded {
2151 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
2152 let mut events = $node.node.get_and_clear_pending_events();
2153 assert_eq!(events.len(), 1);
2154 $crate::ln::functional_test_utils::expect_payment_forwarded(
2155 events.pop().unwrap(), &$node, &$prev_node, &$next_node, $expected_fee,
2156 $upstream_force_closed, $downstream_force_closed);
2162 macro_rules! expect_channel_shutdown_state {
2163 ($node: expr, $chan_id: expr, $state: path) => {
2164 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
2165 assert_eq!(chan_details.len(), 1);
2166 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
2170 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2171 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) -> ChannelId {
2172 let events = node.node.get_and_clear_pending_events();
2173 assert_eq!(events.len(), 1);
2175 crate::events::Event::ChannelPending { channel_id, counterparty_node_id, .. } => {
2176 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2179 _ => panic!("Unexpected event"),
2183 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
2184 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
2185 let events = node.node.get_and_clear_pending_events();
2186 assert_eq!(events.len(), 1);
2188 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
2189 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
2191 _ => panic!("Unexpected event"),
2195 #[cfg(any(test, feature = "_test_utils"))]
2196 pub fn expect_probe_successful_events(node: &Node, mut probe_results: Vec<(PaymentHash, PaymentId)>) {
2197 let mut events = node.node.get_and_clear_pending_events();
2199 for event in events.drain(..) {
2201 Event::ProbeSuccessful { payment_hash: ev_ph, payment_id: ev_pid, ..} => {
2202 let result_idx = probe_results.iter().position(|(payment_hash, payment_id)| *payment_hash == ev_ph && *payment_id == ev_pid);
2203 assert!(result_idx.is_some());
2205 probe_results.remove(result_idx.unwrap());
2211 // Ensure that we received a ProbeSuccessful event for each probe result.
2212 assert!(probe_results.is_empty());
2215 pub struct PaymentFailedConditions<'a> {
2216 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
2217 pub(crate) expected_blamed_scid: Option<u64>,
2218 pub(crate) expected_blamed_chan_closed: Option<bool>,
2219 pub(crate) expected_mpp_parts_remain: bool,
2222 impl<'a> PaymentFailedConditions<'a> {
2223 pub fn new() -> Self {
2225 expected_htlc_error_data: None,
2226 expected_blamed_scid: None,
2227 expected_blamed_chan_closed: None,
2228 expected_mpp_parts_remain: false,
2231 pub fn mpp_parts_remain(mut self) -> Self {
2232 self.expected_mpp_parts_remain = true;
2235 pub fn blamed_scid(mut self, scid: u64) -> Self {
2236 self.expected_blamed_scid = Some(scid);
2239 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2240 self.expected_blamed_chan_closed = Some(closed);
2243 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2244 self.expected_htlc_error_data = Some((code, data));
2250 macro_rules! expect_payment_failed_with_update {
2251 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2252 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2253 &$node, $expected_payment_hash, $payment_failed_permanently,
2254 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2255 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2260 macro_rules! expect_payment_failed {
2261 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2262 #[allow(unused_mut)]
2263 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2265 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2267 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2271 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2272 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2273 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2275 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2276 let expected_payment_id = match &payment_failed_events[0] {
2277 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2281 error_data, .. } => {
2282 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2283 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2286 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2287 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2288 if let Some((code, data)) = conditions.expected_htlc_error_data {
2289 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2290 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2294 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2295 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2297 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2298 if let Some(scid) = conditions.expected_blamed_scid {
2299 assert_eq!(msg.contents.short_channel_id, scid);
2301 const CHAN_DISABLED_FLAG: u8 = 2;
2302 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2304 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2305 if let Some(scid) = conditions.expected_blamed_scid {
2306 assert_eq!(*short_channel_id, scid);
2308 assert!(is_permanent);
2310 _ => panic!("Unexpected update type"),
2312 } else { panic!("Expected network update"); }
2317 _ => panic!("Unexpected event"),
2319 if !conditions.expected_mpp_parts_remain {
2320 match &payment_failed_events[1] {
2321 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2322 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2323 assert_eq!(*payment_id, expected_payment_id);
2324 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2325 PaymentFailureReason::RecipientRejected
2327 PaymentFailureReason::RetriesExhausted
2330 _ => panic!("Unexpected second event"),
2335 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2336 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2337 conditions: PaymentFailedConditions<'e>
2339 let events = node.node.get_and_clear_pending_events();
2340 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2343 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 {
2344 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2345 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2346 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2347 check_added_monitors!(origin_node, expected_paths.len());
2348 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2352 fn fail_payment_along_path<'a, 'b, 'c>(expected_path: &[&Node<'a, 'b, 'c>]) {
2353 let origin_node_id = expected_path[0].node.get_our_node_id();
2355 // iterate from the receiving node to the origin node and handle update fail htlc.
2356 for (&node, &prev_node) in expected_path.iter().rev().zip(expected_path.iter().rev().skip(1)) {
2357 let updates = get_htlc_update_msgs!(node, prev_node.node.get_our_node_id());
2358 prev_node.node.handle_update_fail_htlc(&node.node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2359 check_added_monitors!(prev_node, 0);
2361 let is_first_hop = origin_node_id == prev_node.node.get_our_node_id();
2362 // We do not want to fail backwards on the first hop. All other hops should fail backwards.
2363 commitment_signed_dance!(prev_node, node, updates.commitment_signed, !is_first_hop);
2367 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> {
2368 let mut payment_event = SendEvent::from_event(ev);
2369 let mut prev_node = origin_node;
2370 let mut event = None;
2372 for (idx, &node) in expected_path.iter().enumerate() {
2373 let is_last_hop = idx == expected_path.len() - 1;
2374 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2376 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2377 check_added_monitors!(node, 0);
2379 if is_last_hop && is_probe {
2380 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, true, true);
2382 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2383 expect_pending_htlcs_forwardable!(node);
2386 if is_last_hop && clear_recipient_events {
2387 let events_2 = node.node.get_and_clear_pending_events();
2388 if payment_claimable_expected {
2389 assert_eq!(events_2.len(), 1);
2390 match &events_2[0] {
2391 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2392 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2393 claim_deadline, onion_fields, ..
2395 assert_eq!(our_payment_hash, *payment_hash);
2396 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2397 assert!(onion_fields.is_some());
2399 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2400 assert_eq!(expected_preimage, *payment_preimage);
2401 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2402 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2404 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2405 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2406 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2409 assert_eq!(*amount_msat, recv_value);
2410 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2411 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2412 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2414 _ => panic!("Unexpected event"),
2416 event = Some(events_2[0].clone());
2418 assert!(events_2.is_empty());
2420 } else if !is_last_hop {
2421 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2422 assert_eq!(events_2.len(), 1);
2423 check_added_monitors!(node, 1);
2424 payment_event = SendEvent::from_event(events_2.remove(0));
2425 assert_eq!(payment_event.msgs.len(), 1);
2433 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> {
2434 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage, false)
2437 pub fn send_probe_along_route<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&[&Node<'a, 'b, 'c>]]) {
2438 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2439 assert_eq!(events.len(), expected_route.len());
2441 check_added_monitors!(origin_node, expected_route.len());
2443 for path in expected_route.iter() {
2444 let ev = remove_first_msg_event_to_node(&path[0].node.get_our_node_id(), &mut events);
2446 do_pass_along_path(origin_node, path, 0, PaymentHash([0_u8; 32]), None, ev, false, false, None, true);
2447 let nodes_to_fail_payment: Vec<_> = vec![origin_node].into_iter().chain(path.iter().cloned()).collect();
2449 fail_payment_along_path(nodes_to_fail_payment.as_slice());
2453 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) {
2454 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2455 assert_eq!(events.len(), expected_route.len());
2457 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2458 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2459 // Once we've gotten through all the HTLCs, the last one should result in a
2460 // PaymentClaimable (but each previous one should not!).
2461 let expect_payment = path_idx == expected_route.len() - 1;
2462 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2466 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) {
2467 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2468 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2469 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2472 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2473 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2474 our_payment_preimage: PaymentPreimage
2476 let extra_fees = vec![0; expected_paths.len()];
2477 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2478 &extra_fees[..], skip_last, our_payment_preimage)
2481 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2482 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2483 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2485 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2486 for path in expected_paths.iter() {
2487 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2489 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2490 pass_claimed_payment_along_route(origin_node, expected_paths, expected_extra_fees, skip_last, our_payment_preimage)
2493 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 {
2494 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2495 assert_eq!(claim_event.len(), 1);
2496 match claim_event[0] {
2497 Event::PaymentClaimed {
2498 purpose: PaymentPurpose::SpontaneousPayment(preimage),
2502 | Event::PaymentClaimed {
2503 purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..},
2508 assert_eq!(preimage, our_payment_preimage);
2509 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2510 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2511 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2513 Event::PaymentClaimed {
2514 purpose: PaymentPurpose::InvoicePayment { .. },
2520 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]);
2521 assert_eq!(htlcs.len(), expected_paths.len()); // One per path.
2522 assert_eq!(htlcs.iter().map(|h| h.value_msat).sum::<u64>(), amount_msat);
2523 expected_paths.iter().zip(htlcs).for_each(|(path, htlc)| check_claimed_htlc_channel(origin_node, path, htlc));
2528 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2530 let mut expected_total_fee_msat = 0;
2532 macro_rules! msgs_from_ev {
2535 &MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
2536 assert!(update_add_htlcs.is_empty());
2537 assert_eq!(update_fulfill_htlcs.len(), 1);
2538 assert!(update_fail_htlcs.is_empty());
2539 assert!(update_fail_malformed_htlcs.is_empty());
2540 assert!(update_fee.is_none());
2541 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2543 _ => panic!("Unexpected event"),
2547 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2548 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2549 assert_eq!(events.len(), expected_paths.len());
2551 if events.len() == 1 {
2552 per_path_msgs.push(msgs_from_ev!(&events[0]));
2554 for expected_path in expected_paths.iter() {
2555 // For MPP payments, we always want the message to the first node in the path.
2556 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2557 per_path_msgs.push(msgs_from_ev!(&ev));
2561 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2562 let mut next_msgs = Some(path_msgs);
2563 let mut expected_next_node = next_hop;
2565 macro_rules! last_update_fulfill_dance {
2566 ($node: expr, $prev_node: expr) => {
2568 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2569 check_added_monitors!($node, 0);
2570 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2571 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2575 macro_rules! mid_update_fulfill_dance {
2576 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2578 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2580 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2581 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2582 .unwrap().lock().unwrap();
2583 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2584 if let Some(prev_config) = channel.context().prev_config() {
2585 prev_config.forwarding_fee_base_msat
2587 channel.context().config().forwarding_fee_base_msat
2590 if $idx == 1 { fee += expected_extra_fees[i]; }
2591 expect_payment_forwarded!(*$node, $next_node, $prev_node, Some(fee as u64), false, false);
2592 expected_total_fee_msat += fee as u64;
2593 check_added_monitors!($node, 1);
2594 let new_next_msgs = if $new_msgs {
2595 let events = $node.node.get_and_clear_pending_msg_events();
2596 assert_eq!(events.len(), 1);
2597 let (res, nexthop) = msgs_from_ev!(&events[0]);
2598 expected_next_node = nexthop;
2601 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2604 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2605 next_msgs = new_next_msgs;
2610 let mut prev_node = expected_route.last().unwrap();
2611 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2612 assert_eq!(expected_next_node, node.node.get_our_node_id());
2613 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2614 if next_msgs.is_some() {
2615 // Since we are traversing in reverse, next_node is actually the previous node
2616 let next_node: &Node;
2617 if idx == expected_route.len() - 1 {
2618 next_node = origin_node;
2620 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2622 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2624 assert!(!update_next_msgs);
2625 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2627 if !skip_last && idx == expected_route.len() - 1 {
2628 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2635 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2639 // Ensure that claim_funds is idempotent.
2640 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2641 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2642 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2644 expected_total_fee_msat
2646 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) {
2647 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2649 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2653 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2654 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2657 pub const TEST_FINAL_CLTV: u32 = 70;
2659 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) {
2660 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2661 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2662 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2663 let route = get_route(origin_node, &route_params).unwrap();
2664 assert_eq!(route.paths.len(), 1);
2665 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2666 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2667 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2670 let res = send_along_route(origin_node, route, expected_route, recv_value);
2671 (res.0, res.1, res.2, res.3)
2674 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2675 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2676 .with_bolt11_features(expected_route.last().unwrap().node.bolt11_invoice_features()).unwrap();
2677 let route_params = RouteParameters::from_payment_params_and_value(payment_params, recv_value);
2678 let network_graph = origin_node.network_graph.read_only();
2679 let scorer = test_utils::TestScorer::new();
2680 let seed = [0u8; 32];
2681 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2682 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2683 let route = router::get_route(&origin_node.node.get_our_node_id(), &route_params, &network_graph,
2684 None, origin_node.logger, &scorer, &Default::default(), &random_seed_bytes).unwrap();
2685 assert_eq!(route.paths.len(), 1);
2686 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2687 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2688 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2691 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2692 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2693 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2694 true, APIError::ChannelUnavailable { ref err },
2695 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2698 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) {
2699 let res = route_payment(&origin, expected_route, recv_value);
2700 claim_payment(&origin, expected_route, res.0);
2704 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) {
2705 for path in expected_paths.iter() {
2706 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2708 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2709 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2710 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2712 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2715 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) {
2716 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2717 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2719 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2720 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2721 assert_eq!(events.len(), expected_paths.len());
2722 for ev in events.iter() {
2723 let (update_fail, commitment_signed, node_id) = match ev {
2724 &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 } } => {
2725 assert!(update_add_htlcs.is_empty());
2726 assert!(update_fulfill_htlcs.is_empty());
2727 assert_eq!(update_fail_htlcs.len(), 1);
2728 assert!(update_fail_malformed_htlcs.is_empty());
2729 assert!(update_fee.is_none());
2730 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2732 _ => panic!("Unexpected event"),
2734 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2736 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2737 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()));
2739 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2740 let mut next_msgs = Some(path_msgs);
2741 let mut expected_next_node = next_hop;
2742 let mut prev_node = expected_route.last().unwrap();
2744 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2745 assert_eq!(expected_next_node, node.node.get_our_node_id());
2746 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2747 if next_msgs.is_some() {
2748 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2749 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2750 if !update_next_node {
2751 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 }]);
2754 let events = node.node.get_and_clear_pending_msg_events();
2755 if update_next_node {
2756 assert_eq!(events.len(), 1);
2758 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 } } => {
2759 assert!(update_add_htlcs.is_empty());
2760 assert!(update_fulfill_htlcs.is_empty());
2761 assert_eq!(update_fail_htlcs.len(), 1);
2762 assert!(update_fail_malformed_htlcs.is_empty());
2763 assert!(update_fee.is_none());
2764 expected_next_node = node_id.clone();
2765 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2767 _ => panic!("Unexpected event"),
2770 assert!(events.is_empty());
2772 if !skip_last && idx == expected_route.len() - 1 {
2773 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2780 let prev_node = expected_route.first().unwrap();
2781 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2782 check_added_monitors!(origin_node, 0);
2783 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2784 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2785 let events = origin_node.node.get_and_clear_pending_events();
2786 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2788 let expected_payment_id = match events[0] {
2789 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2790 assert_eq!(payment_hash, our_payment_hash);
2791 assert!(payment_failed_permanently);
2792 for (idx, hop) in expected_route.iter().enumerate() {
2793 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2797 _ => panic!("Unexpected event"),
2799 if i == expected_paths.len() - 1 {
2801 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2802 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2803 assert_eq!(*payment_id, expected_payment_id);
2804 assert_eq!(reason.unwrap(), expected_fail_reason);
2806 _ => panic!("Unexpected second event"),
2812 // Ensure that fail_htlc_backwards is idempotent.
2813 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2814 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2815 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2816 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2819 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2820 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2823 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2824 let mut chan_mon_cfgs = Vec::new();
2825 for i in 0..node_count {
2826 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2827 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2828 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2829 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2830 let persister = test_utils::TestPersister::new();
2831 let seed = [i as u8; 32];
2832 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2833 let scorer = RwLock::new(test_utils::TestScorer::new());
2835 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2841 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2842 create_node_cfgs_with_persisters(node_count, chanmon_cfgs, chanmon_cfgs.iter().map(|c| &c.persister).collect())
2845 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>> {
2846 let mut nodes = Vec::new();
2848 for i in 0..node_count {
2849 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);
2850 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2851 let seed = [i as u8; 32];
2852 nodes.push(NodeCfg {
2853 chain_source: &chanmon_cfgs[i].chain_source,
2854 logger: &chanmon_cfgs[i].logger,
2855 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2856 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2857 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2859 keys_manager: &chanmon_cfgs[i].keys_manager,
2862 override_init_features: Rc::new(RefCell::new(None)),
2869 pub fn test_default_channel_config() -> UserConfig {
2870 let mut default_config = UserConfig::default();
2871 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2872 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2873 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2874 default_config.channel_handshake_config.announced_channel = true;
2875 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2876 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2877 // It now defaults to 1, so we simply set it to the expected value here.
2878 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2879 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2880 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2882 default_config.channel_config.max_dust_htlc_exposure =
2883 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2887 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>> {
2888 let mut chanmgrs = Vec::new();
2889 for i in 0..node_count {
2890 let network = Network::Testnet;
2891 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2892 let params = ChainParameters {
2894 best_block: BestBlock::from_network(network),
2896 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,
2897 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);
2898 chanmgrs.push(node);
2904 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>> {
2905 let mut nodes = Vec::new();
2906 let chan_count = Rc::new(RefCell::new(0));
2907 let payment_count = Rc::new(RefCell::new(0));
2908 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2910 for i in 0..node_count {
2911 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2912 let wallet_source = Arc::new(test_utils::TestWalletSource::new(SecretKey::from_slice(&[i as u8 + 1; 32]).unwrap()));
2914 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2915 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2916 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2917 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2918 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2919 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2920 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2921 connect_style: Rc::clone(&connect_style),
2922 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2923 wallet_source: Arc::clone(&wallet_source),
2924 bump_tx_handler: BumpTransactionEventHandler::new(
2925 cfgs[i].tx_broadcaster, Arc::new(Wallet::new(Arc::clone(&wallet_source), cfgs[i].logger)),
2926 &cfgs[i].keys_manager, cfgs[i].logger,
2931 for i in 0..node_count {
2932 for j in (i+1)..node_count {
2933 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2934 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2936 remote_network_address: None,
2938 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2939 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2941 remote_network_address: None,
2949 // Note that the following only works for CLTV values up to 128
2950 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2951 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT_ANCHORS: usize = 140; // Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2953 #[derive(PartialEq)]
2954 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2955 /// Tests that the given node has broadcast transactions for the given Channel
2957 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2958 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2959 /// broadcast and the revoked outputs were claimed.
2961 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2962 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2964 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2966 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> {
2967 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2968 let mut txn_seen = HashSet::new();
2969 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2970 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2972 let mut res = Vec::with_capacity(2);
2973 node_txn.retain(|tx| {
2974 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2975 check_spends!(tx, chan.3);
2976 if commitment_tx.is_none() {
2977 res.push(tx.clone());
2982 if let Some(explicit_tx) = commitment_tx {
2983 res.push(explicit_tx.clone());
2986 assert_eq!(res.len(), 1);
2988 if has_htlc_tx != HTLCType::NONE {
2989 node_txn.retain(|tx| {
2990 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2991 check_spends!(tx, res[0]);
2992 if has_htlc_tx == HTLCType::TIMEOUT {
2993 assert_ne!(tx.lock_time, LockTime::ZERO);
2995 assert_eq!(tx.lock_time, LockTime::ZERO);
2997 res.push(tx.clone());
3001 assert!(res.len() == 2 || res.len() == 3);
3003 assert_eq!(res[1], res[2]);
3007 assert!(node_txn.is_empty());
3011 /// Tests that the given node has broadcast a claim transaction against the provided revoked
3012 /// HTLC transaction.
3013 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
3014 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3015 // We may issue multiple claiming transaction on revoked outputs due to block rescan
3016 // for revoked htlc outputs
3017 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
3018 node_txn.retain(|tx| {
3019 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
3020 check_spends!(tx, revoked_tx);
3024 node_txn.retain(|tx| {
3025 check_spends!(tx, commitment_revoked_tx);
3028 assert!(node_txn.is_empty());
3031 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3032 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3033 let mut txn_seen = HashSet::new();
3034 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
3036 let mut found_prev = false;
3037 for prev_tx in prev_txn {
3038 for tx in &*node_txn {
3039 if tx.input[0].previous_output.txid == prev_tx.txid() {
3040 check_spends!(tx, prev_tx);
3041 let mut iter = tx.input[0].witness.iter();
3042 iter.next().expect("expected 3 witness items");
3043 iter.next().expect("expected 3 witness items");
3044 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
3045 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3052 assert!(found_prev);
3054 let mut res = Vec::new();
3055 mem::swap(&mut *node_txn, &mut res);
3059 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) {
3060 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
3061 assert_eq!(events_1.len(), 2);
3062 let as_update = match events_1[0] {
3063 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3066 _ => panic!("Unexpected event"),
3069 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3070 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3071 assert_eq!(msg.data, expected_error);
3072 if needs_err_handle {
3073 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
3076 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3077 assert_eq!(node_id, nodes[b].node.get_our_node_id());
3078 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3079 if needs_err_handle {
3080 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg.as_ref().unwrap());
3083 _ => panic!("Unexpected event"),
3086 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
3087 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
3088 let bs_update = match events_2[0] {
3089 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3092 _ => panic!("Unexpected event"),
3094 if !needs_err_handle {
3096 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
3097 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3098 assert_eq!(msg.data, expected_error);
3100 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::DisconnectPeer { ref msg } } => {
3101 assert_eq!(node_id, nodes[a].node.get_our_node_id());
3102 assert_eq!(msg.as_ref().unwrap().data, expected_error);
3104 _ => panic!("Unexpected event"),
3109 node.gossip_sync.handle_channel_update(&as_update).unwrap();
3110 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
3114 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
3115 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
3119 macro_rules! get_channel_value_stat {
3120 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
3121 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
3122 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
3123 let chan = chan_lock.channel_by_id.get(&$channel_id).map(
3124 |phase| if let ChannelPhase::Funded(chan) = phase { Some(chan) } else { None }
3125 ).flatten().unwrap();
3126 chan.get_value_stat()
3130 macro_rules! get_chan_reestablish_msgs {
3131 ($src_node: expr, $dst_node: expr) => {
3133 let mut announcements = $crate::prelude::HashSet::new();
3134 let mut res = Vec::with_capacity(1);
3135 for msg in $src_node.node.get_and_clear_pending_msg_events() {
3136 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
3137 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3138 res.push(msg.clone());
3139 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
3140 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3141 announcements.insert(msg.contents.short_channel_id);
3143 panic!("Unexpected event")
3146 assert!(announcements.is_empty());
3152 macro_rules! handle_chan_reestablish_msgs {
3153 ($src_node: expr, $dst_node: expr) => {
3155 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
3157 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
3159 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3165 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
3167 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3170 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
3171 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3172 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3174 had_channel_update = true;
3177 let mut revoke_and_ack = None;
3178 let mut commitment_update = None;
3179 let order = if let Some(ev) = msg_events.get(idx) {
3181 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3182 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3183 revoke_and_ack = Some(msg.clone());
3185 RAACommitmentOrder::RevokeAndACKFirst
3187 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3188 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3189 commitment_update = Some(updates.clone());
3191 RAACommitmentOrder::CommitmentFirst
3193 _ => RAACommitmentOrder::CommitmentFirst,
3196 RAACommitmentOrder::CommitmentFirst
3199 if let Some(ev) = msg_events.get(idx) {
3201 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3202 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3203 assert!(revoke_and_ack.is_none());
3204 revoke_and_ack = Some(msg.clone());
3207 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3208 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3209 assert!(commitment_update.is_none());
3210 commitment_update = Some(updates.clone());
3217 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
3218 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
3220 assert!(!had_channel_update);
3223 assert_eq!(msg_events.len(), idx);
3225 (channel_ready, revoke_and_ack, commitment_update, order)
3230 pub struct ReconnectArgs<'a, 'b, 'c, 'd> {
3231 pub node_a: &'a Node<'b, 'c, 'd>,
3232 pub node_b: &'a Node<'b, 'c, 'd>,
3233 pub send_channel_ready: (bool, bool),
3234 pub pending_responding_commitment_signed: (bool, bool),
3235 /// Indicates that the pending responding commitment signed will be a dup for the recipient,
3236 /// and no monitor update is expected
3237 pub pending_responding_commitment_signed_dup_monitor: (bool, bool),
3238 pub pending_htlc_adds: (usize, usize),
3239 pub pending_htlc_claims: (usize, usize),
3240 pub pending_htlc_fails: (usize, usize),
3241 pub pending_cell_htlc_claims: (usize, usize),
3242 pub pending_cell_htlc_fails: (usize, usize),
3243 pub pending_raa: (bool, bool),
3246 impl<'a, 'b, 'c, 'd> ReconnectArgs<'a, 'b, 'c, 'd> {
3247 pub fn new(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> Self {
3251 send_channel_ready: (false, false),
3252 pending_responding_commitment_signed: (false, false),
3253 pending_responding_commitment_signed_dup_monitor: (false, false),
3254 pending_htlc_adds: (0, 0),
3255 pending_htlc_claims: (0, 0),
3256 pending_htlc_fails: (0, 0),
3257 pending_cell_htlc_claims: (0, 0),
3258 pending_cell_htlc_fails: (0, 0),
3259 pending_raa: (false, false),
3264 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
3265 /// for claims/fails they are separated out.
3266 pub fn reconnect_nodes<'a, 'b, 'c, 'd>(args: ReconnectArgs<'a, 'b, 'c, 'd>) {
3268 node_a, node_b, send_channel_ready, pending_htlc_adds, pending_htlc_claims, pending_htlc_fails,
3269 pending_cell_htlc_claims, pending_cell_htlc_fails, pending_raa,
3270 pending_responding_commitment_signed, pending_responding_commitment_signed_dup_monitor,
3272 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
3273 features: node_b.node.init_features(), networks: None, remote_network_address: None
3275 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
3276 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
3277 features: node_a.node.init_features(), networks: None, remote_network_address: None
3279 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
3281 if send_channel_ready.0 {
3282 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
3284 for reestablish in reestablish_1.iter() {
3285 let n = reestablish.next_remote_commitment_number;
3286 assert_eq!(n, 0, "expected a->b next_remote_commitment_number to be 0, got {}", n);
3289 if send_channel_ready.1 {
3290 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
3292 for reestablish in reestablish_2.iter() {
3293 let n = reestablish.next_remote_commitment_number;
3294 assert_eq!(n, 0, "expected b->a next_remote_commitment_number to be 0, got {}", n);
3297 if send_channel_ready.0 || send_channel_ready.1 {
3298 // If we expect any channel_ready's, both sides better have set
3299 // next_holder_commitment_number to 1
3300 for reestablish in reestablish_1.iter() {
3301 let n = reestablish.next_local_commitment_number;
3302 assert_eq!(n, 1, "expected a->b next_local_commitment_number to be 1, got {}", n);
3304 for reestablish in reestablish_2.iter() {
3305 let n = reestablish.next_local_commitment_number;
3306 assert_eq!(n, 1, "expected b->a next_local_commitment_number to be 1, got {}", n);
3310 let mut resp_1 = Vec::new();
3311 for msg in reestablish_1 {
3312 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
3313 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
3315 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3316 check_added_monitors!(node_b, 1);
3318 check_added_monitors!(node_b, 0);
3321 let mut resp_2 = Vec::new();
3322 for msg in reestablish_2 {
3323 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
3324 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
3326 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3327 check_added_monitors!(node_a, 1);
3329 check_added_monitors!(node_a, 0);
3332 // We don't yet support both needing updates, as that would require a different commitment dance:
3333 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
3334 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
3335 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
3336 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
3338 for chan_msgs in resp_1.drain(..) {
3339 if send_channel_ready.0 {
3340 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
3341 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
3342 if !announcement_event.is_empty() {
3343 assert_eq!(announcement_event.len(), 1);
3344 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
3345 //TODO: Test announcement_sigs re-sending
3346 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
3349 assert!(chan_msgs.0.is_none());
3352 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3353 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3354 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3355 check_added_monitors!(node_a, 1);
3357 assert!(chan_msgs.1.is_none());
3359 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 ||
3360 pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 ||
3361 pending_responding_commitment_signed.0
3363 let commitment_update = chan_msgs.2.unwrap();
3364 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0);
3365 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3366 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3367 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3368 for update_add in commitment_update.update_add_htlcs {
3369 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3371 for update_fulfill in commitment_update.update_fulfill_htlcs {
3372 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3374 for update_fail in commitment_update.update_fail_htlcs {
3375 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3378 if !pending_responding_commitment_signed.0 {
3379 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3381 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3382 check_added_monitors!(node_a, 1);
3383 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3384 // No commitment_signed so get_event_msg's assert(len == 1) passes
3385 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3386 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3387 check_added_monitors!(node_b, if pending_responding_commitment_signed_dup_monitor.0 { 0 } else { 1 });
3390 assert!(chan_msgs.2.is_none());
3394 for chan_msgs in resp_2.drain(..) {
3395 if send_channel_ready.1 {
3396 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3397 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3398 if !announcement_event.is_empty() {
3399 assert_eq!(announcement_event.len(), 1);
3400 match announcement_event[0] {
3401 MessageSendEvent::SendChannelUpdate { .. } => {},
3402 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3403 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3407 assert!(chan_msgs.0.is_none());
3410 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3411 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3412 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3413 check_added_monitors!(node_b, 1);
3415 assert!(chan_msgs.1.is_none());
3417 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 ||
3418 pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 ||
3419 pending_responding_commitment_signed.1
3421 let commitment_update = chan_msgs.2.unwrap();
3422 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1);
3423 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3424 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3425 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3426 for update_add in commitment_update.update_add_htlcs {
3427 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3429 for update_fulfill in commitment_update.update_fulfill_htlcs {
3430 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3432 for update_fail in commitment_update.update_fail_htlcs {
3433 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3436 if !pending_responding_commitment_signed.1 {
3437 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3439 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3440 check_added_monitors!(node_b, 1);
3441 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3442 // No commitment_signed so get_event_msg's assert(len == 1) passes
3443 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3444 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3445 check_added_monitors!(node_a, if pending_responding_commitment_signed_dup_monitor.1 { 0 } else { 1 });
3448 assert!(chan_msgs.2.is_none());
3453 /// Initiates channel opening and creates a single batch funding transaction.
3454 /// This will go through the open_channel / accept_channel flow, and return the batch funding
3455 /// transaction with corresponding funding_created messages.
3456 pub fn create_batch_channel_funding<'a, 'b, 'c>(
3457 funding_node: &Node<'a, 'b, 'c>,
3458 params: &[(&Node<'a, 'b, 'c>, u64, u64, u128, Option<UserConfig>)],
3459 ) -> (Transaction, Vec<msgs::FundingCreated>) {
3460 let mut tx_outs = Vec::new();
3461 let mut temp_chan_ids = Vec::new();
3462 let mut funding_created_msgs = Vec::new();
3464 for (other_node, channel_value_satoshis, push_msat, user_channel_id, override_config) in params {
3465 // Initialize channel opening.
3466 let temp_chan_id = funding_node.node.create_channel(
3467 other_node.node.get_our_node_id(), *channel_value_satoshis, *push_msat, *user_channel_id,
3471 let open_channel_msg = get_event_msg!(funding_node, MessageSendEvent::SendOpenChannel, other_node.node.get_our_node_id());
3472 other_node.node.handle_open_channel(&funding_node.node.get_our_node_id(), &open_channel_msg);
3473 let accept_channel_msg = get_event_msg!(other_node, MessageSendEvent::SendAcceptChannel, funding_node.node.get_our_node_id());
3474 funding_node.node.handle_accept_channel(&other_node.node.get_our_node_id(), &accept_channel_msg);
3476 // Create the corresponding funding output.
3477 let events = funding_node.node.get_and_clear_pending_events();
3478 assert_eq!(events.len(), 1);
3480 Event::FundingGenerationReady {
3481 ref temporary_channel_id,
3482 ref counterparty_node_id,
3483 channel_value_satoshis: ref event_channel_value_satoshis,
3485 user_channel_id: ref event_user_channel_id
3487 assert_eq!(temporary_channel_id, &temp_chan_id);
3488 assert_eq!(counterparty_node_id, &other_node.node.get_our_node_id());
3489 assert_eq!(channel_value_satoshis, event_channel_value_satoshis);
3490 assert_eq!(user_channel_id, event_user_channel_id);
3491 tx_outs.push(TxOut {
3492 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3495 _ => panic!("Unexpected event"),
3497 temp_chan_ids.push((temp_chan_id, other_node.node.get_our_node_id()));
3500 // Compose the batch funding transaction and give it to the ChannelManager.
3501 let tx = Transaction {
3503 lock_time: LockTime::ZERO,
3507 assert!(funding_node.node.batch_funding_transaction_generated(
3508 temp_chan_ids.iter().map(|(a, b)| (a, b)).collect::<Vec<_>>().as_slice(),
3511 check_added_monitors!(funding_node, 0);
3512 let events = funding_node.node.get_and_clear_pending_msg_events();
3513 assert_eq!(events.len(), params.len());
3514 for (other_node, ..) in params {
3515 let funding_created = events
3517 .find_map(|event| match event {
3518 MessageSendEvent::SendFundingCreated { node_id, msg } if node_id == &other_node.node.get_our_node_id() => Some(msg.clone()),
3522 funding_created_msgs.push(funding_created);
3524 return (tx, funding_created_msgs);