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;
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 block = Block {
89 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
92 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
93 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
96 block.txdata.push((*tx).clone());
98 connect_block(node, &block);
99 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
101 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
102 confirm_transactions_at(node, &[tx], conf_height)
105 /// The possible ways we may notify a ChannelManager of a new block
106 #[derive(Clone, Copy, Debug, PartialEq)]
107 pub enum ConnectStyle {
108 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
109 /// the header and height information.
111 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
112 /// make a single `best_block_updated` call.
113 BestBlockFirstSkippingBlocks,
114 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
115 /// `transaction_unconfirmed` is called.
116 BestBlockFirstReorgsOnlyTip,
117 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
118 /// the header and height information.
120 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
121 /// make a single `best_block_updated` call.
122 TransactionsFirstSkippingBlocks,
123 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
124 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
125 /// times to ensure it's idempotent.
126 TransactionsDuplicativelyFirstSkippingBlocks,
127 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
128 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
129 /// times to ensure it's idempotent.
130 HighlyRedundantTransactionsFirstSkippingBlocks,
131 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
132 /// `transaction_unconfirmed` is called.
133 TransactionsFirstReorgsOnlyTip,
134 /// Provides the full block via the `chain::Listen` interface. In the current code this is
135 /// equivalent to `TransactionsFirst` with some additional assertions.
140 pub fn skips_blocks(&self) -> bool {
142 ConnectStyle::BestBlockFirst => false,
143 ConnectStyle::BestBlockFirstSkippingBlocks => true,
144 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
145 ConnectStyle::TransactionsFirst => false,
146 ConnectStyle::TransactionsFirstSkippingBlocks => true,
147 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => true,
148 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => true,
149 ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
150 ConnectStyle::FullBlockViaListen => false,
154 pub fn updates_best_block_first(&self) -> bool {
156 ConnectStyle::BestBlockFirst => true,
157 ConnectStyle::BestBlockFirstSkippingBlocks => true,
158 ConnectStyle::BestBlockFirstReorgsOnlyTip => true,
159 ConnectStyle::TransactionsFirst => false,
160 ConnectStyle::TransactionsFirstSkippingBlocks => false,
161 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => false,
162 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks => false,
163 ConnectStyle::TransactionsFirstReorgsOnlyTip => false,
164 ConnectStyle::FullBlockViaListen => false,
168 fn random_style() -> ConnectStyle {
169 #[cfg(feature = "std")] {
170 use core::hash::{BuildHasher, Hasher};
171 // Get a random value using the only std API to do so - the DefaultHasher
172 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
173 let res = match rand_val % 9 {
174 0 => ConnectStyle::BestBlockFirst,
175 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
176 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
177 3 => ConnectStyle::TransactionsFirst,
178 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
179 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
180 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
181 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
182 8 => ConnectStyle::FullBlockViaListen,
185 eprintln!("Using Block Connection Style: {:?}", res);
188 #[cfg(not(feature = "std"))] {
189 ConnectStyle::FullBlockViaListen
194 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
195 let skip_intermediaries = node.connect_style.borrow().skips_blocks();
197 let height = node.best_block_info().1 + 1;
198 let mut block = Block {
199 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
204 let prev_blockhash = block.header.block_hash();
205 do_connect_block(node, block, skip_intermediaries);
207 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
211 let hash = block.header.block_hash();
212 do_connect_block(node, block, false);
216 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
217 do_connect_block(node, block.clone(), false);
220 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
221 // Ensure `get_claimable_balances`' self-tests never panic
222 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
223 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
227 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
228 call_claimable_balances(node);
229 let height = node.best_block_info().1 + 1;
230 #[cfg(feature = "std")] {
231 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
233 // Update the block internally before handing it over to LDK, to ensure our assertions regarding
234 // transaction broadcast are correct.
235 node.blocks.lock().unwrap().push((block.clone(), height));
236 if !skip_intermediaries {
237 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
238 match *node.connect_style.borrow() {
239 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
240 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
241 call_claimable_balances(node);
242 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
243 node.node.best_block_updated(&block.header, height);
244 node.node.transactions_confirmed(&block.header, &txdata, height);
246 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
247 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
248 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
249 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
250 let mut connections = Vec::new();
251 for (block, height) in node.blocks.lock().unwrap().iter() {
252 if !block.txdata.is_empty() {
253 // Reconnect all transactions we've ever seen to ensure transaction connection
254 // is *really* idempotent. This is a somewhat likely deployment for some
255 // esplora implementations of chain sync which try to reduce state and
256 // complexity as much as possible.
258 // Sadly we have to clone the block here to maintain lockorder. In the
259 // future we should consider Arc'ing the blocks to avoid this.
260 connections.push((block.clone(), *height));
263 for (old_block, height) in connections {
264 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
265 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
268 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
269 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
270 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
272 call_claimable_balances(node);
273 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
274 node.node.transactions_confirmed(&block.header, &txdata, height);
275 node.node.best_block_updated(&block.header, height);
277 ConnectStyle::FullBlockViaListen => {
278 node.chain_monitor.chain_monitor.block_connected(&block, height);
279 node.node.block_connected(&block, height);
283 call_claimable_balances(node);
284 node.node.test_process_background_events();
287 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
288 call_claimable_balances(node);
289 #[cfg(feature = "std")] {
290 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
293 let orig = node.blocks.lock().unwrap().pop().unwrap();
294 assert!(orig.1 > 0); // Cannot disconnect genesis
295 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
297 match *node.connect_style.borrow() {
298 ConnectStyle::FullBlockViaListen => {
299 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
300 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
302 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
303 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
305 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
306 node.node.best_block_updated(&prev.0.header, prev.1);
309 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
310 for tx in orig.0.txdata {
311 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
312 node.node.transaction_unconfirmed(&tx.txid());
316 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
317 node.node.best_block_updated(&prev.0.header, prev.1);
320 call_claimable_balances(node);
324 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
325 let count = node.blocks.lock().unwrap().len() as u32 - 1;
326 disconnect_blocks(node, count);
329 pub struct TestChanMonCfg {
330 pub tx_broadcaster: test_utils::TestBroadcaster,
331 pub fee_estimator: test_utils::TestFeeEstimator,
332 pub chain_source: test_utils::TestChainSource,
333 pub persister: test_utils::TestPersister,
334 pub logger: test_utils::TestLogger,
335 pub keys_manager: test_utils::TestKeysInterface,
336 pub scorer: Mutex<test_utils::TestScorer>,
339 pub struct NodeCfg<'a> {
340 pub chain_source: &'a test_utils::TestChainSource,
341 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
342 pub fee_estimator: &'a test_utils::TestFeeEstimator,
343 pub router: test_utils::TestRouter<'a>,
344 pub chain_monitor: test_utils::TestChainMonitor<'a>,
345 pub keys_manager: &'a test_utils::TestKeysInterface,
346 pub logger: &'a test_utils::TestLogger,
347 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
348 pub node_seed: [u8; 32],
349 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
352 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>;
354 pub struct Node<'a, 'b: 'a, 'c: 'b> {
355 pub chain_source: &'c test_utils::TestChainSource,
356 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
357 pub fee_estimator: &'c test_utils::TestFeeEstimator,
358 pub router: &'b test_utils::TestRouter<'c>,
359 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
360 pub keys_manager: &'b test_utils::TestKeysInterface,
361 pub node: &'a TestChannelManager<'a, 'b, 'c>,
362 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
363 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
364 pub node_seed: [u8; 32],
365 pub network_payment_count: Rc<RefCell<u8>>,
366 pub network_chan_count: Rc<RefCell<u32>>,
367 pub logger: &'c test_utils::TestLogger,
368 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
369 pub connect_style: Rc<RefCell<ConnectStyle>>,
370 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
372 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
373 pub fn best_block_hash(&self) -> BlockHash {
374 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
376 pub fn best_block_info(&self) -> (BlockHash, u32) {
377 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
379 pub fn get_block_header(&self, height: u32) -> BlockHeader {
380 self.blocks.lock().unwrap()[height as usize].0.header
384 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
385 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
386 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
388 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
390 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
391 Self((node as *const Node<'a, 'b, 'c>).cast())
394 unsafe impl Send for NodePtr {}
395 unsafe impl Sync for NodePtr {}
398 pub trait NodeHolder {
399 type CM: AChannelManager;
400 fn node(&self) -> &ChannelManager<
401 <Self::CM as AChannelManager>::M,
402 <Self::CM as AChannelManager>::T,
403 <Self::CM as AChannelManager>::ES,
404 <Self::CM as AChannelManager>::NS,
405 <Self::CM as AChannelManager>::SP,
406 <Self::CM as AChannelManager>::F,
407 <Self::CM as AChannelManager>::R,
408 <Self::CM as AChannelManager>::L>;
409 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
411 impl<H: NodeHolder> NodeHolder for &H {
413 fn node(&self) -> &ChannelManager<
414 <Self::CM as AChannelManager>::M,
415 <Self::CM as AChannelManager>::T,
416 <Self::CM as AChannelManager>::ES,
417 <Self::CM as AChannelManager>::NS,
418 <Self::CM as AChannelManager>::SP,
419 <Self::CM as AChannelManager>::F,
420 <Self::CM as AChannelManager>::R,
421 <Self::CM as AChannelManager>::L> { (*self).node() }
422 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
424 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
425 type CM = TestChannelManager<'a, 'b, 'c>;
426 fn node(&self) -> &TestChannelManager<'a, 'b, 'c> { &self.node }
427 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
430 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
433 // Check that we processed all pending events
434 let msg_events = self.node.get_and_clear_pending_msg_events();
435 if !msg_events.is_empty() {
436 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
438 let events = self.node.get_and_clear_pending_events();
439 if !events.is_empty() {
440 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
442 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
443 if !added_monitors.is_empty() {
444 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
447 // Check that if we serialize the network graph, we can deserialize it again.
448 let network_graph = {
449 let mut w = test_utils::TestVecWriter(Vec::new());
450 self.network_graph.write(&mut w).unwrap();
451 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
452 assert!(network_graph_deser == *self.network_graph);
453 let gossip_sync = P2PGossipSync::new(
454 &network_graph_deser, Some(self.chain_source), self.logger
456 let mut chan_progress = 0;
458 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
459 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
460 assert!(orig_announcements == deserialized_announcements);
461 chan_progress = match orig_announcements {
462 Some(announcement) => announcement.0.contents.short_channel_id + 1,
466 let mut node_progress = None;
468 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
469 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
470 assert!(orig_announcements == deserialized_announcements);
471 node_progress = match orig_announcements {
472 Some(announcement) => Some(announcement.contents.node_id),
479 // Check that if we serialize and then deserialize all our channel monitors we get the
480 // same set of outputs to watch for on chain as we have now. Note that if we write
481 // tests that fully close channels and remove the monitors at some point this may break.
482 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
483 let mut deserialized_monitors = Vec::new();
485 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
486 let mut w = test_utils::TestVecWriter(Vec::new());
487 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
488 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
489 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
490 deserialized_monitors.push(deserialized_monitor);
494 let broadcaster = test_utils::TestBroadcaster {
495 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
496 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
499 // Before using all the new monitors to check the watch outpoints, use the full set of
500 // them to ensure we can write and reload our ChannelManager.
502 let mut channel_monitors = HashMap::new();
503 for monitor in deserialized_monitors.iter_mut() {
504 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
507 let scorer = Mutex::new(test_utils::TestScorer::new());
508 let mut w = test_utils::TestVecWriter(Vec::new());
509 self.node.write(&mut w).unwrap();
510 <(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 {
511 default_config: *self.node.get_current_default_configuration(),
512 entropy_source: self.keys_manager,
513 node_signer: self.keys_manager,
514 signer_provider: self.keys_manager,
515 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
516 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
517 chain_monitor: self.chain_monitor,
518 tx_broadcaster: &broadcaster,
519 logger: &self.logger,
524 let persister = test_utils::TestPersister::new();
525 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
526 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
527 for deserialized_monitor in deserialized_monitors.drain(..) {
528 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
532 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
533 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
538 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) {
539 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
542 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) {
543 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
544 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
545 (announcement, as_update, bs_update, channel_id, tx)
548 /// Gets an RAA and CS which were sent in response to a commitment update
549 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
550 let events = node.node().get_and_clear_pending_msg_events();
551 assert_eq!(events.len(), 2);
553 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
554 assert_eq!(node_id, recipient);
557 _ => panic!("Unexpected event"),
559 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
560 assert_eq!(node_id, recipient);
561 assert!(updates.update_add_htlcs.is_empty());
562 assert!(updates.update_fulfill_htlcs.is_empty());
563 assert!(updates.update_fail_htlcs.is_empty());
564 assert!(updates.update_fail_malformed_htlcs.is_empty());
565 assert!(updates.update_fee.is_none());
566 updates.commitment_signed.clone()
568 _ => panic!("Unexpected event"),
573 /// Gets an RAA and CS which were sent in response to a commitment update
575 /// Don't use this, use the identically-named function instead.
576 macro_rules! get_revoke_commit_msgs {
577 ($node: expr, $node_id: expr) => {
578 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
582 /// Get an specific event message from the pending events queue.
584 macro_rules! get_event_msg {
585 ($node: expr, $event_type: path, $node_id: expr) => {
587 let events = $node.node.get_and_clear_pending_msg_events();
588 assert_eq!(events.len(), 1);
590 $event_type { ref node_id, ref msg } => {
591 assert_eq!(*node_id, $node_id);
594 _ => panic!("Unexpected event"),
600 /// Get an error message from the pending events queue.
601 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
602 let events = node.node.get_and_clear_pending_msg_events();
603 assert_eq!(events.len(), 1);
605 MessageSendEvent::HandleError {
606 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
608 assert_eq!(node_id, recipient);
611 _ => panic!("Unexpected event"),
615 /// Get a specific event from the pending events queue.
617 macro_rules! get_event {
618 ($node: expr, $event_type: path) => {
620 let mut events = $node.node.get_and_clear_pending_events();
621 assert_eq!(events.len(), 1);
622 let ev = events.pop().unwrap();
624 $event_type { .. } => {
627 _ => panic!("Unexpected event"),
633 /// Gets an UpdateHTLCs MessageSendEvent
634 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
635 let events = node.node.get_and_clear_pending_msg_events();
636 assert_eq!(events.len(), 1);
638 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
639 assert_eq!(node_id, recipient);
642 _ => panic!("Unexpected event"),
647 /// Gets an UpdateHTLCs MessageSendEvent
649 /// Don't use this, use the identically-named function instead.
650 macro_rules! get_htlc_update_msgs {
651 ($node: expr, $node_id: expr) => {
652 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
656 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
657 /// Returns the `msg_event`.
659 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
660 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
661 /// such messages are intended to all peers.
662 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
663 let ev_index = msg_events.iter().position(|e| { match e {
664 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
665 node_id == msg_node_id
667 MessageSendEvent::SendOpenChannel { node_id, .. } => {
668 node_id == msg_node_id
670 MessageSendEvent::SendFundingCreated { node_id, .. } => {
671 node_id == msg_node_id
673 MessageSendEvent::SendFundingSigned { node_id, .. } => {
674 node_id == msg_node_id
676 MessageSendEvent::SendChannelReady { node_id, .. } => {
677 node_id == msg_node_id
679 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
680 node_id == msg_node_id
682 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
683 node_id == msg_node_id
685 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
686 node_id == msg_node_id
688 MessageSendEvent::SendClosingSigned { node_id, .. } => {
689 node_id == msg_node_id
691 MessageSendEvent::SendShutdown { node_id, .. } => {
692 node_id == msg_node_id
694 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
695 node_id == msg_node_id
697 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
698 node_id == msg_node_id
700 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
703 MessageSendEvent::BroadcastChannelUpdate { .. } => {
706 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
709 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
710 node_id == msg_node_id
712 MessageSendEvent::HandleError { node_id, .. } => {
713 node_id == msg_node_id
715 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
716 node_id == msg_node_id
718 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
719 node_id == msg_node_id
721 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
722 node_id == msg_node_id
724 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
725 node_id == msg_node_id
727 MessageSendEvent::SendAcceptChannelV2 { node_id, .. } => {
728 node_id == msg_node_id
730 MessageSendEvent::SendOpenChannelV2 { node_id, .. } => {
731 node_id == msg_node_id
733 MessageSendEvent::SendTxAddInput { node_id, .. } => {
734 node_id == msg_node_id
736 MessageSendEvent::SendTxAddOutput { node_id, .. } => {
737 node_id == msg_node_id
739 MessageSendEvent::SendTxRemoveInput { node_id, .. } => {
740 node_id == msg_node_id
742 MessageSendEvent::SendTxRemoveOutput { node_id, .. } => {
743 node_id == msg_node_id
745 MessageSendEvent::SendTxComplete { node_id, .. } => {
746 node_id == msg_node_id
748 MessageSendEvent::SendTxSignatures { node_id, .. } => {
749 node_id == msg_node_id
751 MessageSendEvent::SendTxInitRbf { node_id, .. } => {
752 node_id == msg_node_id
754 MessageSendEvent::SendTxAckRbf { node_id, .. } => {
755 node_id == msg_node_id
757 MessageSendEvent::SendTxAbort { node_id, .. } => {
758 node_id == msg_node_id
761 if ev_index.is_some() {
762 msg_events.remove(ev_index.unwrap())
764 panic!("Couldn't find any MessageSendEvent to the node!")
769 macro_rules! get_channel_ref {
770 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
772 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
773 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
774 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
780 macro_rules! get_feerate {
781 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
783 let mut per_peer_state_lock;
784 let mut peer_state_lock;
785 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
786 chan.get_feerate_sat_per_1000_weight()
792 macro_rules! get_opt_anchors {
793 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
795 let mut per_peer_state_lock;
796 let mut peer_state_lock;
797 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
803 /// Returns a channel monitor given a channel id, making some naive assumptions
805 macro_rules! get_monitor {
806 ($node: expr, $channel_id: expr) => {
808 use bitcoin::hashes::Hash;
809 let mut monitor = None;
810 // Assume funding vout is either 0 or 1 blindly
812 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
813 $crate::chain::transaction::OutPoint {
814 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
826 /// Returns any local commitment transactions for the channel.
828 macro_rules! get_local_commitment_txn {
829 ($node: expr, $channel_id: expr) => {
831 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
836 /// Check the error from attempting a payment.
838 macro_rules! unwrap_send_err {
839 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
841 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
842 assert_eq!(fails.len(), 1);
848 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
849 assert_eq!(results.len(), 1);
851 Err($type) => { $check },
860 /// Check whether N channel monitor(s) have been added.
861 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
862 if let Some(chain_monitor) = node.chain_monitor() {
863 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
864 assert_eq!(added_monitors.len(), count);
865 added_monitors.clear();
869 /// Check whether N channel monitor(s) have been added.
871 /// Don't use this, use the identically-named function instead.
873 macro_rules! check_added_monitors {
874 ($node: expr, $count: expr) => {
875 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
879 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> {
880 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
881 for encoded in monitors_encoded {
882 let mut monitor_read = &encoded[..];
883 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
884 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
885 assert!(monitor_read.is_empty());
886 monitors_read.push(monitor);
889 let mut node_read = &chanman_encoded[..];
890 let (_, node_deserialized) = {
891 let mut channel_monitors = HashMap::new();
892 for monitor in monitors_read.iter_mut() {
893 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
895 <(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 {
897 entropy_source: node.keys_manager,
898 node_signer: node.keys_manager,
899 signer_provider: node.keys_manager,
900 fee_estimator: node.fee_estimator,
902 chain_monitor: node.chain_monitor,
903 tx_broadcaster: node.tx_broadcaster,
908 assert!(node_read.is_empty());
910 for monitor in monitors_read.drain(..) {
911 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
912 ChannelMonitorUpdateStatus::Completed);
913 check_added_monitors!(node, 1);
920 macro_rules! reload_node {
921 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
922 let chanman_encoded = $chanman_encoded;
924 $persister = test_utils::TestPersister::new();
925 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
926 $node.chain_monitor = &$new_chain_monitor;
928 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
929 $node.node = &$new_channelmanager;
931 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
932 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
936 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) {
937 let chan_id = *node.network_chan_count.borrow();
939 let events = node.node.get_and_clear_pending_events();
940 assert_eq!(events.len(), 1);
942 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
943 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
944 assert_eq!(*channel_value_satoshis, expected_chan_value);
945 assert_eq!(user_channel_id, expected_user_chan_id);
947 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
948 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
950 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
951 (*temporary_channel_id, tx, funding_outpoint)
953 _ => panic!("Unexpected event"),
956 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 {
957 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
958 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
960 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
961 check_added_monitors!(node_a, 0);
963 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
964 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
965 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
967 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
968 assert_eq!(added_monitors.len(), 1);
969 assert_eq!(added_monitors[0].0, funding_output);
970 added_monitors.clear();
972 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
974 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()));
976 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
977 assert_eq!(added_monitors.len(), 1);
978 assert_eq!(added_monitors[0].0, funding_output);
979 added_monitors.clear();
981 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
983 let events_4 = node_a.node.get_and_clear_pending_events();
984 assert_eq!(events_4.len(), 0);
986 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
987 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
988 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
990 // Ensure that funding_transaction_generated is idempotent.
991 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
992 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
993 check_added_monitors!(node_a, 0);
998 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
999 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]) {
1000 let initiator_channels = initiator.node.list_usable_channels().len();
1001 let receiver_channels = receiver.node.list_usable_channels().len();
1003 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
1004 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
1006 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
1007 let events = receiver.node.get_and_clear_pending_events();
1008 assert_eq!(events.len(), 1);
1010 Event::OpenChannelRequest { temporary_channel_id, .. } => {
1011 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
1013 _ => panic!("Unexpected event"),
1016 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
1017 assert_eq!(accept_channel.minimum_depth, 0);
1018 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
1020 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
1021 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
1022 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
1024 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
1025 check_added_monitors!(receiver, 1);
1026 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
1027 assert_eq!(bs_signed_locked.len(), 2);
1028 let as_channel_ready;
1029 match &bs_signed_locked[0] {
1030 MessageSendEvent::SendFundingSigned { node_id, msg } => {
1031 assert_eq!(*node_id, initiator.node.get_our_node_id());
1032 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
1033 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
1034 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
1035 check_added_monitors!(initiator, 1);
1037 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1038 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
1040 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
1042 _ => panic!("Unexpected event"),
1044 match &bs_signed_locked[1] {
1045 MessageSendEvent::SendChannelReady { node_id, msg } => {
1046 assert_eq!(*node_id, initiator.node.get_our_node_id());
1047 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
1048 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
1050 _ => panic!("Unexpected event"),
1053 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
1054 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
1056 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
1057 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1059 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1060 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1062 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1063 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1065 (tx, as_channel_ready.channel_id)
1068 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 {
1069 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1070 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1071 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1072 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1073 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1074 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1075 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1076 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1077 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1079 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1082 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) {
1083 confirm_transaction_at(node_conf, tx, conf_height);
1084 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1085 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()));
1088 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]) {
1090 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1091 assert_eq!(events_6.len(), 3);
1092 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1093 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1095 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1096 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1098 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1099 ((match events_6[0] {
1100 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1101 channel_id = msg.channel_id.clone();
1102 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1105 _ => panic!("Unexpected event"),
1106 }, match events_6[announcement_sigs_idx] {
1107 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1108 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1111 _ => panic!("Unexpected event"),
1115 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]) {
1116 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1117 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1118 confirm_transaction_at(node_a, tx, conf_height);
1119 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1120 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1121 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1124 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) {
1125 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1126 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1130 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) {
1131 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1132 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1133 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1135 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1136 assert_eq!(events_7.len(), 1);
1137 let (announcement, bs_update) = match events_7[0] {
1138 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1139 (msg, update_msg.clone().unwrap())
1141 _ => panic!("Unexpected event"),
1144 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1145 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1146 assert_eq!(events_8.len(), 1);
1147 let as_update = match events_8[0] {
1148 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1149 assert!(*announcement == *msg);
1150 let update_msg = update_msg.clone().unwrap();
1151 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1152 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1155 _ => panic!("Unexpected event"),
1158 *node_a.network_chan_count.borrow_mut() += 1;
1160 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1161 ((*announcement).clone(), as_update, bs_update)
1164 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) {
1165 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1168 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) {
1169 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1170 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1171 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1174 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) {
1175 let mut no_announce_cfg = test_default_channel_config();
1176 no_announce_cfg.channel_handshake_config.announced_channel = false;
1177 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1178 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1179 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1180 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1181 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1183 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1184 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1185 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()));
1186 check_added_monitors!(nodes[b], 1);
1188 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1189 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1191 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1192 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1193 check_added_monitors!(nodes[a], 1);
1195 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1196 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1197 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1199 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1200 confirm_transaction_at(&nodes[a], &tx, conf_height);
1201 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1202 confirm_transaction_at(&nodes[b], &tx, conf_height);
1203 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1204 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1205 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()));
1206 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1207 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1208 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1209 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1210 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1212 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1213 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1215 let mut found_a = false;
1216 for chan in nodes[a].node.list_usable_channels() {
1217 if chan.channel_id == as_channel_ready.channel_id {
1220 assert!(!chan.is_public);
1225 let mut found_b = false;
1226 for chan in nodes[b].node.list_usable_channels() {
1227 if chan.channel_id == as_channel_ready.channel_id {
1230 assert!(!chan.is_public);
1235 (as_channel_ready, tx)
1238 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) {
1240 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1241 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1242 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1244 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1245 // forwarding info for local channels even if its not accepted in the network graph.
1246 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1247 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1251 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1252 for outp in tx.output.iter() {
1253 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1255 let mut total_value_in = 0;
1256 for input in tx.input.iter() {
1257 total_value_in += get_output(&input.previous_output).unwrap().value;
1259 let mut total_value_out = 0;
1260 for output in tx.output.iter() {
1261 total_value_out += output.value;
1263 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1264 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1265 assert!(total_value_out + min_fee <= total_value_in);
1266 tx.verify(get_output).unwrap();
1270 macro_rules! check_spends {
1271 ($tx: expr, $($spends_txn: expr),*) => {
1274 for outp in $spends_txn.output.iter() {
1275 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1278 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1280 if out_point.txid == $spends_txn.txid() {
1281 return $spends_txn.output.get(out_point.vout as usize).cloned()
1286 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1291 macro_rules! get_closing_signed_broadcast {
1292 ($node: expr, $dest_pubkey: expr) => {
1294 let events = $node.get_and_clear_pending_msg_events();
1295 assert!(events.len() == 1 || events.len() == 2);
1296 (match events[events.len() - 1] {
1297 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1298 assert_eq!(msg.contents.flags & 2, 2);
1301 _ => panic!("Unexpected event"),
1302 }, if events.len() == 2 {
1304 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1305 assert_eq!(*node_id, $dest_pubkey);
1308 _ => panic!("Unexpected event"),
1316 macro_rules! check_warn_msg {
1317 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1318 let msg_events = $node.node.get_and_clear_pending_msg_events();
1319 assert_eq!(msg_events.len(), 1);
1320 match msg_events[0] {
1321 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1322 assert_eq!(node_id, $recipient_node_id);
1323 assert_eq!(msg.channel_id, $chan_id);
1326 _ => panic!("Unexpected event"),
1331 /// Check that a channel's closing channel update has been broadcasted, and optionally
1332 /// check whether an error message event has occurred.
1333 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1334 let msg_events = node.node.get_and_clear_pending_msg_events();
1335 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1336 msg_events.into_iter().filter_map(|msg_event| {
1338 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1339 assert_eq!(msg.contents.flags & 2, 2);
1342 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1343 assert!(with_error_msg);
1344 // TODO: Check node_id
1347 _ => panic!("Unexpected event"),
1352 /// Check that a channel's closing channel update has been broadcasted, and optionally
1353 /// check whether an error message event has occurred.
1355 /// Don't use this, use the identically-named function instead.
1357 macro_rules! check_closed_broadcast {
1358 ($node: expr, $with_error_msg: expr) => {
1359 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1363 /// Check that a channel's closing channel events has been issued
1364 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1365 let events = node.node.get_and_clear_pending_events();
1366 assert_eq!(events.len(), events_count, "{:?}", events);
1367 let mut issues_discard_funding = false;
1368 for event in events {
1370 Event::ChannelClosed { ref reason, .. } => {
1371 assert_eq!(*reason, expected_reason);
1373 Event::DiscardFunding { .. } => {
1374 issues_discard_funding = true;
1376 _ => panic!("Unexpected event"),
1379 assert_eq!(is_check_discard_funding, issues_discard_funding);
1382 /// Check that a channel's closing channel events has been issued
1384 /// Don't use this, use the identically-named function instead.
1386 macro_rules! check_closed_event {
1387 ($node: expr, $events: expr, $reason: expr) => {
1388 check_closed_event!($node, $events, $reason, false);
1390 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1391 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1395 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) {
1396 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) };
1397 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) };
1400 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1401 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1403 let events_1 = node_b.get_and_clear_pending_msg_events();
1404 assert!(events_1.len() >= 1);
1405 let shutdown_b = match events_1[0] {
1406 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1407 assert_eq!(node_id, &node_a.get_our_node_id());
1410 _ => panic!("Unexpected event"),
1413 let closing_signed_b = if !close_inbound_first {
1414 assert_eq!(events_1.len(), 1);
1417 Some(match events_1[1] {
1418 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1419 assert_eq!(node_id, &node_a.get_our_node_id());
1422 _ => panic!("Unexpected event"),
1426 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1427 let (as_update, bs_update) = if close_inbound_first {
1428 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1429 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1431 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1432 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1433 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1434 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1436 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1437 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1438 assert!(none_a.is_none());
1439 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1440 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1441 (as_update, bs_update)
1443 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1445 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1446 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1448 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1449 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1450 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1452 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1453 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1454 assert!(none_b.is_none());
1455 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1456 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1457 (as_update, bs_update)
1459 assert_eq!(tx_a, tx_b);
1460 check_spends!(tx_a, funding_tx);
1462 (as_update, bs_update, tx_a)
1465 pub struct SendEvent {
1466 pub node_id: PublicKey,
1467 pub msgs: Vec<msgs::UpdateAddHTLC>,
1468 pub commitment_msg: msgs::CommitmentSigned,
1471 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1472 assert!(updates.update_fulfill_htlcs.is_empty());
1473 assert!(updates.update_fail_htlcs.is_empty());
1474 assert!(updates.update_fail_malformed_htlcs.is_empty());
1475 assert!(updates.update_fee.is_none());
1476 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1479 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1481 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1482 _ => panic!("Unexpected event type!"),
1486 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1487 let mut events = node.node.get_and_clear_pending_msg_events();
1488 assert_eq!(events.len(), 1);
1489 SendEvent::from_event(events.pop().unwrap())
1494 /// Don't use this, use the identically-named function instead.
1495 macro_rules! expect_pending_htlcs_forwardable_conditions {
1496 ($node: expr, $expected_failures: expr) => {
1497 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1502 macro_rules! expect_htlc_handling_failed_destinations {
1503 ($events: expr, $expected_failures: expr) => {{
1504 for event in $events {
1506 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1507 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1508 assert!($expected_failures.contains(&failed_next_destination))
1510 _ => panic!("Unexpected destination"),
1516 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1517 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1518 /// `expected_failures` set.
1519 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1521 Event::PendingHTLCsForwardable { .. } => { },
1522 _ => panic!("Unexpected event {:?}", events),
1525 let count = expected_failures.len() + 1;
1526 assert_eq!(events.len(), count);
1528 if expected_failures.len() > 0 {
1529 expect_htlc_handling_failed_destinations!(events, expected_failures)
1534 /// Clears (and ignores) a PendingHTLCsForwardable event
1536 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1538 macro_rules! expect_pending_htlcs_forwardable_ignore {
1540 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1545 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1547 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1548 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1549 ($node: expr, $expected_failures: expr) => {
1550 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1555 /// Handles a PendingHTLCsForwardable event
1556 macro_rules! expect_pending_htlcs_forwardable {
1558 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1559 $node.node.process_pending_htlc_forwards();
1561 // Ensure process_pending_htlc_forwards is idempotent.
1562 $node.node.process_pending_htlc_forwards();
1567 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1568 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1569 ($node: expr, $expected_failures: expr) => {{
1570 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1571 $node.node.process_pending_htlc_forwards();
1573 // Ensure process_pending_htlc_forwards is idempotent.
1574 $node.node.process_pending_htlc_forwards();
1579 macro_rules! expect_pending_htlcs_forwardable_from_events {
1580 ($node: expr, $events: expr, $ignore: expr) => {{
1581 assert_eq!($events.len(), 1);
1583 Event::PendingHTLCsForwardable { .. } => { },
1584 _ => panic!("Unexpected event"),
1587 $node.node.process_pending_htlc_forwards();
1589 // Ensure process_pending_htlc_forwards is idempotent.
1590 $node.node.process_pending_htlc_forwards();
1596 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1597 /// commitment update.
1598 macro_rules! commitment_signed_dance {
1599 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1600 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1602 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1603 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1605 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1607 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1608 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1609 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1610 check_added_monitors(&$node_a, 1);
1611 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1612 assert!(extra_msg_option.is_none());
1616 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1617 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1619 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1620 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1624 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1625 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1626 /// `revoke_and_ack` response to it.
1628 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1629 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1630 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1631 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1632 check_added_monitors(node_a, 1);
1636 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1637 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1638 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1640 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1641 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1642 check_added_monitors!(node_b, 0);
1643 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1644 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1645 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1646 check_added_monitors!(node_b, 1);
1647 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1648 let (bs_revoke_and_ack, extra_msg_option) = {
1649 let mut events = node_b.node.get_and_clear_pending_msg_events();
1650 assert!(events.len() <= 2);
1651 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1652 (match node_a_event {
1653 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1654 assert_eq!(*node_id, node_a.node.get_our_node_id());
1657 _ => panic!("Unexpected event"),
1658 }, events.get(0).map(|e| e.clone()))
1660 check_added_monitors!(node_b, 1);
1662 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1663 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1665 (extra_msg_option, bs_revoke_and_ack)
1668 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1669 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1671 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1672 /// on failure or that no new messages are left over on success.
1673 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1674 check_added_monitors!(node_a, 0);
1675 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1676 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1677 check_added_monitors!(node_a, 1);
1679 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1681 if skip_last_step { return; }
1684 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1685 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1686 check_added_monitors!(node_a, 1);
1688 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1689 let mut number_of_msg_events = 0;
1690 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1691 let peer_state = peer_state_mutex.lock().unwrap();
1692 let cp_pending_msg_events = &peer_state.pending_msg_events;
1693 number_of_msg_events += cp_pending_msg_events.len();
1694 if cp_pending_msg_events.len() == 1 {
1695 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1696 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1697 } else { panic!("Unexpected event"); }
1700 // Expecting the failure backwards event to the previous hop (not `node_b`)
1701 assert_eq!(number_of_msg_events, 1);
1703 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1707 /// Get a payment preimage and hash.
1708 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1709 let mut payment_count = recipient.network_payment_count.borrow_mut();
1710 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1711 *payment_count += 1;
1712 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1713 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1714 (payment_preimage, payment_hash, payment_secret)
1717 /// Get a payment preimage and hash.
1719 /// Don't use this, use the identically-named function instead.
1721 macro_rules! get_payment_preimage_hash {
1722 ($dest_node: expr) => {
1723 get_payment_preimage_hash!($dest_node, None)
1725 ($dest_node: expr, $min_value_msat: expr) => {
1726 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1728 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1729 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1733 /// Gets a route from the given sender to the node described in `payment_params`.
1734 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64) -> Result<Route, msgs::LightningError> {
1735 let scorer = TestScorer::new();
1736 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1737 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1739 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1740 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1741 recv_value, send_node.logger, &scorer, &random_seed_bytes
1745 /// Gets a route from the given sender to the node described in `payment_params`.
1747 /// Don't use this, use the identically-named function instead.
1749 macro_rules! get_route {
1750 ($send_node: expr, $payment_params: expr, $recv_value: expr) => {
1751 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value)
1757 macro_rules! get_route_and_payment_hash {
1758 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1759 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1760 .with_features($recv_node.node.invoice_features());
1761 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value)
1763 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr) => {{
1764 let (payment_preimage, payment_hash, payment_secret) =
1765 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1766 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value);
1767 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1772 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1773 macro_rules! expect_payment_claimable {
1774 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1775 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1777 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1778 let events = $node.node.get_and_clear_pending_events();
1779 assert_eq!(events.len(), 1);
1781 $crate::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1782 assert_eq!($expected_payment_hash, *payment_hash);
1783 assert_eq!($expected_recv_value, amount_msat);
1784 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1786 $crate::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1787 assert_eq!(&$expected_payment_preimage, payment_preimage);
1788 assert_eq!($expected_payment_secret, *payment_secret);
1793 _ => panic!("Unexpected event"),
1799 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1800 macro_rules! expect_payment_claimed {
1801 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1802 let events = $node.node.get_and_clear_pending_events();
1803 assert_eq!(events.len(), 1);
1805 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1806 assert_eq!($expected_payment_hash, *payment_hash);
1807 assert_eq!($expected_recv_value, amount_msat);
1809 _ => panic!("Unexpected event"),
1814 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1815 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1816 expect_per_path_claims: bool,
1818 let events = node.node().get_and_clear_pending_events();
1819 let expected_payment_hash = PaymentHash(
1820 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1821 if expect_per_path_claims {
1822 assert!(events.len() > 1);
1824 assert_eq!(events.len(), 1);
1826 let expected_payment_id = match events[0] {
1827 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1828 assert_eq!(expected_payment_preimage, *payment_preimage);
1829 assert_eq!(expected_payment_hash, *payment_hash);
1830 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1831 assert_eq!(*fee_paid_msat, expected_fee_msat);
1833 assert!(fee_paid_msat.is_some());
1837 _ => panic!("Unexpected event"),
1839 if expect_per_path_claims {
1840 for i in 1..events.len() {
1842 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1843 assert_eq!(payment_id, expected_payment_id);
1844 assert_eq!(payment_hash, Some(expected_payment_hash));
1846 _ => panic!("Unexpected event"),
1854 macro_rules! expect_payment_sent_without_paths {
1855 ($node: expr, $expected_payment_preimage: expr) => {
1856 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1858 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1859 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1864 macro_rules! expect_payment_sent {
1865 ($node: expr, $expected_payment_preimage: expr) => {
1866 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1868 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1869 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1871 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1872 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1873 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1879 macro_rules! expect_payment_path_successful {
1881 let events = $node.node.get_and_clear_pending_events();
1882 assert_eq!(events.len(), 1);
1884 $crate::events::Event::PaymentPathSuccessful { .. } => {},
1885 _ => panic!("Unexpected event"),
1890 macro_rules! expect_payment_forwarded {
1891 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1892 let events = $node.node.get_and_clear_pending_events();
1893 assert_eq!(events.len(), 1);
1895 Event::PaymentForwarded {
1896 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1897 outbound_amount_forwarded_msat: _
1899 assert_eq!(fee_earned_msat, $expected_fee);
1900 if fee_earned_msat.is_some() {
1901 // Is the event prev_channel_id in one of the channels between the two nodes?
1902 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()));
1904 // We check for force closures since a force closed channel is removed from the
1905 // node's channel list
1906 if !$downstream_force_closed {
1907 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()));
1909 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1911 _ => panic!("Unexpected event"),
1916 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1917 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1918 let events = node.node.get_and_clear_pending_events();
1919 assert_eq!(events.len(), 1);
1921 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1922 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1924 _ => panic!("Unexpected event"),
1928 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1929 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1930 let events = node.node.get_and_clear_pending_events();
1931 assert_eq!(events.len(), 1);
1933 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1934 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1936 _ => panic!("Unexpected event"),
1940 pub struct PaymentFailedConditions<'a> {
1941 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1942 pub(crate) expected_blamed_scid: Option<u64>,
1943 pub(crate) expected_blamed_chan_closed: Option<bool>,
1944 pub(crate) expected_mpp_parts_remain: bool,
1947 impl<'a> PaymentFailedConditions<'a> {
1948 pub fn new() -> Self {
1950 expected_htlc_error_data: None,
1951 expected_blamed_scid: None,
1952 expected_blamed_chan_closed: None,
1953 expected_mpp_parts_remain: false,
1956 pub fn mpp_parts_remain(mut self) -> Self {
1957 self.expected_mpp_parts_remain = true;
1960 pub fn blamed_scid(mut self, scid: u64) -> Self {
1961 self.expected_blamed_scid = Some(scid);
1964 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1965 self.expected_blamed_chan_closed = Some(closed);
1968 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1969 self.expected_htlc_error_data = Some((code, data));
1975 macro_rules! expect_payment_failed_with_update {
1976 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1977 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1978 &$node, $expected_payment_hash, $payment_failed_permanently,
1979 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1980 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1985 macro_rules! expect_payment_failed {
1986 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1987 #[allow(unused_mut)]
1988 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1990 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1992 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1996 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1997 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1998 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
2000 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
2001 let expected_payment_id = match &payment_failed_events[0] {
2002 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
2006 error_data, .. } => {
2007 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
2008 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
2011 assert!(error_code.is_some(), "expected error_code.is_some() = true");
2012 assert!(error_data.is_some(), "expected error_data.is_some() = true");
2013 if let Some((code, data)) = conditions.expected_htlc_error_data {
2014 assert_eq!(error_code.unwrap(), code, "unexpected error code");
2015 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
2019 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
2020 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
2022 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
2023 if let Some(scid) = conditions.expected_blamed_scid {
2024 assert_eq!(msg.contents.short_channel_id, scid);
2026 const CHAN_DISABLED_FLAG: u8 = 2;
2027 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
2029 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
2030 if let Some(scid) = conditions.expected_blamed_scid {
2031 assert_eq!(*short_channel_id, scid);
2033 assert!(is_permanent);
2035 _ => panic!("Unexpected update type"),
2037 } else { panic!("Expected network update"); }
2042 _ => panic!("Unexpected event"),
2044 if !conditions.expected_mpp_parts_remain {
2045 match &payment_failed_events[1] {
2046 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2047 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
2048 assert_eq!(*payment_id, expected_payment_id);
2049 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
2050 PaymentFailureReason::RecipientRejected
2052 PaymentFailureReason::RetriesExhausted
2055 _ => panic!("Unexpected second event"),
2060 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2061 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2062 conditions: PaymentFailedConditions<'e>
2064 let events = node.node.get_and_clear_pending_events();
2065 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2068 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 {
2069 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2070 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2071 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2072 check_added_monitors!(origin_node, expected_paths.len());
2073 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2077 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> {
2078 let mut payment_event = SendEvent::from_event(ev);
2079 let mut prev_node = origin_node;
2080 let mut event = None;
2082 for (idx, &node) in expected_path.iter().enumerate() {
2083 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2085 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2086 check_added_monitors!(node, 0);
2087 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2089 expect_pending_htlcs_forwardable!(node);
2091 if idx == expected_path.len() - 1 && clear_recipient_events {
2092 let events_2 = node.node.get_and_clear_pending_events();
2093 if payment_claimable_expected {
2094 assert_eq!(events_2.len(), 1);
2095 match &events_2[0] {
2096 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat,
2097 receiver_node_id, ref via_channel_id, ref via_user_channel_id,
2098 claim_deadline, onion_fields,
2100 assert_eq!(our_payment_hash, *payment_hash);
2101 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2102 assert!(onion_fields.is_some());
2104 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2105 assert_eq!(expected_preimage, *payment_preimage);
2106 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2107 assert_eq!(Some(*payment_secret), onion_fields.as_ref().unwrap().payment_secret);
2109 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2110 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2111 assert!(our_payment_secret.is_none());
2114 assert_eq!(*amount_msat, recv_value);
2115 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2116 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2117 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2119 _ => panic!("Unexpected event"),
2121 event = Some(events_2[0].clone());
2123 assert!(events_2.is_empty());
2125 } else if idx != expected_path.len() - 1 {
2126 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2127 assert_eq!(events_2.len(), 1);
2128 check_added_monitors!(node, 1);
2129 payment_event = SendEvent::from_event(events_2.remove(0));
2130 assert_eq!(payment_event.msgs.len(), 1);
2138 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> {
2139 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2142 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) {
2143 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2144 assert_eq!(events.len(), expected_route.len());
2145 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2146 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2147 // Once we've gotten through all the HTLCs, the last one should result in a
2148 // PaymentClaimable (but each previous one should not!), .
2149 let expect_payment = path_idx == expected_route.len() - 1;
2150 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2154 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) {
2155 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2156 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2157 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2160 pub fn do_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) -> u64 {
2161 for path in expected_paths.iter() {
2162 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2164 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2166 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2167 assert_eq!(claim_event.len(), 1);
2168 match claim_event[0] {
2169 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2170 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2171 assert_eq!(preimage, our_payment_preimage),
2172 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2173 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2177 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2179 let mut expected_total_fee_msat = 0;
2181 macro_rules! msgs_from_ev {
2184 &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 } } => {
2185 assert!(update_add_htlcs.is_empty());
2186 assert_eq!(update_fulfill_htlcs.len(), 1);
2187 assert!(update_fail_htlcs.is_empty());
2188 assert!(update_fail_malformed_htlcs.is_empty());
2189 assert!(update_fee.is_none());
2190 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2192 _ => panic!("Unexpected event"),
2196 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2197 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2198 assert_eq!(events.len(), expected_paths.len());
2200 if events.len() == 1 {
2201 per_path_msgs.push(msgs_from_ev!(&events[0]));
2203 for expected_path in expected_paths.iter() {
2204 // For MPP payments, we always want the message to the first node in the path.
2205 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2206 per_path_msgs.push(msgs_from_ev!(&ev));
2210 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2211 let mut next_msgs = Some(path_msgs);
2212 let mut expected_next_node = next_hop;
2214 macro_rules! last_update_fulfill_dance {
2215 ($node: expr, $prev_node: expr) => {
2217 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2218 check_added_monitors!($node, 0);
2219 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2220 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2224 macro_rules! mid_update_fulfill_dance {
2225 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2227 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2229 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2230 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2231 .unwrap().lock().unwrap();
2232 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2233 if let Some(prev_config) = channel.prev_config() {
2234 prev_config.forwarding_fee_base_msat
2236 channel.config().forwarding_fee_base_msat
2239 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2240 expected_total_fee_msat += fee as u64;
2241 check_added_monitors!($node, 1);
2242 let new_next_msgs = if $new_msgs {
2243 let events = $node.node.get_and_clear_pending_msg_events();
2244 assert_eq!(events.len(), 1);
2245 let (res, nexthop) = msgs_from_ev!(&events[0]);
2246 expected_next_node = nexthop;
2249 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2252 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2253 next_msgs = new_next_msgs;
2258 let mut prev_node = expected_route.last().unwrap();
2259 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2260 assert_eq!(expected_next_node, node.node.get_our_node_id());
2261 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2262 if next_msgs.is_some() {
2263 // Since we are traversing in reverse, next_node is actually the previous node
2264 let next_node: &Node;
2265 if idx == expected_route.len() - 1 {
2266 next_node = origin_node;
2268 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2270 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2272 assert!(!update_next_msgs);
2273 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2275 if !skip_last && idx == expected_route.len() - 1 {
2276 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2283 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2287 // Ensure that claim_funds is idempotent.
2288 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2289 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2290 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2292 expected_total_fee_msat
2294 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) {
2295 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2297 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2301 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2302 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2305 pub const TEST_FINAL_CLTV: u32 = 70;
2307 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) {
2308 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2309 .with_features(expected_route.last().unwrap().node.invoice_features());
2310 let route = get_route(origin_node, &payment_params, recv_value).unwrap();
2311 assert_eq!(route.paths.len(), 1);
2312 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2313 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2314 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2317 let res = send_along_route(origin_node, route, expected_route, recv_value);
2318 (res.0, res.1, res.2)
2321 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2322 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2323 .with_features(expected_route.last().unwrap().node.invoice_features());
2324 let network_graph = origin_node.network_graph.read_only();
2325 let scorer = test_utils::TestScorer::new();
2326 let seed = [0u8; 32];
2327 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2328 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2329 let route = router::get_route(
2330 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2331 None, recv_value, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2332 assert_eq!(route.paths.len(), 1);
2333 assert_eq!(route.paths[0].hops.len(), expected_route.len());
2334 for (node, hop) in expected_route.iter().zip(route.paths[0].hops.iter()) {
2335 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2338 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2339 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2340 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2341 true, APIError::ChannelUnavailable { ref err },
2342 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2345 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2346 let res = route_payment(&origin, expected_route, recv_value);
2347 claim_payment(&origin, expected_route, res.0);
2351 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) {
2352 for path in expected_paths.iter() {
2353 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2355 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2356 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2357 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2359 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2362 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) {
2363 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2364 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2366 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2367 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2368 assert_eq!(events.len(), expected_paths.len());
2369 for ev in events.iter() {
2370 let (update_fail, commitment_signed, node_id) = match ev {
2371 &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 } } => {
2372 assert!(update_add_htlcs.is_empty());
2373 assert!(update_fulfill_htlcs.is_empty());
2374 assert_eq!(update_fail_htlcs.len(), 1);
2375 assert!(update_fail_malformed_htlcs.is_empty());
2376 assert!(update_fee.is_none());
2377 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2379 _ => panic!("Unexpected event"),
2381 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2383 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2384 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()));
2386 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2387 let mut next_msgs = Some(path_msgs);
2388 let mut expected_next_node = next_hop;
2389 let mut prev_node = expected_route.last().unwrap();
2391 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2392 assert_eq!(expected_next_node, node.node.get_our_node_id());
2393 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2394 if next_msgs.is_some() {
2395 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2396 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2397 if !update_next_node {
2398 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 }]);
2401 let events = node.node.get_and_clear_pending_msg_events();
2402 if update_next_node {
2403 assert_eq!(events.len(), 1);
2405 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 } } => {
2406 assert!(update_add_htlcs.is_empty());
2407 assert!(update_fulfill_htlcs.is_empty());
2408 assert_eq!(update_fail_htlcs.len(), 1);
2409 assert!(update_fail_malformed_htlcs.is_empty());
2410 assert!(update_fee.is_none());
2411 expected_next_node = node_id.clone();
2412 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2414 _ => panic!("Unexpected event"),
2417 assert!(events.is_empty());
2419 if !skip_last && idx == expected_route.len() - 1 {
2420 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2427 let prev_node = expected_route.first().unwrap();
2428 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2429 check_added_monitors!(origin_node, 0);
2430 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2431 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2432 let events = origin_node.node.get_and_clear_pending_events();
2433 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2435 let expected_payment_id = match events[0] {
2436 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2437 assert_eq!(payment_hash, our_payment_hash);
2438 assert!(payment_failed_permanently);
2439 for (idx, hop) in expected_route.iter().enumerate() {
2440 assert_eq!(hop.node.get_our_node_id(), path.hops[idx].pubkey);
2444 _ => panic!("Unexpected event"),
2446 if i == expected_paths.len() - 1 {
2448 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2449 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2450 assert_eq!(*payment_id, expected_payment_id);
2451 assert_eq!(reason.unwrap(), expected_fail_reason);
2453 _ => panic!("Unexpected second event"),
2459 // Ensure that fail_htlc_backwards is idempotent.
2460 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2461 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2462 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2463 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2466 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2467 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2470 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2471 let mut chan_mon_cfgs = Vec::new();
2472 for i in 0..node_count {
2473 let tx_broadcaster = test_utils::TestBroadcaster::new(Network::Testnet);
2474 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2475 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2476 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2477 let persister = test_utils::TestPersister::new();
2478 let seed = [i as u8; 32];
2479 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2480 let scorer = Mutex::new(test_utils::TestScorer::new());
2482 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2488 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2489 let mut nodes = Vec::new();
2491 for i in 0..node_count {
2492 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);
2493 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2494 let seed = [i as u8; 32];
2495 nodes.push(NodeCfg {
2496 chain_source: &chanmon_cfgs[i].chain_source,
2497 logger: &chanmon_cfgs[i].logger,
2498 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2499 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2500 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2502 keys_manager: &chanmon_cfgs[i].keys_manager,
2505 override_init_features: Rc::new(RefCell::new(None)),
2512 pub fn test_default_channel_config() -> UserConfig {
2513 let mut default_config = UserConfig::default();
2514 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2515 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2516 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2517 default_config.channel_handshake_config.announced_channel = true;
2518 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2519 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2520 // It now defaults to 1, so we simply set it to the expected value here.
2521 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2522 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2523 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2524 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2528 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>> {
2529 let mut chanmgrs = Vec::new();
2530 for i in 0..node_count {
2531 let network = Network::Testnet;
2532 let params = ChainParameters {
2534 best_block: BestBlock::from_network(network),
2536 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,
2537 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);
2538 chanmgrs.push(node);
2544 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>> {
2545 let mut nodes = Vec::new();
2546 let chan_count = Rc::new(RefCell::new(0));
2547 let payment_count = Rc::new(RefCell::new(0));
2548 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2550 for i in 0..node_count {
2551 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2553 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2554 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2555 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2556 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2557 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2558 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2559 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2560 connect_style: Rc::clone(&connect_style),
2561 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2565 for i in 0..node_count {
2566 for j in (i+1)..node_count {
2567 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: nodes[j].override_init_features.borrow().clone().unwrap_or_else(|| nodes[j].node.init_features()), remote_network_address: None }, true).unwrap();
2568 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: nodes[i].override_init_features.borrow().clone().unwrap_or_else(|| nodes[i].node.init_features()), remote_network_address: None }, false).unwrap();
2575 // Note that the following only works for CLTV values up to 128
2576 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2578 #[derive(PartialEq)]
2579 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2580 /// Tests that the given node has broadcast transactions for the given Channel
2582 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2583 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2584 /// broadcast and the revoked outputs were claimed.
2586 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2587 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2589 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2591 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> {
2592 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2593 let mut txn_seen = HashSet::new();
2594 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2595 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2597 let mut res = Vec::with_capacity(2);
2598 node_txn.retain(|tx| {
2599 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2600 check_spends!(tx, chan.3);
2601 if commitment_tx.is_none() {
2602 res.push(tx.clone());
2607 if let Some(explicit_tx) = commitment_tx {
2608 res.push(explicit_tx.clone());
2611 assert_eq!(res.len(), 1);
2613 if has_htlc_tx != HTLCType::NONE {
2614 node_txn.retain(|tx| {
2615 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2616 check_spends!(tx, res[0]);
2617 if has_htlc_tx == HTLCType::TIMEOUT {
2618 assert!(tx.lock_time.0 != 0);
2620 assert!(tx.lock_time.0 == 0);
2622 res.push(tx.clone());
2626 assert!(res.len() == 2 || res.len() == 3);
2628 assert_eq!(res[1], res[2]);
2632 assert!(node_txn.is_empty());
2636 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2637 /// HTLC transaction.
2638 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2639 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2640 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2641 // for revoked htlc outputs
2642 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2643 node_txn.retain(|tx| {
2644 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2645 check_spends!(tx, revoked_tx);
2649 node_txn.retain(|tx| {
2650 check_spends!(tx, commitment_revoked_tx);
2653 assert!(node_txn.is_empty());
2656 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2657 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2658 let mut txn_seen = HashSet::new();
2659 node_txn.retain(|tx| txn_seen.insert(tx.txid()));
2661 let mut found_prev = false;
2662 for prev_tx in prev_txn {
2663 for tx in &*node_txn {
2664 if tx.input[0].previous_output.txid == prev_tx.txid() {
2665 check_spends!(tx, prev_tx);
2666 let mut iter = tx.input[0].witness.iter();
2667 iter.next().expect("expected 3 witness items");
2668 iter.next().expect("expected 3 witness items");
2669 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2670 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2677 assert!(found_prev);
2679 let mut res = Vec::new();
2680 mem::swap(&mut *node_txn, &mut res);
2684 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) {
2685 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2686 assert_eq!(events_1.len(), 2);
2687 let as_update = match events_1[0] {
2688 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2691 _ => panic!("Unexpected event"),
2694 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2695 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2696 assert_eq!(msg.data, expected_error);
2697 if needs_err_handle {
2698 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2701 _ => panic!("Unexpected event"),
2704 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2705 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2706 let bs_update = match events_2[0] {
2707 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2710 _ => panic!("Unexpected event"),
2712 if !needs_err_handle {
2714 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2715 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2716 assert_eq!(msg.data, expected_error);
2718 _ => panic!("Unexpected event"),
2723 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2724 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2728 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2729 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2733 macro_rules! get_channel_value_stat {
2734 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2735 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2736 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2737 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2738 chan.get_value_stat()
2742 macro_rules! get_chan_reestablish_msgs {
2743 ($src_node: expr, $dst_node: expr) => {
2745 let mut announcements = $crate::prelude::HashSet::new();
2746 let mut res = Vec::with_capacity(1);
2747 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2748 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2749 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2750 res.push(msg.clone());
2751 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2752 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2753 announcements.insert(msg.contents.short_channel_id);
2755 panic!("Unexpected event")
2758 for chan in $src_node.node.list_channels() {
2759 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2760 if let Some(scid) = chan.short_channel_id {
2761 assert!(announcements.remove(&scid));
2765 assert!(announcements.is_empty());
2771 macro_rules! handle_chan_reestablish_msgs {
2772 ($src_node: expr, $dst_node: expr) => {
2774 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2776 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2778 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2784 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2786 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2789 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2790 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2791 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2793 had_channel_update = true;
2796 let mut revoke_and_ack = None;
2797 let mut commitment_update = None;
2798 let order = if let Some(ev) = msg_events.get(idx) {
2800 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2801 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2802 revoke_and_ack = Some(msg.clone());
2804 RAACommitmentOrder::RevokeAndACKFirst
2806 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2807 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2808 commitment_update = Some(updates.clone());
2810 RAACommitmentOrder::CommitmentFirst
2812 _ => RAACommitmentOrder::CommitmentFirst,
2815 RAACommitmentOrder::CommitmentFirst
2818 if let Some(ev) = msg_events.get(idx) {
2820 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2821 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2822 assert!(revoke_and_ack.is_none());
2823 revoke_and_ack = Some(msg.clone());
2826 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2827 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2828 assert!(commitment_update.is_none());
2829 commitment_update = Some(updates.clone());
2836 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2837 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2839 assert!(!had_channel_update);
2842 assert_eq!(msg_events.len(), idx);
2844 (channel_ready, revoke_and_ack, commitment_update, order)
2849 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2850 /// for claims/fails they are separated out.
2851 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)) {
2852 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: node_b.node.init_features(), remote_network_address: None }, true).unwrap();
2853 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2854 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: node_a.node.init_features(), remote_network_address: None }, false).unwrap();
2855 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2857 if send_channel_ready.0 {
2858 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2860 for reestablish in reestablish_1.iter() {
2861 assert_eq!(reestablish.next_remote_commitment_number, 0);
2864 if send_channel_ready.1 {
2865 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2867 for reestablish in reestablish_2.iter() {
2868 assert_eq!(reestablish.next_remote_commitment_number, 0);
2871 if send_channel_ready.0 || send_channel_ready.1 {
2872 // If we expect any channel_ready's, both sides better have set
2873 // next_holder_commitment_number to 1
2874 for reestablish in reestablish_1.iter() {
2875 assert_eq!(reestablish.next_local_commitment_number, 1);
2877 for reestablish in reestablish_2.iter() {
2878 assert_eq!(reestablish.next_local_commitment_number, 1);
2882 let mut resp_1 = Vec::new();
2883 for msg in reestablish_1 {
2884 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2885 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2887 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2888 check_added_monitors!(node_b, 1);
2890 check_added_monitors!(node_b, 0);
2893 let mut resp_2 = Vec::new();
2894 for msg in reestablish_2 {
2895 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2896 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2898 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2899 check_added_monitors!(node_a, 1);
2901 check_added_monitors!(node_a, 0);
2904 // We don't yet support both needing updates, as that would require a different commitment dance:
2905 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2906 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2907 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2908 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2910 for chan_msgs in resp_1.drain(..) {
2911 if send_channel_ready.0 {
2912 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2913 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2914 if !announcement_event.is_empty() {
2915 assert_eq!(announcement_event.len(), 1);
2916 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2917 //TODO: Test announcement_sigs re-sending
2918 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2921 assert!(chan_msgs.0.is_none());
2924 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2925 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2926 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2927 check_added_monitors!(node_a, 1);
2929 assert!(chan_msgs.1.is_none());
2931 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 {
2932 let commitment_update = chan_msgs.2.unwrap();
2933 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2934 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2936 assert!(commitment_update.update_add_htlcs.is_empty());
2938 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2939 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2940 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2941 for update_add in commitment_update.update_add_htlcs {
2942 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2944 for update_fulfill in commitment_update.update_fulfill_htlcs {
2945 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2947 for update_fail in commitment_update.update_fail_htlcs {
2948 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2951 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2952 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2954 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2955 check_added_monitors!(node_a, 1);
2956 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2957 // No commitment_signed so get_event_msg's assert(len == 1) passes
2958 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2959 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2960 check_added_monitors!(node_b, 1);
2963 assert!(chan_msgs.2.is_none());
2967 for chan_msgs in resp_2.drain(..) {
2968 if send_channel_ready.1 {
2969 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2970 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2971 if !announcement_event.is_empty() {
2972 assert_eq!(announcement_event.len(), 1);
2973 match announcement_event[0] {
2974 MessageSendEvent::SendChannelUpdate { .. } => {},
2975 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2976 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2980 assert!(chan_msgs.0.is_none());
2983 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2984 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2985 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2986 check_added_monitors!(node_b, 1);
2988 assert!(chan_msgs.1.is_none());
2990 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 {
2991 let commitment_update = chan_msgs.2.unwrap();
2992 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2993 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2995 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2996 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2997 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2998 for update_add in commitment_update.update_add_htlcs {
2999 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
3001 for update_fulfill in commitment_update.update_fulfill_htlcs {
3002 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
3004 for update_fail in commitment_update.update_fail_htlcs {
3005 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
3008 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
3009 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
3011 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
3012 check_added_monitors!(node_b, 1);
3013 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
3014 // No commitment_signed so get_event_msg's assert(len == 1) passes
3015 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
3016 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
3017 check_added_monitors!(node_a, 1);
3020 assert!(chan_msgs.2.is_none());