1 // This file is Copyright its original authors, visible in version control
4 // This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
5 // or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
7 // You may not use this file except in accordance with one or both of these
10 //! A bunch of useful utilities for building networks of nodes and exchanging messages between
11 //! nodes for functional tests.
13 use crate::chain::{BestBlock, ChannelMonitorUpdateStatus, Confirm, Listen, Watch};
14 use crate::sign::EntropySource;
15 use crate::chain::channelmonitor::ChannelMonitor;
16 use crate::chain::transaction::OutPoint;
17 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
18 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
19 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
20 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
21 use crate::routing::router::{self, PaymentParameters, Route};
22 use crate::ln::features::InitFeatures;
24 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
25 use crate::util::enforcing_trait_impls::EnforcingSigner;
26 use crate::util::scid_utils;
27 use crate::util::test_utils;
28 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
29 use crate::util::errors::APIError;
30 use crate::util::config::{UserConfig, MaxDustHTLCExposure};
31 use crate::util::ser::{ReadableArgs, Writeable};
33 use bitcoin::blockdata::block::{Block, BlockHeader};
34 use bitcoin::blockdata::transaction::{Transaction, TxOut};
35 use bitcoin::network::constants::Network;
37 use bitcoin::hash_types::BlockHash;
38 use bitcoin::hashes::sha256::Hash as Sha256;
39 use bitcoin::hashes::Hash as _;
41 use bitcoin::secp256k1::PublicKey;
44 use crate::prelude::*;
45 use core::cell::RefCell;
47 use crate::sync::{Arc, Mutex, LockTestExt};
49 use core::iter::repeat;
50 use bitcoin::{PackedLockTime, TxMerkleNode};
52 pub const CHAN_CONFIRM_DEPTH: u32 = 10;
54 /// Mine the given transaction in the next block and then mine CHAN_CONFIRM_DEPTH - 1 blocks on
55 /// top, giving the given transaction CHAN_CONFIRM_DEPTH confirmations.
57 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
58 /// output is the 1st output in the transaction.
59 pub fn confirm_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
60 let scid = confirm_transaction_at(node, tx, node.best_block_info().1 + 1);
61 connect_blocks(node, CHAN_CONFIRM_DEPTH - 1);
64 /// Mine a single block containing the given transaction
66 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
67 /// output is the 1st output in the transaction.
68 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> u64 {
69 let height = node.best_block_info().1 + 1;
70 confirm_transaction_at(node, tx, height)
72 /// Mine a single block containing the given transactions
73 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
74 let height = node.best_block_info().1 + 1;
75 confirm_transactions_at(node, txn, height);
77 /// Mine the given transaction at the given height, mining blocks as required to build to that
80 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
81 /// output is the 1st output in the transaction.
82 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
83 let first_connect_height = node.best_block_info().1 + 1;
84 assert!(first_connect_height <= conf_height);
85 if conf_height > first_connect_height {
86 connect_blocks(node, conf_height - first_connect_height);
88 let mut txdata = Vec::new();
89 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
90 txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
93 txdata.push((*tx).clone());
95 let block = create_dummy_block(node.best_block_hash(), conf_height, txdata);
96 connect_block(node, &block);
97 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
99 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
100 confirm_transactions_at(node, &[tx], conf_height)
103 /// The possible ways we may notify a ChannelManager of a new block
104 #[derive(Clone, Copy, Debug, PartialEq)]
105 pub enum ConnectStyle {
106 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
107 /// the header and height information.
109 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
110 /// make a single `best_block_updated` call.
111 BestBlockFirstSkippingBlocks,
112 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
113 /// `transaction_unconfirmed` is called.
114 BestBlockFirstReorgsOnlyTip,
115 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
116 /// the header and height information.
118 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
119 /// make a single `best_block_updated` call.
120 TransactionsFirstSkippingBlocks,
121 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
122 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
123 /// times to ensure it's idempotent.
124 TransactionsDuplicativelyFirstSkippingBlocks,
125 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
126 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
127 /// times to ensure it's idempotent.
128 HighlyRedundantTransactionsFirstSkippingBlocks,
129 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
130 /// `transaction_unconfirmed` is called.
131 TransactionsFirstReorgsOnlyTip,
132 /// Provides the full block via the `chain::Listen` interface. In the current code this is
133 /// equivalent to `TransactionsFirst` with some additional assertions.
138 pub fn skips_blocks(&self) -> bool {
140 ConnectStyle::BestBlockFirst => false,
141 ConnectStyle::BestBlockFirstSkippingBlocks => true,
142 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
143 ConnectStyle::TransactionsFirst => false,
144 ConnectStyle::TransactionsFirstSkippingBlocks => true,
145 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
146 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
147 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
148 ConnectStyle::FullBlockViaListen => false,
152 pub fn updates_best_block_first(&self) -> bool {
154 ConnectStyle::BestBlockFirst => true,
155 ConnectStyle::BestBlockFirstSkippingBlocks => true,
156 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
157 ConnectStyle::TransactionsFirst => false,
158 ConnectStyle::TransactionsFirstSkippingBlocks => false,
159 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
160 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
161 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
162 ConnectStyle::FullBlockViaListen => false,
166 fn random_style() -> ConnectStyle {
167 #[cfg(feature = "std")] {
168 use core::hash::{BuildHasher, Hasher};
169 // Get a random value using the only std API to do so - the DefaultHasher
170 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
171 let res = match rand_val % 9 {
172 0 => ConnectStyle::BestBlockFirst,
173 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
174 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
175 3 => ConnectStyle::TransactionsFirst,
176 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
177 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
178 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
179 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
180 8 => ConnectStyle::FullBlockViaListen,
183 eprintln!("Using Block Connection Style: {:?}", res);
186 #[cfg(not(feature = "std"))] {
187 ConnectStyle::FullBlockViaListen
192 pub fn create_dummy_header(prev_blockhash: BlockHash, time: u32) -> BlockHeader {
194 version: 0x2000_0000,
196 merkle_root: TxMerkleNode::all_zeros(),
203 pub fn create_dummy_block(prev_blockhash: BlockHash, time: u32, txdata: Vec<Transaction>) -> Block {
204 Block { header: create_dummy_header(prev_blockhash, time), txdata }
207 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
208 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
210 let height = node.best_block_info().1 + 1;
211 let mut block = create_dummy_block(node.best_block_hash(), height, Vec::new());
214 let prev_blockhash = block.header.block_hash();
215 do_connect_block(node, block, skip_intermediaries);
216 block = create_dummy_block(prev_blockhash, height + i, Vec::new());
218 let hash = block.header.block_hash();
219 do_connect_block(node, block, false);
223 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
224 do_connect_block(node, block.clone(), false);
227 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
228 // Ensure `get_claimable_balances`' self-tests never panic
229 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
230 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
234 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
235 call_claimable_balances(node);
236 let height = node.best_block_info().1 + 1;
237 #[cfg(feature = "std")] {
238 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
240 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
241 // transaction broadcast are correct.
242 node.blocks.lock().unwrap().push((block.clone(), height));
243 if !skip_intermediaries {
244 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
245 match *node.connect_style.borrow() {
246 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
247 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
248 call_claimable_balances(node);
249 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
250 node.node.best_block_updated(&block.header, height);
251 node.node.transactions_confirmed(&block.header, &txdata, height);
253 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
254 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
255 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
256 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
257 let mut connections = Vec::new();
258 for (block, height) in node.blocks.lock().unwrap().iter() {
259 if !block.txdata.is_empty() {
260 // Reconnect all transactions we've ever seen to ensure transaction connection
261 // is *really* idempotent. This is a somewhat likely deployment for some
262 // esplora implementations of chain sync which try to reduce state and
263 // complexity as much as possible.
265 // Sadly we have to clone the block here to maintain lockorder. In the
266 // future we should consider Arc'ing the blocks to avoid this.
267 connections.push((block.clone(), *height));
270 for (old_block, height) in connections {
271 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
272 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
275 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
276 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
277 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
279 call_claimable_balances(node);
280 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
281 node.node.transactions_confirmed(&block.header, &txdata, height);
282 node.node.best_block_updated(&block.header, height);
284 ConnectStyle::FullBlockViaListen => {
285 node.chain_monitor.chain_monitor.block_connected(&block, height);
286 node.node.block_connected(&block, height);
290 call_claimable_balances(node);
291 node.node.test_process_background_events();
294 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
295 call_claimable_balances(node);
296 #[cfg(feature = "std")] {
297 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
300 let orig = node.blocks.lock().unwrap().pop().unwrap();
301 assert!(orig.1 > 0); // Cannot disconnect genesis
302 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
304 match *node.connect_style.borrow() {
305 ConnectStyle::FullBlockViaListen => {
306 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
307 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
309 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
310 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
312 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
313 node.node.best_block_updated(&prev.0.header, prev.1);
316 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
317 for tx in orig.0.txdata {
318 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
319 node.node.transaction_unconfirmed(&tx.txid());
323 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
324 node.node.best_block_updated(&prev.0.header, prev.1);
327 call_claimable_balances(node);
331 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
332 let count = node.blocks.lock().unwrap().len() as u32 - 1;
333 disconnect_blocks(node, count);
336 pub struct TestChanMonCfg {
337 pub tx_broadcaster: test_utils::TestBroadcaster,
338 pub fee_estimator: test_utils::TestFeeEstimator,
339 pub chain_source: test_utils::TestChainSource,
340 pub persister: test_utils::TestPersister,
341 pub logger: test_utils::TestLogger,
342 pub keys_manager: test_utils::TestKeysInterface,
343 pub scorer: Mutex<test_utils::TestScorer>,
346 pub struct NodeCfg<'a> {
347 pub chain_source: &'a test_utils::TestChainSource,
348 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
349 pub fee_estimator: &'a test_utils::TestFeeEstimator,
350 pub router: test_utils::TestRouter<'a>,
351 pub chain_monitor: test_utils::TestChainMonitor<'a>,
352 pub keys_manager: &'a test_utils::TestKeysInterface,
353 pub logger: &'a test_utils::TestLogger,
354 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
355 pub node_seed: [u8; 32],
356 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
359 type TestChannelManager<'a, 'b, 'c> = ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'b test_utils::TestRouter<'c>, &'c test_utils::TestLogger>;
361 pub struct Node<'a, 'b: 'a, 'c: 'b> {
362 pub chain_source: &'c test_utils::TestChainSource,
363 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
364 pub fee_estimator: &'c test_utils::TestFeeEstimator,
365 pub router: &'b test_utils::TestRouter<'c>,
366 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
367 pub keys_manager: &'b test_utils::TestKeysInterface,
368 pub node: &'a TestChannelManager<'a, 'b, 'c>,
369 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
370 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
371 pub node_seed: [u8; 32],
372 pub network_payment_count: Rc<RefCell<u8>>,
373 pub network_chan_count: Rc<RefCell<u32>>,
374 pub logger: &'c test_utils::TestLogger,
375 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
376 pub connect_style: Rc<RefCell<ConnectStyle>>,
377 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
379 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
380 pub fn best_block_hash(&self) -> BlockHash {
381 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
383 pub fn best_block_info(&self) -> (BlockHash, u32) {
384 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
386 pub fn get_block_header(&self, height: u32) -> BlockHeader {
387 self.blocks.lock().unwrap()[height as usize].0.header
391 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
392 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
393 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
395 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
397 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
398 Self((node as *const Node<'a, 'b, 'c>).cast())
401 unsafe impl Send for NodePtr {}
402 unsafe impl Sync for NodePtr {}
405 pub trait NodeHolder {
406 type CM: AChannelManager;
407 fn node(&self) -> &ChannelManager<
408 <Self::CM as AChannelManager>::M,
409 <Self::CM as AChannelManager>::T,
410 <Self::CM as AChannelManager>::ES,
411 <Self::CM as AChannelManager>::NS,
412 <Self::CM as AChannelManager>::SP,
413 <Self::CM as AChannelManager>::F,
414 <Self::CM as AChannelManager>::R,
415 <Self::CM as AChannelManager>::L>;
416 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
418 impl<H: NodeHolder> NodeHolder for &H {
420 fn node(&self) -> &ChannelManager<
421 <Self::CM as AChannelManager>::M,
422 <Self::CM as AChannelManager>::T,
423 <Self::CM as AChannelManager>::ES,
424 <Self::CM as AChannelManager>::NS,
425 <Self::CM as AChannelManager>::SP,
426 <Self::CM as AChannelManager>::F,
427 <Self::CM as AChannelManager>::R,
428 <Self::CM as AChannelManager>::L> { (*self).node() }
429 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
431 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
432 type CM = TestChannelManager<'a, 'b, 'c>;
433 fn node(&self) -> &TestChannelManager<'a, 'b, 'c> { &self.node }
434 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
437 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
440 // Check that we processed all pending events
441 let msg_events = self.node.get_and_clear_pending_msg_events();
442 if !msg_events.is_empty() {
443 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
445 let events = self.node.get_and_clear_pending_events();
446 if !events.is_empty() {
447 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
449 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
450 if !added_monitors.is_empty() {
451 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
454 // Check that if we serialize the network graph, we can deserialize it again.
455 let network_graph = {
456 let mut w = test_utils::TestVecWriter(Vec::new());
457 self.network_graph.write(&mut w).unwrap();
458 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
459 assert!(network_graph_deser == *self.network_graph);
460 let gossip_sync = P2PGossipSync::new(
461 &network_graph_deser, Some(self.chain_source), self.logger
463 let mut chan_progress = 0;
465 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
466 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
467 assert!(orig_announcements == deserialized_announcements);
468 chan_progress = match orig_announcements {
469 Some(announcement) => announcement.0.contents.short_channel_id + 1,
473 let mut node_progress = None;
475 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
476 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
477 assert!(orig_announcements == deserialized_announcements);
478 node_progress = match orig_announcements {
479 Some(announcement) => Some(announcement.contents.node_id),
486 // Check that if we serialize and then deserialize all our channel monitors we get the
487 // same set of outputs to watch for on chain as we have now. Note that if we write
488 // tests that fully close channels and remove the monitors at some point this may break.
489 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
490 let mut deserialized_monitors = Vec::new();
492 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
493 let mut w = test_utils::TestVecWriter(Vec::new());
494 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
495 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
496 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
497 deserialized_monitors.push(deserialized_monitor);
501 let broadcaster = test_utils::TestBroadcaster {
502 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
503 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
506 // Before using all the new monitors to check the watch outpoints, use the full set of
507 // them to ensure we can write and reload our ChannelManager.
509 let mut channel_monitors = HashMap::new();
510 for monitor in deserialized_monitors.iter_mut() {
511 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
514 let scorer = Mutex::new(test_utils::TestScorer::new());
515 let mut w = test_utils::TestVecWriter(Vec::new());
516 self.node.write(&mut w).unwrap();
517 <(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 {
518 default_config: *self.node.get_current_default_configuration(),
519 entropy_source: self.keys_manager,
520 node_signer: self.keys_manager,
521 signer_provider: self.keys_manager,
522 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
523 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
524 chain_monitor: self.chain_monitor,
525 tx_broadcaster: &broadcaster,
526 logger: &self.logger,
531 let persister = test_utils::TestPersister::new();
532 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
533 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
534 for deserialized_monitor in deserialized_monitors.drain(..) {
535 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
539 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
540 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
545 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
546 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
549 pub fn create_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
550 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
551 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
552 (announcement, as_update, bs_update, channel_id, tx)
555 /// Gets an RAA and CS which were sent in response to a commitment update
556 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
557 let events = node.node().get_and_clear_pending_msg_events();
558 assert_eq!(events.len(), 2);
560 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
561 assert_eq!(node_id, recipient);
564 _ => panic!("Unexpected event"),
566 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
567 assert_eq!(node_id, recipient);
568 assert!(updates.update_add_htlcs.is_empty());
569 assert!(updates.update_fulfill_htlcs.is_empty());
570 assert!(updates.update_fail_htlcs.is_empty());
571 assert!(updates.update_fail_malformed_htlcs.is_empty());
572 assert!(updates.update_fee.is_none());
573 updates.commitment_signed.clone()
575 _ => panic!("Unexpected event"),
580 /// Gets an RAA and CS which were sent in response to a commitment update
582 /// Don't use this, use the identically-named function instead.
583 macro_rules! get_revoke_commit_msgs {
584 ($node: expr, $node_id: expr) => {
585 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
589 /// Get an specific event message from the pending events queue.
591 macro_rules! get_event_msg {
592 ($node: expr, $event_type: path, $node_id: expr) => {
594 let events = $node.node.get_and_clear_pending_msg_events();
595 assert_eq!(events.len(), 1);
597 $event_type { ref node_id, ref msg } => {
598 assert_eq!(*node_id, $node_id);
601 _ => panic!("Unexpected event"),
607 /// Get an error message from the pending events queue.
608 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
609 let events = node.node.get_and_clear_pending_msg_events();
610 assert_eq!(events.len(), 1);
612 MessageSendEvent::HandleError {
613 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
615 assert_eq!(node_id, recipient);
618 _ => panic!("Unexpected event"),
622 /// Get a specific event from the pending events queue.
624 macro_rules! get_event {
625 ($node: expr, $event_type: path) => {
627 let mut events = $node.node.get_and_clear_pending_events();
628 assert_eq!(events.len(), 1);
629 let ev = events.pop().unwrap();
631 $event_type { .. } => {
634 _ => panic!("Unexpected event"),
640 /// Gets an UpdateHTLCs MessageSendEvent
641 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
642 let events = node.node.get_and_clear_pending_msg_events();
643 assert_eq!(events.len(), 1);
645 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
646 assert_eq!(node_id, recipient);
649 _ => panic!("Unexpected event"),
654 /// Gets an UpdateHTLCs MessageSendEvent
656 /// Don't use this, use the identically-named function instead.
657 macro_rules! get_htlc_update_msgs {
658 ($node: expr, $node_id: expr) => {
659 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
663 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
664 /// Returns the `msg_event`.
666 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
667 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
668 /// such messages are intended to all peers.
669 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
670 let ev_index = msg_events.iter().position(|e| { match e {
671 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
672 node_id == msg_node_id
674 MessageSendEvent::SendOpenChannel { node_id, .. } => {
675 node_id == msg_node_id
677 MessageSendEvent::SendFundingCreated { node_id, .. } => {
678 node_id == msg_node_id
680 MessageSendEvent::SendFundingSigned { node_id, .. } => {
681 node_id == msg_node_id
683 MessageSendEvent::SendChannelReady { node_id, .. } => {
684 node_id == msg_node_id
686 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
687 node_id == msg_node_id
689 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
690 node_id == msg_node_id
692 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
693 node_id == msg_node_id
695 MessageSendEvent::SendClosingSigned { node_id, .. } => {
696 node_id == msg_node_id
698 MessageSendEvent::SendShutdown { node_id, .. } => {
699 node_id == msg_node_id
701 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
702 node_id == msg_node_id
704 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
705 node_id == msg_node_id
707 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
710 MessageSendEvent::BroadcastChannelUpdate { .. } => {
713 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
716 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
717 node_id == msg_node_id
719 MessageSendEvent::HandleError { node_id, .. } => {
720 node_id == msg_node_id
722 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
723 node_id == msg_node_id
725 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
726 node_id == msg_node_id
728 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
729 node_id == msg_node_id
731 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
732 node_id == msg_node_id
734 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
735 node_id == msg_node_id
737 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
738 node_id == msg_node_id
740 MessageSendEvent::SendTxAddInput { node_id, .. } => {
741 node_id == msg_node_id
743 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
744 node_id == msg_node_id
746 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
747 node_id == msg_node_id
749 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
750 node_id == msg_node_id
752 MessageSendEvent::SendTxComplete { node_id, .. } => {
753 node_id == msg_node_id
755 MessageSendEvent::SendTxSignatures { node_id, .. } => {
756 node_id == msg_node_id
758 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
759 node_id == msg_node_id
761 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
762 node_id == msg_node_id
764 MessageSendEvent::SendTxAbort { node_id, .. } => {
765 node_id == msg_node_id
768 if ev_index.is_some() {
769 msg_events.remove(ev_index.unwrap())
771 panic!("Couldn't find any MessageSendEvent to the node!")
776 macro_rules! get_channel_ref {
777 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
779 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
780 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
781 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
787 macro_rules! get_outbound_v1_channel_ref {
788 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
790 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
791 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
792 $peer_state_lock.outbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
798 macro_rules! get_inbound_v1_channel_ref {
799 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
801 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
802 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
803 $peer_state_lock.inbound_v1_channel_by_id.get_mut(&$channel_id).unwrap()
809 macro_rules! get_feerate {
810 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
812 let mut per_peer_state_lock;
813 let mut peer_state_lock;
814 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
815 chan.context.get_feerate_sat_per_1000_weight()
821 macro_rules! get_channel_type_features {
822 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
824 let mut per_peer_state_lock;
825 let mut peer_state_lock;
826 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
827 chan.context.get_channel_type().clone()
832 /// Returns a channel monitor given a channel id, making some naive assumptions
834 macro_rules! get_monitor {
835 ($node: expr, $channel_id: expr) => {
837 use bitcoin::hashes::Hash;
838 let mut monitor = None;
839 // Assume funding vout is either 0 or 1 blindly
841 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
842 $crate::chain::transaction::OutPoint {
843 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
855 /// Returns any local commitment transactions for the channel.
857 macro_rules! get_local_commitment_txn {
858 ($node: expr, $channel_id: expr) => {
860 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
865 /// Check the error from attempting a payment.
867 macro_rules! unwrap_send_err {
868 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
870 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
871 assert_eq!(fails.len(), 1);
877 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
878 assert_eq!(results.len(), 1);
880 Err($type) => { $check },
889 /// Check whether N channel monitor(s) have been added.
890 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
891 if let Some(chain_monitor) = node.chain_monitor() {
892 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
893 assert_eq!(added_monitors.len(), count);
894 added_monitors.clear();
898 /// Check whether N channel monitor(s) have been added.
900 /// Don't use this, use the identically-named function instead.
902 macro_rules! check_added_monitors {
903 ($node: expr, $count: expr) => {
904 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
908 pub fn _reload_node<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, default_config: UserConfig, chanman_encoded: &[u8], monitors_encoded: &[&[u8]]) -> ChannelManager<&'b TestChainMonitor<'c>, &'c test_utils::TestBroadcaster, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'b test_utils::TestKeysInterface, &'c test_utils::TestFeeEstimator, &'b test_utils::TestRouter<'c>, &'c test_utils::TestLogger> {
909 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
910 for encoded in monitors_encoded {
911 let mut monitor_read = &encoded[..];
912 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
913 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
914 assert!(monitor_read.is_empty());
915 monitors_read.push(monitor);
918 let mut node_read = &chanman_encoded[..];
919 let (_, node_deserialized) = {
920 let mut channel_monitors = HashMap::new();
921 for monitor in monitors_read.iter_mut() {
922 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
924 <(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 node_read, ChannelManagerReadArgs {
926 entropy_source: node.keys_manager,
927 node_signer: node.keys_manager,
928 signer_provider: node.keys_manager,
929 fee_estimator: node.fee_estimator,
931 chain_monitor: node.chain_monitor,
932 tx_broadcaster: node.tx_broadcaster,
937 assert!(node_read.is_empty());
939 for monitor in monitors_read.drain(..) {
940 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
941 ChannelMonitorUpdateStatus::Completed);
942 check_added_monitors!(node, 1);
949 macro_rules! reload_node {
950 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
951 let chanman_encoded = $chanman_encoded;
953 $persister = test_utils::TestPersister::new();
954 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
955 $node.chain_monitor = &$new_chain_monitor;
957 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
958 $node.node = &$new_channelmanager;
960 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
961 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
965 pub fn create_funding_transaction<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, expected_counterparty_node_id: &PublicKey, expected_chan_value: u64, expected_user_chan_id: u128) -> ([u8; 32], Transaction, OutPoint) {
966 let chan_id = *node.network_chan_count.borrow();
968 let events = node.node.get_and_clear_pending_events();
969 assert_eq!(events.len(), 1);
971 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
972 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
973 assert_eq!(*channel_value_satoshis, expected_chan_value);
974 assert_eq!(user_channel_id, expected_user_chan_id);
976 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
977 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
979 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
980 (*temporary_channel_id, tx, funding_outpoint)
982 _ => panic!("Unexpected event"),
985 pub fn sign_funding_transaction<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, channel_value: u64, expected_temporary_channel_id: [u8; 32]) -> Transaction {
986 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
987 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
989 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
990 check_added_monitors!(node_a, 0);
992 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
993 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
994 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
996 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
997 assert_eq!(added_monitors.len(), 1);
998 assert_eq!(added_monitors[0].0, funding_output);
999 added_monitors.clear();
1001 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
1003 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()));
1005 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
1006 assert_eq!(added_monitors.len(), 1);
1007 assert_eq!(added_monitors[0].0, funding_output);
1008 added_monitors.clear();
1010 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
1012 let events_4 = node_a.node.get_and_clear_pending_events();
1013 assert_eq!(events_4.len(), 0);
1015 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1016 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1017 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1019 // Ensure that funding_transaction_generated is idempotent.
1020 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
1021 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1022 check_added_monitors!(node_a, 0);
1027 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
1028 pub fn open_zero_conf_channel<'a, 'b, 'c, 'd>(initiator: &'a Node<'b, 'c, 'd>, receiver: &'a Node<'b, 'c, 'd>, initiator_config: Option<UserConfig>) -> (bitcoin::Transaction, [u8; 32]) {
1029 let initiator_channels = initiator.node.list_usable_channels().len();
1030 let receiver_channels = receiver.node.list_usable_channels().len();
1032 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1033 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1035 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1036 let events = receiver.node.get_and_clear_pending_events();
1037 assert_eq!(events.len(), 1);
1039 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1040 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1042 _ => panic!("Unexpected event"),
1045 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1046 assert_eq!(accept_channel.minimum_depth, 0);
1047 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1049 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1050 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1051 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1053 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1054 check_added_monitors!(receiver, 1);
1055 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1056 assert_eq!(bs_signed_locked.len(), 2);
1057 let as_channel_ready;
1058 match &bs_signed_locked[0] {
1059 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1060 assert_eq!(*node_id, initiator.node.get_our_node_id());
1061 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1062 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1063 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1064 check_added_monitors!(initiator, 1);
1066 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1067 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1069 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1071 _ => panic!("Unexpected event"),
1073 match &bs_signed_locked[1] {
1074 MessageSendEvent::SendChannelReady { node_id, msg } => {
1075 assert_eq!(*node_id, initiator.node.get_our_node_id());
1076 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1077 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1079 _ => panic!("Unexpected event"),
1082 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1083 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1085 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1086 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1088 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1089 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1091 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1092 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1094 (tx, as_channel_ready.channel_id)
1097 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 {
1098 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1099 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1100 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1101 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1102 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1103 if node_b.node.get_current_default_configuration().manually_accept_inbound_channels {
1104 let events = node_b.node.get_and_clear_pending_events();
1105 assert_eq!(events.len(), 1);
1107 Event::OpenChannelRequest { temporary_channel_id, counterparty_node_id, .. } =>
1108 node_b.node.accept_inbound_channel(temporary_channel_id, counterparty_node_id, 42).unwrap(),
1109 _ => panic!("Unexpected event"),
1112 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1113 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1114 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1115 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1117 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1120 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) {
1121 confirm_transaction_at(node_conf, tx, conf_height);
1122 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1123 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()));
1126 pub fn create_chan_between_nodes_with_value_confirm_second<'a, 'b, 'c>(node_recv: &Node<'a, 'b, 'c>, node_conf: &Node<'a, 'b, 'c>) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
1128 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1129 assert_eq!(events_6.len(), 3);
1130 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1131 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1133 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1134 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1136 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1137 ((match events_6[0] {
1138 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1139 channel_id = msg.channel_id.clone();
1140 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1143 _ => panic!("Unexpected event"),
1144 }, match events_6[announcement_sigs_idx] {
1145 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1146 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1149 _ => panic!("Unexpected event"),
1153 pub fn create_chan_between_nodes_with_value_confirm<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, tx: &Transaction) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32]) {
1154 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1155 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1156 confirm_transaction_at(node_a, tx, conf_height);
1157 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1158 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1159 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1162 pub fn create_chan_between_nodes_with_value_a<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, channel_value: u64, push_msat: u64) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
1163 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1164 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1168 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) {
1169 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1170 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1171 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1173 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1174 assert_eq!(events_7.len(), 1);
1175 let (announcement, bs_update) = match events_7[0] {
1176 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1177 (msg, update_msg.clone().unwrap())
1179 _ => panic!("Unexpected event"),
1182 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1183 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1184 assert_eq!(events_8.len(), 1);
1185 let as_update = match events_8[0] {
1186 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1187 assert!(*announcement == *msg);
1188 let update_msg = update_msg.clone().unwrap();
1189 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1190 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1193 _ => panic!("Unexpected event"),
1196 *node_a.network_chan_count.borrow_mut() += 1;
1198 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1199 ((*announcement).clone(), as_update, bs_update)
1202 pub fn create_announced_chan_between_nodes<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1203 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1206 pub fn create_announced_chan_between_nodes_with_value<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
1207 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1208 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1209 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1212 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) {
1213 let mut no_announce_cfg = test_default_channel_config();
1214 no_announce_cfg.channel_handshake_config.announced_channel = false;
1215 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1216 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1217 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1218 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1219 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1221 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1222 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1223 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()));
1224 check_added_monitors!(nodes[b], 1);
1226 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1227 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1229 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1230 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1231 check_added_monitors!(nodes[a], 1);
1233 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1234 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1235 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1237 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1238 confirm_transaction_at(&nodes[a], &tx, conf_height);
1239 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1240 confirm_transaction_at(&nodes[b], &tx, conf_height);
1241 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1242 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1243 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()));
1244 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1245 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1246 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1247 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1248 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1250 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1251 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1253 let mut found_a = false;
1254 for chan in nodes[a].node.list_usable_channels() {
1255 if chan.channel_id == as_channel_ready.channel_id {
1258 assert!(!chan.is_public);
1263 let mut found_b = false;
1264 for chan in nodes[b].node.list_usable_channels() {
1265 if chan.channel_id == as_channel_ready.channel_id {
1268 assert!(!chan.is_public);
1273 (as_channel_ready, tx)
1276 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) {
1278 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1279 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1280 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1282 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1283 // forwarding info for local channels even if its not accepted in the network graph.
1284 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1285 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1289 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1290 for outp in tx.output.iter() {
1291 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1293 let mut total_value_in = 0;
1294 for input in tx.input.iter() {
1295 total_value_in += get_output(&input.previous_output).unwrap().value;
1297 let mut total_value_out = 0;
1298 for output in tx.output.iter() {
1299 total_value_out += output.value;
1301 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1302 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1303 assert!(total_value_out + min_fee <= total_value_in);
1304 tx.verify(get_output).unwrap();
1308 macro_rules! check_spends {
1309 ($tx: expr, $($spends_txn: expr),*) => {
1312 for outp in $spends_txn.output.iter() {
1313 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1316 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1318 if out_point.txid == $spends_txn.txid() {
1319 return $spends_txn.output.get(out_point.vout as usize).cloned()
1324 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1329 macro_rules! get_closing_signed_broadcast {
1330 ($node: expr, $dest_pubkey: expr) => {
1332 let events = $node.get_and_clear_pending_msg_events();
1333 assert!(events.len() == 1 || events.len() == 2);
1334 (match events[events.len() - 1] {
1335 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1336 assert_eq!(msg.contents.flags & 2, 2);
1339 _ => panic!("Unexpected event"),
1340 }, if events.len() == 2 {
1342 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1343 assert_eq!(*node_id, $dest_pubkey);
1346 _ => panic!("Unexpected event"),
1354 macro_rules! check_warn_msg {
1355 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1356 let msg_events = $node.node.get_and_clear_pending_msg_events();
1357 assert_eq!(msg_events.len(), 1);
1358 match msg_events[0] {
1359 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1360 assert_eq!(node_id, $recipient_node_id);
1361 assert_eq!(msg.channel_id, $chan_id);
1364 _ => panic!("Unexpected event"),
1369 /// Check that a channel's closing channel update has been broadcasted, and optionally
1370 /// check whether an error message event has occurred.
1371 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1372 let msg_events = node.node.get_and_clear_pending_msg_events();
1373 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1374 msg_events.into_iter().filter_map(|msg_event| {
1376 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1377 assert_eq!(msg.contents.flags & 2, 2);
1380 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1381 assert!(with_error_msg);
1382 // TODO: Check node_id
1385 _ => panic!("Unexpected event"),
1390 /// Check that a channel's closing channel update has been broadcasted, and optionally
1391 /// check whether an error message event has occurred.
1393 /// Don't use this, use the identically-named function instead.
1395 macro_rules! check_closed_broadcast {
1396 ($node: expr, $with_error_msg: expr) => {
1397 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1401 /// Check that a channel's closing channel events has been issued
1402 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1403 let events = node.node.get_and_clear_pending_events();
1404 assert_eq!(events.len(), events_count, "{:?}", events);
1405 let mut issues_discard_funding = false;
1406 for event in events {
1408 Event::ChannelClosed { ref reason, .. } => {
1409 assert_eq!(*reason, expected_reason);
1411 Event::DiscardFunding { .. } => {
1412 issues_discard_funding = true;
1414 _ => panic!("Unexpected event"),
1417 assert_eq!(is_check_discard_funding, issues_discard_funding);
1420 /// Check that a channel's closing channel events has been issued
1422 /// Don't use this, use the identically-named function instead.
1424 macro_rules! check_closed_event {
1425 ($node: expr, $events: expr, $reason: expr) => {
1426 check_closed_event!($node, $events, $reason, false);
1428 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1429 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1433 pub fn close_channel<'a, 'b, 'c>(outbound_node: &Node<'a, 'b, 'c>, inbound_node: &Node<'a, 'b, 'c>, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
1434 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) };
1435 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) };
1438 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1439 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1441 let events_1 = node_b.get_and_clear_pending_msg_events();
1442 assert!(events_1.len() >= 1);
1443 let shutdown_b = match events_1[0] {
1444 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1445 assert_eq!(node_id, &node_a.get_our_node_id());
1448 _ => panic!("Unexpected event"),
1451 let closing_signed_b = if !close_inbound_first {
1452 assert_eq!(events_1.len(), 1);
1455 Some(match events_1[1] {
1456 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1457 assert_eq!(node_id, &node_a.get_our_node_id());
1460 _ => panic!("Unexpected event"),
1464 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1465 let (as_update, bs_update) = if close_inbound_first {
1466 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1467 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1469 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1470 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1471 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1472 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1474 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1475 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1476 assert!(none_a.is_none());
1477 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1478 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1479 (as_update, bs_update)
1481 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1483 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1484 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1486 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1487 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1488 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1490 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1491 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1492 assert!(none_b.is_none());
1493 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1494 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1495 (as_update, bs_update)
1497 assert_eq!(tx_a, tx_b);
1498 check_spends!(tx_a, funding_tx);
1500 (as_update, bs_update, tx_a)
1503 pub struct SendEvent {
1504 pub node_id: PublicKey,
1505 pub msgs: Vec<msgs::UpdateAddHTLC>,
1506 pub commitment_msg: msgs::CommitmentSigned,
1509 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1510 assert!(updates.update_fulfill_htlcs.is_empty());
1511 assert!(updates.update_fail_htlcs.is_empty());
1512 assert!(updates.update_fail_malformed_htlcs.is_empty());
1513 assert!(updates.update_fee.is_none());
1514 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1517 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1519 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1520 _ => panic!("Unexpected event type!"),
1524 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1525 let mut events = node.node.get_and_clear_pending_msg_events();
1526 assert_eq!(events.len(), 1);
1527 SendEvent::from_event(events.pop().unwrap())
1532 /// Don't use this, use the identically-named function instead.
1533 macro_rules! expect_pending_htlcs_forwardable_conditions {
1534 ($node: expr, $expected_failures: expr) => {
1535 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1540 macro_rules! expect_htlc_handling_failed_destinations {
1541 ($events: expr, $expected_failures: expr) => {{
1542 for event in $events {
1544 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1545 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1546 assert!($expected_failures.contains(&failed_next_destination))
1548 _ => panic!("Unexpected destination"),
1554 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1555 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1556 /// `expected_failures` set.
1557 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1559 Event::PendingHTLCsForwardable { .. } => { },
1560 _ => panic!("Unexpected event {:?}", events),
1563 let count = expected_failures.len() + 1;
1564 assert_eq!(events.len(), count);
1566 if expected_failures.len() > 0 {
1567 expect_htlc_handling_failed_destinations!(events, expected_failures)
1572 /// Clears (and ignores) a PendingHTLCsForwardable event
1574 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1576 macro_rules! expect_pending_htlcs_forwardable_ignore {
1578 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1583 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1585 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1586 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1587 ($node: expr, $expected_failures: expr) => {
1588 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1593 /// Handles a PendingHTLCsForwardable event
1594 macro_rules! expect_pending_htlcs_forwardable {
1596 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1597 $node.node.process_pending_htlc_forwards();
1599 // Ensure process_pending_htlc_forwards is idempotent.
1600 $node.node.process_pending_htlc_forwards();
1605 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1606 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1607 ($node: expr, $expected_failures: expr) => {{
1608 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1609 $node.node.process_pending_htlc_forwards();
1611 // Ensure process_pending_htlc_forwards is idempotent.
1612 $node.node.process_pending_htlc_forwards();
1617 macro_rules! expect_pending_htlcs_forwardable_from_events {
1618 ($node: expr, $events: expr, $ignore: expr) => {{
1619 assert_eq!($events.len(), 1);
1621 Event::PendingHTLCsForwardable { .. } => { },
1622 _ => panic!("Unexpected event"),
1625 $node.node.process_pending_htlc_forwards();
1627 // Ensure process_pending_htlc_forwards is idempotent.
1628 $node.node.process_pending_htlc_forwards();
1634 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1635 /// commitment update.
1636 macro_rules! commitment_signed_dance {
1637 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1638 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1640 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1641 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1643 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1645 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1646 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1647 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1648 check_added_monitors(&$node_a, 1);
1649 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1650 assert!(extra_msg_option.is_none());
1654 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1655 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1657 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1658 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1662 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1663 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1664 /// `revoke_and_ack` response to it.
1666 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1667 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1668 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1669 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1670 check_added_monitors(node_a, 1);
1674 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1675 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1676 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1678 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1679 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1680 check_added_monitors!(node_b, 0);
1681 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1682 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1683 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1684 check_added_monitors!(node_b, 1);
1685 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1686 let (bs_revoke_and_ack, extra_msg_option) = {
1687 let mut events = node_b.node.get_and_clear_pending_msg_events();
1688 assert!(events.len() <= 2);
1689 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1690 (match node_a_event {
1691 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1692 assert_eq!(*node_id, node_a.node.get_our_node_id());
1695 _ => panic!("Unexpected event"),
1696 }, events.get(0).map(|e| e.clone()))
1698 check_added_monitors!(node_b, 1);
1700 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1701 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1703 (extra_msg_option, bs_revoke_and_ack)
1706 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1707 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1709 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1710 /// on failure or that no new messages are left over on success.
1711 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1712 check_added_monitors!(node_a, 0);
1713 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1714 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1715 check_added_monitors!(node_a, 1);
1717 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1719 if skip_last_step { return; }
1722 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1723 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1724 check_added_monitors!(node_a, 1);
1726 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1727 let mut number_of_msg_events = 0;
1728 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1729 let peer_state = peer_state_mutex.lock().unwrap();
1730 let cp_pending_msg_events = &peer_state.pending_msg_events;
1731 number_of_msg_events += cp_pending_msg_events.len();
1732 if cp_pending_msg_events.len() == 1 {
1733 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1734 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1735 } else { panic!("Unexpected event"); }
1738 // Expecting the failure backwards event to the previous hop (not `node_b`)
1739 assert_eq!(number_of_msg_events, 1);
1741 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1745 /// Get a payment preimage and hash.
1746 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1747 let mut payment_count = recipient.network_payment_count.borrow_mut();
1748 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1749 *payment_count += 1;
1750 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1751 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1752 (payment_preimage, payment_hash, payment_secret)
1755 /// Get a payment preimage and hash.
1757 /// Don't use this, use the identically-named function instead.
1759 macro_rules! get_payment_preimage_hash {
1760 ($dest_node: expr) => {
1761 get_payment_preimage_hash!($dest_node, None)
1763 ($dest_node: expr, $min_value_msat: expr) => {
1764 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1766 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1767 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1771 /// Gets a route from the given sender to the node described in `payment_params`.
1772 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1773 let scorer = TestScorer::new();
1774 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1775 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1777 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1778 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1779 recv_value, send_node.logger, &scorer, &(), &random_seed_bytes
1783 /// Gets a route from the given sender to the node described in `payment_params`.
1785 /// Don't use this, use the identically-named function instead.
1787 macro_rules! get_route {
1788 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1789 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1795 macro_rules! get_route_and_payment_hash {
1796 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1797 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1798 .with_bolt11_features($recv_node.node.invoice_features()).unwrap();
1799 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1801 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1802 let (payment_preimage, payment_hash, payment_secret) =
1803 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1804 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1805 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1810 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1811 macro_rules! expect_payment_claimable {
1812 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1813 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1815 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1816 let events = $node.node.get_and_clear_pending_events();
1817 assert_eq!(events.len(), 1);
1819 $crate::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1820 assert_eq!($expected_payment_hash, *payment_hash);
1821 assert_eq!($expected_recv_value, amount_msat);
1822 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1824 $crate::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1825 assert_eq!(&$expected_payment_preimage, payment_preimage);
1826 assert_eq!($expected_payment_secret, *payment_secret);
1831 _ => panic!("Unexpected event"),
1837 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1838 macro_rules! expect_payment_claimed {
1839 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1840 let events = $node.node.get_and_clear_pending_events();
1841 assert_eq!(events.len(), 1);
1843 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1844 assert_eq!($expected_payment_hash, *payment_hash);
1845 assert_eq!($expected_recv_value, amount_msat);
1847 _ => panic!("Unexpected event"),
1852 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1853 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1854 expect_per_path_claims: bool,
1856 let events = node.node().get_and_clear_pending_events();
1857 let expected_payment_hash = PaymentHash(
1858 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1859 if expect_per_path_claims {
1860 assert!(events.len() > 1);
1862 assert_eq!(events.len(), 1);
1864 let expected_payment_id = match events[0] {
1865 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1866 assert_eq!(expected_payment_preimage, *payment_preimage);
1867 assert_eq!(expected_payment_hash, *payment_hash);
1868 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1869 assert_eq!(*fee_paid_msat, expected_fee_msat);
1871 assert!(fee_paid_msat.is_some());
1875 _ => panic!("Unexpected event"),
1877 if expect_per_path_claims {
1878 for i in 1..events.len() {
1880 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1881 assert_eq!(payment_id, expected_payment_id);
1882 assert_eq!(payment_hash, Some(expected_payment_hash));
1884 _ => panic!("Unexpected event"),
1892 macro_rules! expect_payment_sent_without_paths {
1893 ($node: expr, $expected_payment_preimage: expr) => {
1894 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1896 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1897 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1902 macro_rules! expect_payment_sent {
1903 ($node: expr, $expected_payment_preimage: expr) => {
1904 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1906 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1907 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1909 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1910 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1911 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1917 macro_rules! expect_payment_path_successful {
1919 let events = $node.node.get_and_clear_pending_events();
1920 assert_eq!(events.len(), 1);
1922 $crate::events::Event::PaymentPathSuccessful { .. } => {},
1923 _ => panic!("Unexpected event"),
1928 macro_rules! expect_payment_forwarded {
1929 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1930 let events = $node.node.get_and_clear_pending_events();
1931 assert_eq!(events.len(), 1);
1933 Event::PaymentForwarded {
1934 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1935 outbound_amount_forwarded_msat: _
1937 assert_eq!(fee_earned_msat, $expected_fee);
1938 if fee_earned_msat.is_some() {
1939 // Is the event prev_channel_id in one of the channels between the two nodes?
1940 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()));
1942 // We check for force closures since a force closed channel is removed from the
1943 // node's channel list
1944 if !$downstream_force_closed {
1945 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()));
1947 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1949 _ => panic!("Unexpected event"),
1956 macro_rules! expect_channel_shutdown_state {
1957 ($node: expr, $chan_id: expr, $state: path) => {
1958 let chan_details = $node.node.list_channels().into_iter().filter(|cd| cd.channel_id == $chan_id).collect::<Vec<ChannelDetails>>();
1959 assert_eq!(chan_details.len(), 1);
1960 assert_eq!(chan_details[0].channel_shutdown_state, Some($state));
1964 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1965 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1966 let events = node.node.get_and_clear_pending_events();
1967 assert_eq!(events.len(), 1);
1969 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1970 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1972 _ => panic!("Unexpected event"),
1976 #[cfg(any(test, ldk_bench, feature = "_test_utils"))]
1977 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1978 let events = node.node.get_and_clear_pending_events();
1979 assert_eq!(events.len(), 1);
1981 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1982 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1984 _ => panic!("Unexpected event"),
1988 pub struct PaymentFailedConditions<'a> {
1989 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1990 pub(crate) expected_blamed_scid: Option<u64>,
1991 pub(crate) expected_blamed_chan_closed: Option<bool>,
1992 pub(crate) expected_mpp_parts_remain: bool,
1995 impl<'a> PaymentFailedConditions<'a> {
1996 pub fn new() -> Self {
1998 expected_htlc_error_data: None,
1999 expected_blamed_scid: None,
2000 expected_blamed_chan_closed: None,
2001 expected_mpp_parts_remain: false,
2004 pub fn mpp_parts_remain(mut self) -> Self {
2005 self.expected_mpp_parts_remain = true;
2008 pub fn blamed_scid(mut self, scid: u64) -> Self {
2009 self.expected_blamed_scid = Some(scid);
2012 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
2013 self.expected_blamed_chan_closed = Some(closed);
2016 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
2017 self.expected_htlc_error_data = Some((code, data));
2023 macro_rules! expect_payment_failed_with_update {
2024 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
2025 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
2026 &$node, $expected_payment_hash, $payment_failed_permanently,
2027 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
2028 .blamed_scid($scid).blamed_chan_closed($chan_closed));
2033 macro_rules! expect_payment_failed {
2034 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
2035 #[allow(unused_mut)]
2036 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
2038 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
2040 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
2044 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
2045 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
2046 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2048 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2049 let expected_payment_id = match &payment_failed_events[0] {
2050 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2054 error_data, .. } => {
2055 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2056 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2059 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2060 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2061 if let Some((code, data)) = conditions.expected_htlc_error_data {
2062 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2063 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2067 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2068 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2070 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2071 if let Some(scid) = conditions.expected_blamed_scid {
2072 assert_eq!(msg.contents.short_channel_id, scid);
2074 const CHAN_DISABLED_FLAG: u8 = 2;
2075 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2077 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2078 if let Some(scid) = conditions.expected_blamed_scid {
2079 assert_eq!(*short_channel_id, scid);
2081 assert!(is_permanent);
2083 _ => panic!("Unexpected update type"),
2085 } else { panic!("Expected network update"); }
2090 _ => panic!("Unexpected event"),
2092 if !conditions.expected_mpp_parts_remain {
2093 match &payment_failed_events[1] {
2094 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2095 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2096 assert_eq!(*payment_id, expected_payment_id);
2097 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2098 PaymentFailureReason::RecipientRejected
2100 PaymentFailureReason::RetriesExhausted
2103 _ => panic!("Unexpected second event"),
2108 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2109 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2110 conditions: PaymentFailedConditions<'e>
2112 let events = node.node.get_and_clear_pending_events();
2113 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2116 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 {
2117 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2118 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2119 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2120 check_added_monitors!(origin_node, expected_paths.len());
2121 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2125 pub fn do_pass_along_path<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], recv_value: u64, our_payment_hash: PaymentHash, our_payment_secret: Option<PaymentSecret>, ev: MessageSendEvent, payment_claimable_expected: bool, clear_recipient_events: bool, expected_preimage: Option<PaymentPreimage>) -> Option<Event> {
2126 let mut payment_event = SendEvent::from_event(ev);
2127 let mut prev_node = origin_node;
2128 let mut event = None;
2130 for (idx, &node) in expected_path.iter().enumerate() {
2131 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2133 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2134 check_added_monitors!(node, 0);
2135 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2137 expect_pending_htlcs_forwardable!(node);
2139 if idx == expected_path.len() - 1 && clear_recipient_events {
2140 let events_2 = node.node.get_and_clear_pending_events();
2141 if payment_claimable_expected {
2142 assert_eq!(events_2.len(), 1);
2143 match &events_2[0] {
2144 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2145 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2146 claim_deadline, onion_fields, ..
2148 assert_eq!(our_payment_hash, *payment_hash);
2149 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2150 assert!(onion_fields.is_some());
2152 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2153 assert_eq!(expected_preimage, *payment_preimage);
2154 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2155 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2157 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2158 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2159 assert_eq!(our_payment_secret, onion_fields.as_ref().unwrap().payment_secret);
2162 assert_eq!(*amount_msat, recv_value);
2163 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2164 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2165 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2167 _ => panic!("Unexpected event"),
2169 event = Some(events_2[0].clone());
2171 assert!(events_2.is_empty());
2173 } else if idx != expected_path.len() - 1 {
2174 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2175 assert_eq!(events_2.len(), 1);
2176 check_added_monitors!(node, 1);
2177 payment_event = SendEvent::from_event(events_2.remove(0));
2178 assert_eq!(payment_event.msgs.len(), 1);
2186 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> {
2187 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2190 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) {
2191 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2192 assert_eq!(events.len(), expected_route.len());
2193 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2194 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2195 // Once we've gotten through all the HTLCs, the last one should result in a
2196 // PaymentClaimable (but each previous one should not!), .
2197 let expect_payment = path_idx == expected_route.len() - 1;
2198 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2202 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) {
2203 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2204 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2205 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2208 pub fn do_claim_payment_along_route<'a, 'b, 'c>(
2209 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], skip_last: bool,
2210 our_payment_preimage: PaymentPreimage
2212 let extra_fees = vec![0; expected_paths.len()];
2213 do_claim_payment_along_route_with_extra_penultimate_hop_fees(origin_node, expected_paths,
2214 &extra_fees[..], skip_last, our_payment_preimage)
2217 pub fn do_claim_payment_along_route_with_extra_penultimate_hop_fees<'a, 'b, 'c>(
2218 origin_node: &Node<'a, 'b, 'c>, expected_paths: &[&[&Node<'a, 'b, 'c>]], expected_extra_fees:
2219 &[u32], skip_last: bool, our_payment_preimage: PaymentPreimage
2221 assert_eq!(expected_paths.len(), expected_extra_fees.len());
2222 for path in expected_paths.iter() {
2223 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2225 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2227 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2228 assert_eq!(claim_event.len(), 1);
2229 match claim_event[0] {
2230 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2231 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2232 assert_eq!(preimage, our_payment_preimage),
2233 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2234 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2238 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2240 let mut expected_total_fee_msat = 0;
2242 macro_rules! msgs_from_ev {
2245 &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 } } => {
2246 assert!(update_add_htlcs.is_empty());
2247 assert_eq!(update_fulfill_htlcs.len(), 1);
2248 assert!(update_fail_htlcs.is_empty());
2249 assert!(update_fail_malformed_htlcs.is_empty());
2250 assert!(update_fee.is_none());
2251 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2253 _ => panic!("Unexpected event"),
2257 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2258 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2259 assert_eq!(events.len(), expected_paths.len());
2261 if events.len() == 1 {
2262 per_path_msgs.push(msgs_from_ev!(&events[0]));
2264 for expected_path in expected_paths.iter() {
2265 // For MPP payments, we always want the message to the first node in the path.
2266 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2267 per_path_msgs.push(msgs_from_ev!(&ev));
2271 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2272 let mut next_msgs = Some(path_msgs);
2273 let mut expected_next_node = next_hop;
2275 macro_rules! last_update_fulfill_dance {
2276 ($node: expr, $prev_node: expr) => {
2278 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2279 check_added_monitors!($node, 0);
2280 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2281 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2285 macro_rules! mid_update_fulfill_dance {
2286 ($idx: expr, $node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2288 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2290 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2291 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2292 .unwrap().lock().unwrap();
2293 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2294 if let Some(prev_config) = channel.context.prev_config() {
2295 prev_config.forwarding_fee_base_msat
2297 channel.context.config().forwarding_fee_base_msat
2300 if $idx == 1 { fee += expected_extra_fees[i]; }
2301 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2302 expected_total_fee_msat += fee as u64;
2303 check_added_monitors!($node, 1);
2304 let new_next_msgs = if $new_msgs {
2305 let events = $node.node.get_and_clear_pending_msg_events();
2306 assert_eq!(events.len(), 1);
2307 let (res, nexthop) = msgs_from_ev!(&events[0]);
2308 expected_next_node = nexthop;
2311 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2314 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2315 next_msgs = new_next_msgs;
2320 let mut prev_node = expected_route.last().unwrap();
2321 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2322 assert_eq!(expected_next_node, node.node.get_our_node_id());
2323 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2324 if next_msgs.is_some() {
2325 // Since we are traversing in reverse, next_node is actually the previous node
2326 let next_node: &Node;
2327 if idx == expected_route.len() - 1 {
2328 next_node = origin_node;
2330 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2332 mid_update_fulfill_dance!(idx, node, prev_node, next_node, update_next_msgs);
2334 assert!(!update_next_msgs);
2335 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2337 if !skip_last && idx == expected_route.len() - 1 {
2338 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2345 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2349 // Ensure that claim_funds is idempotent.
2350 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2351 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2352 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2354 expected_total_fee_msat
2356 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) {
2357 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2359 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2363 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2364 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2367 pub const TEST_FINAL_CLTV: u32 = 70;
2369 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) {
2370 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2371 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2372 let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2373 assert_eq!(route.paths.len(), 1);
2374 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2375 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2376 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2379 let res = send_along_route(origin_node, route, expected_route, recv_value);
2380 (res.0, res.1, res.2)
2383 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2384 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2385 .with_bolt11_features(expected_route.last().unwrap().node.invoice_features()).unwrap();
2386 let network_graph = origin_node.network_graph.read_only();
2387 let scorer = test_utils::TestScorer::new();
2388 let seed = [0u8; 32];
2389 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2390 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2391 let route = router::get_route(
2392 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2393 None, recv_value, origin_node.logger, &scorer, &(), &random_seed_bytes).unwrap();
2394 assert_eq!(route.paths.len(), 1);
2395 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2396 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2397 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2400 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2401 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2402 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2403 true, APIError::ChannelUnavailable { ref err },
2404 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2407 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2408 let res = route_payment(&origin, expected_route, recv_value);
2409 claim_payment(&origin, expected_route, res.0);
2413 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) {
2414 for path in expected_paths.iter() {
2415 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2417 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2418 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2419 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2421 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2424 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) {
2425 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2426 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2428 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2429 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2430 assert_eq!(events.len(), expected_paths.len());
2431 for ev in events.iter() {
2432 let (update_fail, commitment_signed, node_id) = match ev {
2433 &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 } } => {
2434 assert!(update_add_htlcs.is_empty());
2435 assert!(update_fulfill_htlcs.is_empty());
2436 assert_eq!(update_fail_htlcs.len(), 1);
2437 assert!(update_fail_malformed_htlcs.is_empty());
2438 assert!(update_fee.is_none());
2439 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2441 _ => panic!("Unexpected event"),
2443 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2445 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2446 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()));
2448 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2449 let mut next_msgs = Some(path_msgs);
2450 let mut expected_next_node = next_hop;
2451 let mut prev_node = expected_route.last().unwrap();
2453 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2454 assert_eq!(expected_next_node, node.node.get_our_node_id());
2455 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2456 if next_msgs.is_some() {
2457 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2458 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2459 if !update_next_node {
2460 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 }]);
2463 let events = node.node.get_and_clear_pending_msg_events();
2464 if update_next_node {
2465 assert_eq!(events.len(), 1);
2467 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 } } => {
2468 assert!(update_add_htlcs.is_empty());
2469 assert!(update_fulfill_htlcs.is_empty());
2470 assert_eq!(update_fail_htlcs.len(), 1);
2471 assert!(update_fail_malformed_htlcs.is_empty());
2472 assert!(update_fee.is_none());
2473 expected_next_node = node_id.clone();
2474 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2476 _ => panic!("Unexpected event"),
2479 assert!(events.is_empty());
2481 if !skip_last && idx == expected_route.len() - 1 {
2482 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2489 let prev_node = expected_route.first().unwrap();
2490 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2491 check_added_monitors!(origin_node, 0);
2492 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2493 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2494 let events = origin_node.node.get_and_clear_pending_events();
2495 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2497 let expected_payment_id = match events[0] {
2498 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2499 assert_eq!(payment_hash, our_payment_hash);
2500 assert!(payment_failed_permanently);
2501 for (idx, hop) in expected_route.iter().enumerate() {
2502 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2506 _ => panic!("Unexpected event"),
2508 if i == expected_paths.len() - 1 {
2510 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2511 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2512 assert_eq!(*payment_id, expected_payment_id);
2513 assert_eq!(reason.unwrap(), expected_fail_reason);
2515 _ => panic!("Unexpected second event"),
2521 // Ensure that fail_htlc_backwards is idempotent.
2522 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2523 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2524 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2525 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2528 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2529 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2532 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2533 let mut chan_mon_cfgs = Vec::new();
2534 for i in 0..node_count {
2535 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2536 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2537 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2538 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2539 let persister = test_utils::TestPersister::new();
2540 let seed = [i as u8; 32];
2541 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2542 let scorer = Mutex::new(test_utils::TestScorer::new());
2544 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2550 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2551 let mut nodes = Vec::new();
2553 for i in 0..node_count {
2554 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[i].chain_source), &chanmon_cfgs[i].tx_broadcaster, &chanmon_cfgs[i].logger, &chanmon_cfgs[i].fee_estimator, &chanmon_cfgs[i].persister, &chanmon_cfgs[i].keys_manager);
2555 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2556 let seed = [i as u8; 32];
2557 nodes.push(NodeCfg {
2558 chain_source: &chanmon_cfgs[i].chain_source,
2559 logger: &chanmon_cfgs[i].logger,
2560 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2561 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2562 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2564 keys_manager: &chanmon_cfgs[i].keys_manager,
2567 override_init_features: Rc::new(RefCell::new(None)),
2574 pub fn test_default_channel_config() -> UserConfig {
2575 let mut default_config = UserConfig::default();
2576 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2577 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2578 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2579 default_config.channel_handshake_config.announced_channel = true;
2580 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2581 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2582 // It now defaults to 1, so we simply set it to the expected value here.
2583 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2584 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2585 // to avoid interfering with tests we bump it to 50_000_000 msat (assuming the default test
2587 default_config.channel_config.max_dust_htlc_exposure =
2588 MaxDustHTLCExposure::FeeRateMultiplier(50_000_000 / 253);
2592 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>> {
2593 let mut chanmgrs = Vec::new();
2594 for i in 0..node_count {
2595 let network = Network::Testnet;
2596 let genesis_block = bitcoin::blockdata::constants::genesis_block(network);
2597 let params = ChainParameters {
2599 best_block: BestBlock::from_network(network),
2601 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,
2602 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);
2603 chanmgrs.push(node);
2609 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>> {
2610 let mut nodes = Vec::new();
2611 let chan_count = Rc::new(RefCell::new(0));
2612 let payment_count = Rc::new(RefCell::new(0));
2613 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2615 for i in 0..node_count {
2616 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2618 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2619 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2620 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2621 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2622 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2623 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2624 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2625 connect_style: Rc::clone(&connect_style),
2626 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2630 for i in 0..node_count {
2631 for j in (i+1)..node_count {
2632 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init {
2633 features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()),
2635 remote_network_address: None,
2637 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init {
2638 features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()),
2640 remote_network_address: None,
2648 // Note that the following only works for CLTV values up to 128
2649 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2651 #[derive(PartialEq)]
2652 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2653 /// Tests that the given node has broadcast transactions for the given Channel
2655 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2656 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2657 /// broadcast and the revoked outputs were claimed.
2659 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2660 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2662 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2664 pub fn test_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2665 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2666 let mut txn_seen = HashSet::new();
2667 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2668 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2670 let mut res = Vec::with_capacity(2);
2671 node_txn.retain(|tx| {
2672 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2673 check_spends!(tx, chan.3);
2674 if commitment_tx.is_none() {
2675 res.push(tx.clone());
2680 if let Some(explicit_tx) = commitment_tx {
2681 res.push(explicit_tx.clone());
2684 assert_eq!(res.len(), 1);
2686 if has_htlc_tx != HTLCType::NONE {
2687 node_txn.retain(|tx| {
2688 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2689 check_spends!(tx, res[0]);
2690 if has_htlc_tx == HTLCType::TIMEOUT {
2691 assert!(tx.lock_time.0 != 0);
2693 assert!(tx.lock_time.0 == 0);
2695 res.push(tx.clone());
2699 assert!(res.len() == 2 || res.len() == 3);
2701 assert_eq!(res[1], res[2]);
2705 assert!(node_txn.is_empty());
2709 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2710 /// HTLC transaction.
2711 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2712 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2713 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2714 // for revoked htlc outputs
2715 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2716 node_txn.retain(|tx| {
2717 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2718 check_spends!(tx, revoked_tx);
2722 node_txn.retain(|tx| {
2723 check_spends!(tx, commitment_revoked_tx);
2726 assert!(node_txn.is_empty());
2729 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2730 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2731 let mut txn_seen = HashSet::new();
2732 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2734 let mut found_prev = false;
2735 for prev_tx in prev_txn {
2736 for tx in &*node_txn {
2737 if tx.input[0].previous_output.txid == prev_tx.txid() {
2738 check_spends!(tx, prev_tx);
2739 let mut iter = tx.input[0].witness.iter();
2740 iter.next().expect("expected 3 witness items");
2741 iter.next().expect("expected 3 witness items");
2742 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2743 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2750 assert!(found_prev);
2752 let mut res = Vec::new();
2753 mem::swap(&mut *node_txn, &mut res);
2757 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) {
2758 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2759 assert_eq!(events_1.len(), 2);
2760 let as_update = match events_1[0] {
2761 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2764 _ => panic!("Unexpected event"),
2767 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2768 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2769 assert_eq!(msg.data, expected_error);
2770 if needs_err_handle {
2771 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2774 _ => panic!("Unexpected event"),
2777 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2778 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2779 let bs_update = match events_2[0] {
2780 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2783 _ => panic!("Unexpected event"),
2785 if !needs_err_handle {
2787 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2788 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2789 assert_eq!(msg.data, expected_error);
2791 _ => panic!("Unexpected event"),
2796 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2797 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2801 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2802 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2806 macro_rules! get_channel_value_stat {
2807 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2808 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2809 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2810 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2811 chan.get_value_stat()
2815 macro_rules! get_chan_reestablish_msgs {
2816 ($src_node: expr, $dst_node: expr) => {
2818 let mut announcements = $crate::prelude::HashSet::new();
2819 let mut res = Vec::with_capacity(1);
2820 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2821 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2822 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2823 res.push(msg.clone());
2824 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2825 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2826 announcements.insert(msg.contents.short_channel_id);
2828 panic!("Unexpected event")
2831 for chan in $src_node.node.list_channels() {
2832 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2833 if let Some(scid) = chan.short_channel_id {
2834 assert!(announcements.remove(&scid));
2838 assert!(announcements.is_empty());
2844 macro_rules! handle_chan_reestablish_msgs {
2845 ($src_node: expr, $dst_node: expr) => {
2847 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2849 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2851 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2857 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2859 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2862 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2863 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2864 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2866 had_channel_update = true;
2869 let mut revoke_and_ack = None;
2870 let mut commitment_update = None;
2871 let order = if let Some(ev) = msg_events.get(idx) {
2873 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2874 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2875 revoke_and_ack = Some(msg.clone());
2877 RAACommitmentOrder::RevokeAndACKFirst
2879 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2880 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2881 commitment_update = Some(updates.clone());
2883 RAACommitmentOrder::CommitmentFirst
2885 _ => RAACommitmentOrder::CommitmentFirst,
2888 RAACommitmentOrder::CommitmentFirst
2891 if let Some(ev) = msg_events.get(idx) {
2893 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2894 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2895 assert!(revoke_and_ack.is_none());
2896 revoke_and_ack = Some(msg.clone());
2899 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2900 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2901 assert!(commitment_update.is_none());
2902 commitment_update = Some(updates.clone());
2909 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2910 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2912 assert!(!had_channel_update);
2915 assert_eq!(msg_events.len(), idx);
2917 (channel_ready, revoke_and_ack, commitment_update, order)
2922 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2923 /// for claims/fails they are separated out.
2924 pub fn reconnect_nodes<'a, 'b, 'c>(node_a: &Node<'a, 'b, 'c>, node_b: &Node<'a, 'b, 'c>, send_channel_ready: (bool, bool), pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_htlc_fails: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
2925 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init {
2926 features: node_b.node.init_features(), networks: None, remote_network_address: None
2928 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2929 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init {
2930 features: node_a.node.init_features(), networks: None, remote_network_address: None
2932 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2934 if send_channel_ready.0 {
2935 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2937 for reestablish in reestablish_1.iter() {
2938 assert_eq!(reestablish.next_remote_commitment_number, 0);
2941 if send_channel_ready.1 {
2942 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2944 for reestablish in reestablish_2.iter() {
2945 assert_eq!(reestablish.next_remote_commitment_number, 0);
2948 if send_channel_ready.0 || send_channel_ready.1 {
2949 // If we expect any channel_ready's, both sides better have set
2950 // next_holder_commitment_number to 1
2951 for reestablish in reestablish_1.iter() {
2952 assert_eq!(reestablish.next_local_commitment_number, 1);
2954 for reestablish in reestablish_2.iter() {
2955 assert_eq!(reestablish.next_local_commitment_number, 1);
2959 let mut resp_1 = Vec::new();
2960 for msg in reestablish_1 {
2961 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2962 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2964 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2965 check_added_monitors!(node_b, 1);
2967 check_added_monitors!(node_b, 0);
2970 let mut resp_2 = Vec::new();
2971 for msg in reestablish_2 {
2972 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2973 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2975 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2976 check_added_monitors!(node_a, 1);
2978 check_added_monitors!(node_a, 0);
2981 // We don't yet support both needing updates, as that would require a different commitment dance:
2982 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2983 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2984 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2985 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2987 for chan_msgs in resp_1.drain(..) {
2988 if send_channel_ready.0 {
2989 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2990 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2991 if !announcement_event.is_empty() {
2992 assert_eq!(announcement_event.len(), 1);
2993 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2994 //TODO: Test announcement_sigs re-sending
2995 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2998 assert!(chan_msgs.0.is_none());
3001 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3002 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
3003 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3004 check_added_monitors!(node_a, 1);
3006 assert!(chan_msgs.1.is_none());
3008 if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_htlc_fails.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
3009 let commitment_update = chan_msgs.2.unwrap();
3010 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3011 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
3013 assert!(commitment_update.update_add_htlcs.is_empty());
3015 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
3016 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
3017 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3018 for update_add in commitment_update.update_add_htlcs {
3019 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
3021 for update_fulfill in commitment_update.update_fulfill_htlcs {
3022 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
3024 for update_fail in commitment_update.update_fail_htlcs {
3025 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
3028 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
3029 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
3031 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
3032 check_added_monitors!(node_a, 1);
3033 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
3034 // No commitment_signed so get_event_msg's assert(len == 1) passes
3035 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
3036 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3037 check_added_monitors!(node_b, 1);
3040 assert!(chan_msgs.2.is_none());
3044 for chan_msgs in resp_2.drain(..) {
3045 if send_channel_ready.1 {
3046 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
3047 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
3048 if !announcement_event.is_empty() {
3049 assert_eq!(announcement_event.len(), 1);
3050 match announcement_event[0] {
3051 MessageSendEvent::SendChannelUpdate { .. } => {},
3052 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
3053 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
3057 assert!(chan_msgs.0.is_none());
3060 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
3061 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
3062 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
3063 check_added_monitors!(node_b, 1);
3065 assert!(chan_msgs.1.is_none());
3067 if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_htlc_fails.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
3068 let commitment_update = chan_msgs.2.unwrap();
3069 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3070 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
3072 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
3073 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
3074 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
3075 for update_add in commitment_update.update_add_htlcs {
3076 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3078 for update_fulfill in commitment_update.update_fulfill_htlcs {
3079 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3081 for update_fail in commitment_update.update_fail_htlcs {
3082 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3085 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3086 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3088 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3089 check_added_monitors!(node_b, 1);
3090 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3091 // No commitment_signed so get_event_msg's assert(len == 1) passes
3092 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3093 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3094 check_added_monitors!(node_a, 1);
3097 assert!(chan_msgs.2.is_none());