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, keysinterface::EntropySource};
14 use crate::chain::channelmonitor::ChannelMonitor;
15 use crate::chain::transaction::OutPoint;
16 use crate::events::{ClosureReason, Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PathFailure, PaymentPurpose, PaymentFailureReason};
17 use crate::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
18 use crate::ln::channelmanager::{AChannelManager, ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, RecipientOnionFields, PaymentId, MIN_CLTV_EXPIRY_DELTA};
19 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
20 use crate::routing::router::{self, PaymentParameters, Route};
21 use crate::ln::features::InitFeatures;
23 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
24 use crate::util::enforcing_trait_impls::EnforcingSigner;
25 use crate::util::scid_utils;
26 use crate::util::test_utils;
27 use crate::util::test_utils::{panicking, TestChainMonitor, TestScorer, TestKeysInterface};
28 use crate::util::errors::APIError;
29 use crate::util::config::UserConfig;
30 use crate::util::ser::{ReadableArgs, Writeable};
32 use bitcoin::blockdata::block::{Block, BlockHeader};
33 use bitcoin::blockdata::constants::genesis_block;
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 fn random_style() -> ConnectStyle {
141 #[cfg(feature = "std")] {
142 use core::hash::{BuildHasher, Hasher};
143 // Get a random value using the only std API to do so - the DefaultHasher
144 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
145 let res = match rand_val % 9 {
146 0 => ConnectStyle::BestBlockFirst,
147 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
148 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
149 3 => ConnectStyle::TransactionsFirst,
150 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
151 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
152 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
153 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
154 8 => ConnectStyle::FullBlockViaListen,
157 eprintln!("Using Block Connection Style: {:?}", res);
160 #[cfg(not(feature = "std"))] {
161 ConnectStyle::FullBlockViaListen
166 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
167 let skip_intermediaries = match *node.connect_style.borrow() {
168 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
169 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
170 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
174 let height = node.best_block_info().1 + 1;
175 let mut block = Block {
176 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
181 let prev_blockhash = block.header.block_hash();
182 do_connect_block(node, block, skip_intermediaries);
184 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
188 let hash = block.header.block_hash();
189 do_connect_block(node, block, false);
193 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
194 do_connect_block(node, block.clone(), false);
197 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
198 // Ensure `get_claimable_balances`' self-tests never panic
199 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
200 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
204 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
205 call_claimable_balances(node);
206 let height = node.best_block_info().1 + 1;
207 #[cfg(feature = "std")] {
208 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
210 if !skip_intermediaries {
211 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
212 match *node.connect_style.borrow() {
213 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
214 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
215 call_claimable_balances(node);
216 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
217 node.node.best_block_updated(&block.header, height);
218 node.node.transactions_confirmed(&block.header, &txdata, height);
220 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
221 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
222 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
223 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
224 let mut connections = Vec::new();
225 for (block, height) in node.blocks.lock().unwrap().iter() {
226 if !block.txdata.is_empty() {
227 // Reconnect all transactions we've ever seen to ensure transaction connection
228 // is *really* idempotent. This is a somewhat likely deployment for some
229 // esplora implementations of chain sync which try to reduce state and
230 // complexity as much as possible.
232 // Sadly we have to clone the block here to maintain lockorder. In the
233 // future we should consider Arc'ing the blocks to avoid this.
234 connections.push((block.clone(), *height));
237 for (old_block, height) in connections {
238 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
239 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
242 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
243 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
244 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
246 call_claimable_balances(node);
247 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
248 node.node.transactions_confirmed(&block.header, &txdata, height);
249 node.node.best_block_updated(&block.header, height);
251 ConnectStyle::FullBlockViaListen => {
252 node.chain_monitor.chain_monitor.block_connected(&block, height);
253 node.node.block_connected(&block, height);
257 call_claimable_balances(node);
258 node.node.test_process_background_events();
259 node.blocks.lock().unwrap().push((block, height));
262 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
263 call_claimable_balances(node);
264 #[cfg(feature = "std")] {
265 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
268 let orig = node.blocks.lock().unwrap().pop().unwrap();
269 assert!(orig.1 > 0); // Cannot disconnect genesis
270 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
272 match *node.connect_style.borrow() {
273 ConnectStyle::FullBlockViaListen => {
274 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
275 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
277 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
278 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
280 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
281 node.node.best_block_updated(&prev.0.header, prev.1);
284 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
285 for tx in orig.0.txdata {
286 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
287 node.node.transaction_unconfirmed(&tx.txid());
291 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
292 node.node.best_block_updated(&prev.0.header, prev.1);
295 call_claimable_balances(node);
299 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
300 let count = node.blocks.lock().unwrap().len() as u32 - 1;
301 disconnect_blocks(node, count);
304 pub struct TestChanMonCfg {
305 pub tx_broadcaster: test_utils::TestBroadcaster,
306 pub fee_estimator: test_utils::TestFeeEstimator,
307 pub chain_source: test_utils::TestChainSource,
308 pub persister: test_utils::TestPersister,
309 pub logger: test_utils::TestLogger,
310 pub keys_manager: test_utils::TestKeysInterface,
311 pub scorer: Mutex<test_utils::TestScorer>,
314 pub struct NodeCfg<'a> {
315 pub chain_source: &'a test_utils::TestChainSource,
316 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
317 pub fee_estimator: &'a test_utils::TestFeeEstimator,
318 pub router: test_utils::TestRouter<'a>,
319 pub chain_monitor: test_utils::TestChainMonitor<'a>,
320 pub keys_manager: &'a test_utils::TestKeysInterface,
321 pub logger: &'a test_utils::TestLogger,
322 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
323 pub node_seed: [u8; 32],
324 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
327 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>;
329 pub struct Node<'a, 'b: 'a, 'c: 'b> {
330 pub chain_source: &'c test_utils::TestChainSource,
331 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
332 pub fee_estimator: &'c test_utils::TestFeeEstimator,
333 pub router: &'b test_utils::TestRouter<'c>,
334 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
335 pub keys_manager: &'b test_utils::TestKeysInterface,
336 pub node: &'a TestChannelManager<'a, 'b, 'c>,
337 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
338 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
339 pub node_seed: [u8; 32],
340 pub network_payment_count: Rc<RefCell<u8>>,
341 pub network_chan_count: Rc<RefCell<u32>>,
342 pub logger: &'c test_utils::TestLogger,
343 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
344 pub connect_style: Rc<RefCell<ConnectStyle>>,
345 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
347 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
348 pub fn best_block_hash(&self) -> BlockHash {
349 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
351 pub fn best_block_info(&self) -> (BlockHash, u32) {
352 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
354 pub fn get_block_header(&self, height: u32) -> BlockHeader {
355 self.blocks.lock().unwrap()[height as usize].0.header
359 /// If we need an unsafe pointer to a `Node` (ie to reference it in a thread
360 /// pre-std::thread::scope), this provides that with `Sync`. Note that accessing some of the fields
361 /// in the `Node` are not safe to use (i.e. the ones behind an `Rc`), but that's left to the caller
363 pub struct NodePtr(pub *const Node<'static, 'static, 'static>);
365 pub fn from_node<'a, 'b: 'a, 'c: 'b>(node: &Node<'a, 'b, 'c>) -> Self {
366 Self((node as *const Node<'a, 'b, 'c>).cast())
369 unsafe impl Send for NodePtr {}
370 unsafe impl Sync for NodePtr {}
373 pub trait NodeHolder {
374 type CM: AChannelManager;
375 fn node(&self) -> &ChannelManager<
376 <Self::CM as AChannelManager>::M,
377 <Self::CM as AChannelManager>::T,
378 <Self::CM as AChannelManager>::ES,
379 <Self::CM as AChannelManager>::NS,
380 <Self::CM as AChannelManager>::SP,
381 <Self::CM as AChannelManager>::F,
382 <Self::CM as AChannelManager>::R,
383 <Self::CM as AChannelManager>::L>;
384 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor>;
386 impl<H: NodeHolder> NodeHolder for &H {
388 fn node(&self) -> &ChannelManager<
389 <Self::CM as AChannelManager>::M,
390 <Self::CM as AChannelManager>::T,
391 <Self::CM as AChannelManager>::ES,
392 <Self::CM as AChannelManager>::NS,
393 <Self::CM as AChannelManager>::SP,
394 <Self::CM as AChannelManager>::F,
395 <Self::CM as AChannelManager>::R,
396 <Self::CM as AChannelManager>::L> { (*self).node() }
397 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { (*self).chain_monitor() }
399 impl<'a, 'b: 'a, 'c: 'b> NodeHolder for Node<'a, 'b, 'c> {
400 type CM = TestChannelManager<'a, 'b, 'c>;
401 fn node(&self) -> &TestChannelManager<'a, 'b, 'c> { &self.node }
402 fn chain_monitor(&self) -> Option<&test_utils::TestChainMonitor> { Some(self.chain_monitor) }
405 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
408 // Check that we processed all pending events
409 let msg_events = self.node.get_and_clear_pending_msg_events();
410 if !msg_events.is_empty() {
411 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
413 let events = self.node.get_and_clear_pending_events();
414 if !events.is_empty() {
415 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
417 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
418 if !added_monitors.is_empty() {
419 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
422 // Check that if we serialize the network graph, we can deserialize it again.
423 let network_graph = {
424 let mut w = test_utils::TestVecWriter(Vec::new());
425 self.network_graph.write(&mut w).unwrap();
426 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
427 assert!(network_graph_deser == *self.network_graph);
428 let gossip_sync = P2PGossipSync::new(
429 &network_graph_deser, Some(self.chain_source), self.logger
431 let mut chan_progress = 0;
433 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
434 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
435 assert!(orig_announcements == deserialized_announcements);
436 chan_progress = match orig_announcements {
437 Some(announcement) => announcement.0.contents.short_channel_id + 1,
441 let mut node_progress = None;
443 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
444 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
445 assert!(orig_announcements == deserialized_announcements);
446 node_progress = match orig_announcements {
447 Some(announcement) => Some(announcement.contents.node_id),
454 // Check that if we serialize and then deserialize all our channel monitors we get the
455 // same set of outputs to watch for on chain as we have now. Note that if we write
456 // tests that fully close channels and remove the monitors at some point this may break.
457 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
458 let mut deserialized_monitors = Vec::new();
460 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
461 let mut w = test_utils::TestVecWriter(Vec::new());
462 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
463 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
464 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
465 deserialized_monitors.push(deserialized_monitor);
469 let broadcaster = test_utils::TestBroadcaster {
470 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
471 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
474 // Before using all the new monitors to check the watch outpoints, use the full set of
475 // them to ensure we can write and reload our ChannelManager.
477 let mut channel_monitors = HashMap::new();
478 for monitor in deserialized_monitors.iter_mut() {
479 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
482 let scorer = Mutex::new(test_utils::TestScorer::new());
483 let mut w = test_utils::TestVecWriter(Vec::new());
484 self.node.write(&mut w).unwrap();
485 <(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 {
486 default_config: *self.node.get_current_default_configuration(),
487 entropy_source: self.keys_manager,
488 node_signer: self.keys_manager,
489 signer_provider: self.keys_manager,
490 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
491 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
492 chain_monitor: self.chain_monitor,
493 tx_broadcaster: &broadcaster,
494 logger: &self.logger,
499 let persister = test_utils::TestPersister::new();
500 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
501 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
502 for deserialized_monitor in deserialized_monitors.drain(..) {
503 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
507 assert_eq!(*chain_source.watched_txn.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_txn.unsafe_well_ordered_double_lock_self());
508 assert_eq!(*chain_source.watched_outputs.unsafe_well_ordered_double_lock_self(), *self.chain_source.watched_outputs.unsafe_well_ordered_double_lock_self());
513 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) {
514 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
517 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) {
518 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
519 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
520 (announcement, as_update, bs_update, channel_id, tx)
523 /// Gets an RAA and CS which were sent in response to a commitment update
524 pub fn get_revoke_commit_msgs<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, recipient: &PublicKey) -> (msgs::RevokeAndACK, msgs::CommitmentSigned) {
525 let events = node.node().get_and_clear_pending_msg_events();
526 assert_eq!(events.len(), 2);
528 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
529 assert_eq!(node_id, recipient);
532 _ => panic!("Unexpected event"),
534 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
535 assert_eq!(node_id, recipient);
536 assert!(updates.update_add_htlcs.is_empty());
537 assert!(updates.update_fulfill_htlcs.is_empty());
538 assert!(updates.update_fail_htlcs.is_empty());
539 assert!(updates.update_fail_malformed_htlcs.is_empty());
540 assert!(updates.update_fee.is_none());
541 updates.commitment_signed.clone()
543 _ => panic!("Unexpected event"),
548 /// Gets an RAA and CS which were sent in response to a commitment update
550 /// Don't use this, use the identically-named function instead.
551 macro_rules! get_revoke_commit_msgs {
552 ($node: expr, $node_id: expr) => {
553 $crate::ln::functional_test_utils::get_revoke_commit_msgs(&$node, &$node_id)
557 /// Get an specific event message from the pending events queue.
559 macro_rules! get_event_msg {
560 ($node: expr, $event_type: path, $node_id: expr) => {
562 let events = $node.node.get_and_clear_pending_msg_events();
563 assert_eq!(events.len(), 1);
565 $event_type { ref node_id, ref msg } => {
566 assert_eq!(*node_id, $node_id);
569 _ => panic!("Unexpected event"),
575 /// Get an error message from the pending events queue.
576 pub fn get_err_msg(node: &Node, recipient: &PublicKey) -> msgs::ErrorMessage {
577 let events = node.node.get_and_clear_pending_msg_events();
578 assert_eq!(events.len(), 1);
580 MessageSendEvent::HandleError {
581 action: msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
583 assert_eq!(node_id, recipient);
586 _ => panic!("Unexpected event"),
590 /// Get a specific event from the pending events queue.
592 macro_rules! get_event {
593 ($node: expr, $event_type: path) => {
595 let mut events = $node.node.get_and_clear_pending_events();
596 assert_eq!(events.len(), 1);
597 let ev = events.pop().unwrap();
599 $event_type { .. } => {
602 _ => panic!("Unexpected event"),
608 /// Gets an UpdateHTLCs MessageSendEvent
609 pub fn get_htlc_update_msgs(node: &Node, recipient: &PublicKey) -> msgs::CommitmentUpdate {
610 let events = node.node.get_and_clear_pending_msg_events();
611 assert_eq!(events.len(), 1);
613 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
614 assert_eq!(node_id, recipient);
617 _ => panic!("Unexpected event"),
622 /// Gets an UpdateHTLCs MessageSendEvent
624 /// Don't use this, use the identically-named function instead.
625 macro_rules! get_htlc_update_msgs {
626 ($node: expr, $node_id: expr) => {
627 $crate::ln::functional_test_utils::get_htlc_update_msgs(&$node, &$node_id)
631 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
632 /// Returns the `msg_event`.
634 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
635 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
636 /// such messages are intended to all peers.
637 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
638 let ev_index = msg_events.iter().position(|e| { match e {
639 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
640 node_id == msg_node_id
642 MessageSendEvent::SendOpenChannel { node_id, .. } => {
643 node_id == msg_node_id
645 MessageSendEvent::SendFundingCreated { node_id, .. } => {
646 node_id == msg_node_id
648 MessageSendEvent::SendFundingSigned { node_id, .. } => {
649 node_id == msg_node_id
651 MessageSendEvent::SendChannelReady { node_id, .. } => {
652 node_id == msg_node_id
654 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
655 node_id == msg_node_id
657 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
658 node_id == msg_node_id
660 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
661 node_id == msg_node_id
663 MessageSendEvent::SendClosingSigned { node_id, .. } => {
664 node_id == msg_node_id
666 MessageSendEvent::SendShutdown { node_id, .. } => {
667 node_id == msg_node_id
669 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
670 node_id == msg_node_id
672 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
673 node_id == msg_node_id
675 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
678 MessageSendEvent::BroadcastChannelUpdate { .. } => {
681 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
684 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
685 node_id == msg_node_id
687 MessageSendEvent::HandleError { node_id, .. } => {
688 node_id == msg_node_id
690 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
691 node_id == msg_node_id
693 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
694 node_id == msg_node_id
696 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
697 node_id == msg_node_id
699 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
700 node_id == msg_node_id
703 if ev_index.is_some() {
704 msg_events.remove(ev_index.unwrap())
706 panic!("Couldn't find any MessageSendEvent to the node!")
711 macro_rules! get_channel_ref {
712 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
714 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
715 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
716 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
722 macro_rules! get_feerate {
723 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
725 let mut per_peer_state_lock;
726 let mut peer_state_lock;
727 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
728 chan.get_feerate_sat_per_1000_weight()
734 macro_rules! get_opt_anchors {
735 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
737 let mut per_peer_state_lock;
738 let mut peer_state_lock;
739 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
745 /// Returns a channel monitor given a channel id, making some naive assumptions
747 macro_rules! get_monitor {
748 ($node: expr, $channel_id: expr) => {
750 use bitcoin::hashes::Hash;
751 let mut monitor = None;
752 // Assume funding vout is either 0 or 1 blindly
754 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
755 $crate::chain::transaction::OutPoint {
756 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
768 /// Returns any local commitment transactions for the channel.
770 macro_rules! get_local_commitment_txn {
771 ($node: expr, $channel_id: expr) => {
773 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
778 /// Check the error from attempting a payment.
780 macro_rules! unwrap_send_err {
781 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
783 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
784 assert_eq!(fails.len(), 1);
790 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
791 assert_eq!(results.len(), 1);
793 Err($type) => { $check },
802 /// Check whether N channel monitor(s) have been added.
803 pub fn check_added_monitors<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H, count: usize) {
804 if let Some(chain_monitor) = node.chain_monitor() {
805 let mut added_monitors = chain_monitor.added_monitors.lock().unwrap();
806 assert_eq!(added_monitors.len(), count);
807 added_monitors.clear();
811 /// Check whether N channel monitor(s) have been added.
813 /// Don't use this, use the identically-named function instead.
815 macro_rules! check_added_monitors {
816 ($node: expr, $count: expr) => {
817 $crate::ln::functional_test_utils::check_added_monitors(&$node, $count);
821 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> {
822 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
823 for encoded in monitors_encoded {
824 let mut monitor_read = &encoded[..];
825 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
826 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
827 assert!(monitor_read.is_empty());
828 monitors_read.push(monitor);
831 let mut node_read = &chanman_encoded[..];
832 let (_, node_deserialized) = {
833 let mut channel_monitors = HashMap::new();
834 for monitor in monitors_read.iter_mut() {
835 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
837 <(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 {
839 entropy_source: node.keys_manager,
840 node_signer: node.keys_manager,
841 signer_provider: node.keys_manager,
842 fee_estimator: node.fee_estimator,
844 chain_monitor: node.chain_monitor,
845 tx_broadcaster: node.tx_broadcaster,
850 assert!(node_read.is_empty());
852 for monitor in monitors_read.drain(..) {
853 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
854 ChannelMonitorUpdateStatus::Completed);
855 check_added_monitors!(node, 1);
862 macro_rules! reload_node {
863 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
864 let chanman_encoded = $chanman_encoded;
866 $persister = test_utils::TestPersister::new();
867 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
868 $node.chain_monitor = &$new_chain_monitor;
870 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
871 $node.node = &$new_channelmanager;
873 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
874 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
878 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) {
879 let chan_id = *node.network_chan_count.borrow();
881 let events = node.node.get_and_clear_pending_events();
882 assert_eq!(events.len(), 1);
884 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
885 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
886 assert_eq!(*channel_value_satoshis, expected_chan_value);
887 assert_eq!(user_channel_id, expected_user_chan_id);
889 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
890 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
892 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
893 (*temporary_channel_id, tx, funding_outpoint)
895 _ => panic!("Unexpected event"),
898 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 {
899 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
900 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
902 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
903 check_added_monitors!(node_a, 0);
905 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
906 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
907 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
909 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
910 assert_eq!(added_monitors.len(), 1);
911 assert_eq!(added_monitors[0].0, funding_output);
912 added_monitors.clear();
914 expect_channel_pending_event(&node_b, &node_a.node.get_our_node_id());
916 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()));
918 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
919 assert_eq!(added_monitors.len(), 1);
920 assert_eq!(added_monitors[0].0, funding_output);
921 added_monitors.clear();
923 expect_channel_pending_event(&node_a, &node_b.node.get_our_node_id());
925 let events_4 = node_a.node.get_and_clear_pending_events();
926 assert_eq!(events_4.len(), 0);
928 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
929 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
930 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
932 // Ensure that funding_transaction_generated is idempotent.
933 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
934 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
935 check_added_monitors!(node_a, 0);
940 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
941 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]) {
942 let initiator_channels = initiator.node.list_usable_channels().len();
943 let receiver_channels = receiver.node.list_usable_channels().len();
945 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
946 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
948 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
949 let events = receiver.node.get_and_clear_pending_events();
950 assert_eq!(events.len(), 1);
952 Event::OpenChannelRequest { temporary_channel_id, .. } => {
953 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
955 _ => panic!("Unexpected event"),
958 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
959 assert_eq!(accept_channel.minimum_depth, 0);
960 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
962 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
963 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
964 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
966 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
967 check_added_monitors!(receiver, 1);
968 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
969 assert_eq!(bs_signed_locked.len(), 2);
970 let as_channel_ready;
971 match &bs_signed_locked[0] {
972 MessageSendEvent::SendFundingSigned { node_id, msg } => {
973 assert_eq!(*node_id, initiator.node.get_our_node_id());
974 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
975 expect_channel_pending_event(&initiator, &receiver.node.get_our_node_id());
976 expect_channel_pending_event(&receiver, &initiator.node.get_our_node_id());
977 check_added_monitors!(initiator, 1);
979 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
980 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
982 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
984 _ => panic!("Unexpected event"),
986 match &bs_signed_locked[1] {
987 MessageSendEvent::SendChannelReady { node_id, msg } => {
988 assert_eq!(*node_id, initiator.node.get_our_node_id());
989 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
990 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
992 _ => panic!("Unexpected event"),
995 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
996 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
998 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
999 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
1001 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
1002 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
1004 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
1005 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
1007 (tx, as_channel_ready.channel_id)
1010 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 {
1011 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
1012 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
1013 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
1014 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
1015 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
1016 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
1017 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
1018 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
1019 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
1021 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
1024 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) {
1025 confirm_transaction_at(node_conf, tx, conf_height);
1026 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
1027 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()));
1030 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]) {
1032 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
1033 assert_eq!(events_6.len(), 3);
1034 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
1035 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1037 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
1038 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1040 } else { panic!("Unexpected event: {:?}", events_6[1]); };
1041 ((match events_6[0] {
1042 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
1043 channel_id = msg.channel_id.clone();
1044 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1047 _ => panic!("Unexpected event"),
1048 }, match events_6[announcement_sigs_idx] {
1049 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
1050 assert_eq!(*node_id, node_recv.node.get_our_node_id());
1053 _ => panic!("Unexpected event"),
1057 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]) {
1058 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
1059 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
1060 confirm_transaction_at(node_a, tx, conf_height);
1061 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
1062 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
1063 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1066 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) {
1067 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1068 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1072 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) {
1073 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1074 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1075 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1077 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1078 assert_eq!(events_7.len(), 1);
1079 let (announcement, bs_update) = match events_7[0] {
1080 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1081 (msg, update_msg.clone().unwrap())
1083 _ => panic!("Unexpected event"),
1086 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1087 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1088 assert_eq!(events_8.len(), 1);
1089 let as_update = match events_8[0] {
1090 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1091 assert!(*announcement == *msg);
1092 let update_msg = update_msg.clone().unwrap();
1093 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1094 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1097 _ => panic!("Unexpected event"),
1100 *node_a.network_chan_count.borrow_mut() += 1;
1102 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1103 ((*announcement).clone(), as_update, bs_update)
1106 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) {
1107 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1110 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) {
1111 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1112 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1113 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1116 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) {
1117 let mut no_announce_cfg = test_default_channel_config();
1118 no_announce_cfg.channel_handshake_config.announced_channel = false;
1119 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1120 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1121 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1122 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1123 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1125 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1126 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1127 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()));
1128 check_added_monitors!(nodes[b], 1);
1130 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1131 expect_channel_pending_event(&nodes[b], &nodes[a].node.get_our_node_id());
1133 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1134 expect_channel_pending_event(&nodes[a], &nodes[b].node.get_our_node_id());
1135 check_added_monitors!(nodes[a], 1);
1137 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1138 assert_eq!(nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
1139 nodes[a].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1141 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1142 confirm_transaction_at(&nodes[a], &tx, conf_height);
1143 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1144 confirm_transaction_at(&nodes[b], &tx, conf_height);
1145 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1146 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1147 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()));
1148 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1149 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1150 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1151 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1152 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1154 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1155 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1157 let mut found_a = false;
1158 for chan in nodes[a].node.list_usable_channels() {
1159 if chan.channel_id == as_channel_ready.channel_id {
1162 assert!(!chan.is_public);
1167 let mut found_b = false;
1168 for chan in nodes[b].node.list_usable_channels() {
1169 if chan.channel_id == as_channel_ready.channel_id {
1172 assert!(!chan.is_public);
1177 (as_channel_ready, tx)
1180 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) {
1182 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1183 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1184 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1186 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1187 // forwarding info for local channels even if its not accepted in the network graph.
1188 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1189 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1193 pub fn do_check_spends<F: Fn(&bitcoin::blockdata::transaction::OutPoint) -> Option<TxOut>>(tx: &Transaction, get_output: F) {
1194 for outp in tx.output.iter() {
1195 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1197 let mut total_value_in = 0;
1198 for input in tx.input.iter() {
1199 total_value_in += get_output(&input.previous_output).unwrap().value;
1201 let mut total_value_out = 0;
1202 for output in tx.output.iter() {
1203 total_value_out += output.value;
1205 let min_fee = (tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1206 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1207 assert!(total_value_out + min_fee <= total_value_in);
1208 tx.verify(get_output).unwrap();
1212 macro_rules! check_spends {
1213 ($tx: expr, $($spends_txn: expr),*) => {
1216 for outp in $spends_txn.output.iter() {
1217 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1220 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1222 if out_point.txid == $spends_txn.txid() {
1223 return $spends_txn.output.get(out_point.vout as usize).cloned()
1228 $crate::ln::functional_test_utils::do_check_spends(&$tx, get_output);
1233 macro_rules! get_closing_signed_broadcast {
1234 ($node: expr, $dest_pubkey: expr) => {
1236 let events = $node.get_and_clear_pending_msg_events();
1237 assert!(events.len() == 1 || events.len() == 2);
1238 (match events[events.len() - 1] {
1239 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1240 assert_eq!(msg.contents.flags & 2, 2);
1243 _ => panic!("Unexpected event"),
1244 }, if events.len() == 2 {
1246 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1247 assert_eq!(*node_id, $dest_pubkey);
1250 _ => panic!("Unexpected event"),
1258 macro_rules! check_warn_msg {
1259 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1260 let msg_events = $node.node.get_and_clear_pending_msg_events();
1261 assert_eq!(msg_events.len(), 1);
1262 match msg_events[0] {
1263 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1264 assert_eq!(node_id, $recipient_node_id);
1265 assert_eq!(msg.channel_id, $chan_id);
1268 _ => panic!("Unexpected event"),
1273 /// Check that a channel's closing channel update has been broadcasted, and optionally
1274 /// check whether an error message event has occurred.
1275 pub fn check_closed_broadcast(node: &Node, num_channels: usize, with_error_msg: bool) -> Vec<msgs::ErrorMessage> {
1276 let msg_events = node.node.get_and_clear_pending_msg_events();
1277 assert_eq!(msg_events.len(), if with_error_msg { num_channels * 2 } else { num_channels });
1278 msg_events.into_iter().filter_map(|msg_event| {
1280 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1281 assert_eq!(msg.contents.flags & 2, 2);
1284 MessageSendEvent::HandleError { action: msgs::ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1285 assert!(with_error_msg);
1286 // TODO: Check node_id
1289 _ => panic!("Unexpected event"),
1294 /// Check that a channel's closing channel update has been broadcasted, and optionally
1295 /// check whether an error message event has occurred.
1297 /// Don't use this, use the identically-named function instead.
1299 macro_rules! check_closed_broadcast {
1300 ($node: expr, $with_error_msg: expr) => {
1301 $crate::ln::functional_test_utils::check_closed_broadcast(&$node, 1, $with_error_msg).pop()
1305 /// Check that a channel's closing channel events has been issued
1306 pub fn check_closed_event(node: &Node, events_count: usize, expected_reason: ClosureReason, is_check_discard_funding: bool) {
1307 let events = node.node.get_and_clear_pending_events();
1308 assert_eq!(events.len(), events_count, "{:?}", events);
1309 let mut issues_discard_funding = false;
1310 for event in events {
1312 Event::ChannelClosed { ref reason, .. } => {
1313 assert_eq!(*reason, expected_reason);
1315 Event::DiscardFunding { .. } => {
1316 issues_discard_funding = true;
1318 _ => panic!("Unexpected event"),
1321 assert_eq!(is_check_discard_funding, issues_discard_funding);
1324 /// Check that a channel's closing channel events has been issued
1326 /// Don't use this, use the identically-named function instead.
1328 macro_rules! check_closed_event {
1329 ($node: expr, $events: expr, $reason: expr) => {
1330 check_closed_event!($node, $events, $reason, false);
1332 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {
1333 $crate::ln::functional_test_utils::check_closed_event(&$node, $events, $reason, $is_check_discard_funding);
1337 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) {
1338 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) };
1339 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) };
1342 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1343 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1345 let events_1 = node_b.get_and_clear_pending_msg_events();
1346 assert!(events_1.len() >= 1);
1347 let shutdown_b = match events_1[0] {
1348 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1349 assert_eq!(node_id, &node_a.get_our_node_id());
1352 _ => panic!("Unexpected event"),
1355 let closing_signed_b = if !close_inbound_first {
1356 assert_eq!(events_1.len(), 1);
1359 Some(match events_1[1] {
1360 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1361 assert_eq!(node_id, &node_a.get_our_node_id());
1364 _ => panic!("Unexpected event"),
1368 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1369 let (as_update, bs_update) = if close_inbound_first {
1370 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1371 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1373 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1374 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1375 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1376 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1378 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1379 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1380 assert!(none_a.is_none());
1381 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1382 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1383 (as_update, bs_update)
1385 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1387 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1388 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1390 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1391 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1392 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1394 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1395 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1396 assert!(none_b.is_none());
1397 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1398 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1399 (as_update, bs_update)
1401 assert_eq!(tx_a, tx_b);
1402 check_spends!(tx_a, funding_tx);
1404 (as_update, bs_update, tx_a)
1407 pub struct SendEvent {
1408 pub node_id: PublicKey,
1409 pub msgs: Vec<msgs::UpdateAddHTLC>,
1410 pub commitment_msg: msgs::CommitmentSigned,
1413 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1414 assert!(updates.update_fulfill_htlcs.is_empty());
1415 assert!(updates.update_fail_htlcs.is_empty());
1416 assert!(updates.update_fail_malformed_htlcs.is_empty());
1417 assert!(updates.update_fee.is_none());
1418 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1421 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1423 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1424 _ => panic!("Unexpected event type!"),
1428 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1429 let mut events = node.node.get_and_clear_pending_msg_events();
1430 assert_eq!(events.len(), 1);
1431 SendEvent::from_event(events.pop().unwrap())
1436 /// Don't use this, use the identically-named function instead.
1437 macro_rules! expect_pending_htlcs_forwardable_conditions {
1438 ($node: expr, $expected_failures: expr) => {
1439 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1444 macro_rules! expect_htlc_handling_failed_destinations {
1445 ($events: expr, $expected_failures: expr) => {{
1446 for event in $events {
1448 $crate::events::Event::PendingHTLCsForwardable { .. } => { },
1449 $crate::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1450 assert!($expected_failures.contains(&failed_next_destination))
1452 _ => panic!("Unexpected destination"),
1458 /// Checks that an [`Event::PendingHTLCsForwardable`] is available in the given events and, if
1459 /// there are any [`Event::HTLCHandlingFailed`] events their [`HTLCDestination`] is included in the
1460 /// `expected_failures` set.
1461 pub fn expect_pending_htlcs_forwardable_conditions(events: Vec<Event>, expected_failures: &[HTLCDestination]) {
1463 Event::PendingHTLCsForwardable { .. } => { },
1464 _ => panic!("Unexpected event {:?}", events),
1467 let count = expected_failures.len() + 1;
1468 assert_eq!(events.len(), count);
1470 if expected_failures.len() > 0 {
1471 expect_htlc_handling_failed_destinations!(events, expected_failures)
1476 /// Clears (and ignores) a PendingHTLCsForwardable event
1478 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] with an empty failure
1480 macro_rules! expect_pending_htlcs_forwardable_ignore {
1482 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1487 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1489 /// Don't use this, call [`expect_pending_htlcs_forwardable_conditions()`] instead.
1490 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1491 ($node: expr, $expected_failures: expr) => {
1492 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1497 /// Handles a PendingHTLCsForwardable event
1498 macro_rules! expect_pending_htlcs_forwardable {
1500 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &[]);
1501 $node.node.process_pending_htlc_forwards();
1503 // Ensure process_pending_htlc_forwards is idempotent.
1504 $node.node.process_pending_htlc_forwards();
1509 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1510 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1511 ($node: expr, $expected_failures: expr) => {{
1512 $crate::ln::functional_test_utils::expect_pending_htlcs_forwardable_conditions($node.node.get_and_clear_pending_events(), &$expected_failures);
1513 $node.node.process_pending_htlc_forwards();
1515 // Ensure process_pending_htlc_forwards is idempotent.
1516 $node.node.process_pending_htlc_forwards();
1521 macro_rules! expect_pending_htlcs_forwardable_from_events {
1522 ($node: expr, $events: expr, $ignore: expr) => {{
1523 assert_eq!($events.len(), 1);
1525 Event::PendingHTLCsForwardable { .. } => { },
1526 _ => panic!("Unexpected event"),
1529 $node.node.process_pending_htlc_forwards();
1531 // Ensure process_pending_htlc_forwards is idempotent.
1532 $node.node.process_pending_htlc_forwards();
1538 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1539 /// commitment update.
1540 macro_rules! commitment_signed_dance {
1541 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1542 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1544 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1545 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1547 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1549 $crate::ln::functional_test_utils::check_added_monitors(&$node_a, 0);
1550 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1551 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1552 check_added_monitors(&$node_a, 1);
1553 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1554 assert!(extra_msg_option.is_none());
1558 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1559 assert!($crate::ln::functional_test_utils::commitment_signed_dance_through_cp_raa(&$node_a, &$node_b, $fail_backwards).is_none());
1561 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1562 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1566 /// Runs the commitment_signed dance after the initial commitment_signed is delivered through to
1567 /// the initiator's `revoke_and_ack` response. i.e. [`do_main_commitment_signed_dance`] plus the
1568 /// `revoke_and_ack` response to it.
1570 /// Returns any additional message `node_b` generated in addition to the `revoke_and_ack` response.
1571 pub fn commitment_signed_dance_through_cp_raa(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> Option<MessageSendEvent> {
1572 let (extra_msg_option, bs_revoke_and_ack) = do_main_commitment_signed_dance(node_a, node_b, fail_backwards);
1573 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1574 check_added_monitors(node_a, 1);
1578 /// Does the main logic in the commitment_signed dance. After the first `commitment_signed` has
1579 /// been delivered, this method picks up and delivers the response `revoke_and_ack` and
1580 /// `commitment_signed`, returning the recipient's `revoke_and_ack` and any extra message it may
1582 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1583 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1584 check_added_monitors!(node_b, 0);
1585 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1586 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1587 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1588 check_added_monitors!(node_b, 1);
1589 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1590 let (bs_revoke_and_ack, extra_msg_option) = {
1591 let mut events = node_b.node.get_and_clear_pending_msg_events();
1592 assert!(events.len() <= 2);
1593 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1594 (match node_a_event {
1595 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1596 assert_eq!(*node_id, node_a.node.get_our_node_id());
1599 _ => panic!("Unexpected event"),
1600 }, events.get(0).map(|e| e.clone()))
1602 check_added_monitors!(node_b, 1);
1604 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1605 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1607 (extra_msg_option, bs_revoke_and_ack)
1610 /// Runs a full commitment_signed dance, delivering a commitment_signed, the responding
1611 /// `revoke_and_ack` and `commitment_signed`, and then the final `revoke_and_ack` response.
1613 /// If `skip_last_step` is unset, also checks for the payment failure update for the previous hop
1614 /// on failure or that no new messages are left over on success.
1615 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1616 check_added_monitors!(node_a, 0);
1617 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1618 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1619 check_added_monitors!(node_a, 1);
1621 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1623 if skip_last_step { return; }
1626 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1627 vec![crate::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1628 check_added_monitors!(node_a, 1);
1630 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1631 let mut number_of_msg_events = 0;
1632 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1633 let peer_state = peer_state_mutex.lock().unwrap();
1634 let cp_pending_msg_events = &peer_state.pending_msg_events;
1635 number_of_msg_events += cp_pending_msg_events.len();
1636 if cp_pending_msg_events.len() == 1 {
1637 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1638 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1639 } else { panic!("Unexpected event"); }
1642 // Expecting the failure backwards event to the previous hop (not `node_b`)
1643 assert_eq!(number_of_msg_events, 1);
1645 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1649 /// Get a payment preimage and hash.
1650 pub fn get_payment_preimage_hash(recipient: &Node, min_value_msat: Option<u64>, min_final_cltv_expiry_delta: Option<u16>) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
1651 let mut payment_count = recipient.network_payment_count.borrow_mut();
1652 let payment_preimage = PaymentPreimage([*payment_count; 32]);
1653 *payment_count += 1;
1654 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner());
1655 let payment_secret = recipient.node.create_inbound_payment_for_hash(payment_hash, min_value_msat, 7200, min_final_cltv_expiry_delta).unwrap();
1656 (payment_preimage, payment_hash, payment_secret)
1659 /// Get a payment preimage and hash.
1661 /// Don't use this, use the identically-named function instead.
1663 macro_rules! get_payment_preimage_hash {
1664 ($dest_node: expr) => {
1665 get_payment_preimage_hash!($dest_node, None)
1667 ($dest_node: expr, $min_value_msat: expr) => {
1668 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1670 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1671 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$dest_node, $min_value_msat, $min_final_cltv_expiry_delta)
1675 /// Gets a route from the given sender to the node described in `payment_params`.
1676 pub fn get_route(send_node: &Node, payment_params: &PaymentParameters, recv_value: u64, final_cltv_expiry_delta: u32) -> Result<Route, msgs::LightningError> {
1677 let scorer = TestScorer::new();
1678 let keys_manager = TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1679 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1681 &send_node.node.get_our_node_id(), payment_params, &send_node.network_graph.read_only(),
1682 Some(&send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1683 recv_value, final_cltv_expiry_delta, send_node.logger, &scorer, &random_seed_bytes
1687 /// Gets a route from the given sender to the node described in `payment_params`.
1689 /// Don't use this, use the identically-named function instead.
1691 macro_rules! get_route {
1692 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {
1693 $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv)
1699 macro_rules! get_route_and_payment_hash {
1700 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1701 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1702 .with_features($recv_node.node.invoice_features());
1703 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1705 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1706 let (payment_preimage, payment_hash, payment_secret) =
1707 $crate::ln::functional_test_utils::get_payment_preimage_hash(&$recv_node, Some($recv_value), None);
1708 let route = $crate::ln::functional_test_utils::get_route(&$send_node, &$payment_params, $recv_value, $cltv);
1709 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1714 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1715 macro_rules! expect_payment_claimable {
1716 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1717 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1719 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1720 let events = $node.node.get_and_clear_pending_events();
1721 assert_eq!(events.len(), 1);
1723 $crate::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, .. } => {
1724 assert_eq!($expected_payment_hash, *payment_hash);
1725 assert_eq!($expected_recv_value, amount_msat);
1726 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1728 $crate::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1729 assert_eq!(&$expected_payment_preimage, payment_preimage);
1730 assert_eq!($expected_payment_secret, *payment_secret);
1735 _ => panic!("Unexpected event"),
1741 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1742 macro_rules! expect_payment_claimed {
1743 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1744 let events = $node.node.get_and_clear_pending_events();
1745 assert_eq!(events.len(), 1);
1747 $crate::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1748 assert_eq!($expected_payment_hash, *payment_hash);
1749 assert_eq!($expected_recv_value, amount_msat);
1751 _ => panic!("Unexpected event"),
1756 pub fn expect_payment_sent<CM: AChannelManager, H: NodeHolder<CM=CM>>(node: &H,
1757 expected_payment_preimage: PaymentPreimage, expected_fee_msat_opt: Option<Option<u64>>,
1758 expect_per_path_claims: bool,
1760 let events = node.node().get_and_clear_pending_events();
1761 let expected_payment_hash = PaymentHash(
1762 bitcoin::hashes::sha256::Hash::hash(&expected_payment_preimage.0).into_inner());
1763 if expect_per_path_claims {
1764 assert!(events.len() > 1);
1766 assert_eq!(events.len(), 1);
1768 let expected_payment_id = match events[0] {
1769 Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1770 assert_eq!(expected_payment_preimage, *payment_preimage);
1771 assert_eq!(expected_payment_hash, *payment_hash);
1772 if let Some(expected_fee_msat) = expected_fee_msat_opt {
1773 assert_eq!(*fee_paid_msat, expected_fee_msat);
1775 assert!(fee_paid_msat.is_some());
1779 _ => panic!("Unexpected event"),
1781 if expect_per_path_claims {
1782 for i in 1..events.len() {
1784 Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1785 assert_eq!(payment_id, expected_payment_id);
1786 assert_eq!(payment_hash, Some(expected_payment_hash));
1788 _ => panic!("Unexpected event"),
1796 macro_rules! expect_payment_sent_without_paths {
1797 ($node: expr, $expected_payment_preimage: expr) => {
1798 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1800 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1801 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1806 macro_rules! expect_payment_sent {
1807 ($node: expr, $expected_payment_preimage: expr) => {
1808 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1810 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1811 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1813 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => {
1814 $crate::ln::functional_test_utils::expect_payment_sent(&$node, $expected_payment_preimage,
1815 $expected_fee_msat_opt.map(|o| Some(o)), $expect_paths);
1821 macro_rules! expect_payment_path_successful {
1823 let events = $node.node.get_and_clear_pending_events();
1824 assert_eq!(events.len(), 1);
1826 $crate::events::Event::PaymentPathSuccessful { .. } => {},
1827 _ => panic!("Unexpected event"),
1832 macro_rules! expect_payment_forwarded {
1833 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1834 let events = $node.node.get_and_clear_pending_events();
1835 assert_eq!(events.len(), 1);
1837 Event::PaymentForwarded {
1838 fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id,
1839 outbound_amount_forwarded_msat: _
1841 assert_eq!(fee_earned_msat, $expected_fee);
1842 if fee_earned_msat.is_some() {
1843 // Is the event prev_channel_id in one of the channels between the two nodes?
1844 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()));
1846 // We check for force closures since a force closed channel is removed from the
1847 // node's channel list
1848 if !$downstream_force_closed {
1849 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()));
1851 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1853 _ => panic!("Unexpected event"),
1858 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1859 pub fn expect_channel_pending_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1860 let events = node.node.get_and_clear_pending_events();
1861 assert_eq!(events.len(), 1);
1863 crate::events::Event::ChannelPending { ref counterparty_node_id, .. } => {
1864 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1866 _ => panic!("Unexpected event"),
1870 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1871 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1872 let events = node.node.get_and_clear_pending_events();
1873 assert_eq!(events.len(), 1);
1875 crate::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1876 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1878 _ => panic!("Unexpected event"),
1882 pub struct PaymentFailedConditions<'a> {
1883 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1884 pub(crate) expected_blamed_scid: Option<u64>,
1885 pub(crate) expected_blamed_chan_closed: Option<bool>,
1886 pub(crate) expected_mpp_parts_remain: bool,
1889 impl<'a> PaymentFailedConditions<'a> {
1890 pub fn new() -> Self {
1892 expected_htlc_error_data: None,
1893 expected_blamed_scid: None,
1894 expected_blamed_chan_closed: None,
1895 expected_mpp_parts_remain: false,
1898 pub fn mpp_parts_remain(mut self) -> Self {
1899 self.expected_mpp_parts_remain = true;
1902 pub fn blamed_scid(mut self, scid: u64) -> Self {
1903 self.expected_blamed_scid = Some(scid);
1906 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1907 self.expected_blamed_chan_closed = Some(closed);
1910 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1911 self.expected_htlc_error_data = Some((code, data));
1917 macro_rules! expect_payment_failed_with_update {
1918 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1919 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1920 &$node, $expected_payment_hash, $payment_failed_permanently,
1921 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1922 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1927 macro_rules! expect_payment_failed {
1928 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1929 #[allow(unused_mut)]
1930 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1932 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1934 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1938 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1939 payment_failed_events: Vec<Event>, expected_payment_hash: PaymentHash,
1940 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1942 if conditions.expected_mpp_parts_remain { assert_eq!(payment_failed_events.len(), 1); } else { assert_eq!(payment_failed_events.len(), 2); }
1943 let expected_payment_id = match &payment_failed_events[0] {
1944 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, payment_id, failure,
1948 error_data, .. } => {
1949 assert_eq!(*payment_hash, expected_payment_hash, "unexpected payment_hash");
1950 assert_eq!(*payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1953 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1954 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1955 if let Some((code, data)) = conditions.expected_htlc_error_data {
1956 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1957 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1961 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1962 if let PathFailure::OnPath { network_update: Some(upd) } = failure {
1964 NetworkUpdate::ChannelUpdateMessage { ref msg } if !chan_closed => {
1965 if let Some(scid) = conditions.expected_blamed_scid {
1966 assert_eq!(msg.contents.short_channel_id, scid);
1968 const CHAN_DISABLED_FLAG: u8 = 2;
1969 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1971 NetworkUpdate::ChannelFailure { short_channel_id, is_permanent } if chan_closed => {
1972 if let Some(scid) = conditions.expected_blamed_scid {
1973 assert_eq!(*short_channel_id, scid);
1975 assert!(is_permanent);
1977 _ => panic!("Unexpected update type"),
1979 } else { panic!("Expected network update"); }
1984 _ => panic!("Unexpected event"),
1986 if !conditions.expected_mpp_parts_remain {
1987 match &payment_failed_events[1] {
1988 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
1989 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1990 assert_eq!(*payment_id, expected_payment_id);
1991 assert_eq!(reason.unwrap(), if expected_payment_failed_permanently {
1992 PaymentFailureReason::RecipientRejected
1994 PaymentFailureReason::RetriesExhausted
1997 _ => panic!("Unexpected second event"),
2002 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
2003 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
2004 conditions: PaymentFailedConditions<'e>
2006 let events = node.node.get_and_clear_pending_events();
2007 expect_payment_failed_conditions_event(events, expected_payment_hash, expected_payment_failed_permanently, conditions);
2010 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 {
2011 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
2012 origin_node.node.send_payment_with_route(&route, our_payment_hash,
2013 RecipientOnionFields::secret_only(our_payment_secret), payment_id).unwrap();
2014 check_added_monitors!(origin_node, expected_paths.len());
2015 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
2019 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> {
2020 let mut payment_event = SendEvent::from_event(ev);
2021 let mut prev_node = origin_node;
2022 let mut event = None;
2024 for (idx, &node) in expected_path.iter().enumerate() {
2025 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2027 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
2028 check_added_monitors!(node, 0);
2029 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
2031 expect_pending_htlcs_forwardable!(node);
2033 if idx == expected_path.len() - 1 && clear_recipient_events {
2034 let events_2 = node.node.get_and_clear_pending_events();
2035 if payment_claimable_expected {
2036 assert_eq!(events_2.len(), 1);
2038 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id, claim_deadline } => {
2039 assert_eq!(our_payment_hash, *payment_hash);
2040 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
2042 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
2043 assert_eq!(expected_preimage, *payment_preimage);
2044 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
2046 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
2047 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
2048 assert!(our_payment_secret.is_none());
2051 assert_eq!(amount_msat, recv_value);
2052 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
2053 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
2054 assert!(claim_deadline.unwrap() > node.best_block_info().1);
2056 _ => panic!("Unexpected event"),
2058 event = Some(events_2[0].clone());
2060 assert!(events_2.is_empty());
2062 } else if idx != expected_path.len() - 1 {
2063 let mut events_2 = node.node.get_and_clear_pending_msg_events();
2064 assert_eq!(events_2.len(), 1);
2065 check_added_monitors!(node, 1);
2066 payment_event = SendEvent::from_event(events_2.remove(0));
2067 assert_eq!(payment_event.msgs.len(), 1);
2075 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> {
2076 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage)
2079 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) {
2080 let mut events = origin_node.node.get_and_clear_pending_msg_events();
2081 assert_eq!(events.len(), expected_route.len());
2082 for (path_idx, expected_path) in expected_route.iter().enumerate() {
2083 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2084 // Once we've gotten through all the HTLCs, the last one should result in a
2085 // PaymentClaimable (but each previous one should not!), .
2086 let expect_payment = path_idx == expected_route.len() - 1;
2087 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
2091 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) {
2092 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2093 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
2094 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
2097 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 {
2098 for path in expected_paths.iter() {
2099 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2101 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2103 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
2104 assert_eq!(claim_event.len(), 1);
2105 match claim_event[0] {
2106 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
2107 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
2108 assert_eq!(preimage, our_payment_preimage),
2109 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
2110 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
2114 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2116 let mut expected_total_fee_msat = 0;
2118 macro_rules! msgs_from_ev {
2121 &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 } } => {
2122 assert!(update_add_htlcs.is_empty());
2123 assert_eq!(update_fulfill_htlcs.len(), 1);
2124 assert!(update_fail_htlcs.is_empty());
2125 assert!(update_fail_malformed_htlcs.is_empty());
2126 assert!(update_fee.is_none());
2127 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
2129 _ => panic!("Unexpected event"),
2133 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2134 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2135 assert_eq!(events.len(), expected_paths.len());
2137 if events.len() == 1 {
2138 per_path_msgs.push(msgs_from_ev!(&events[0]));
2140 for expected_path in expected_paths.iter() {
2141 // For MPP payments, we always want the message to the first node in the path.
2142 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2143 per_path_msgs.push(msgs_from_ev!(&ev));
2147 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2148 let mut next_msgs = Some(path_msgs);
2149 let mut expected_next_node = next_hop;
2151 macro_rules! last_update_fulfill_dance {
2152 ($node: expr, $prev_node: expr) => {
2154 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2155 check_added_monitors!($node, 0);
2156 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2157 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2161 macro_rules! mid_update_fulfill_dance {
2162 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2164 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2166 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2167 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2168 .unwrap().lock().unwrap();
2169 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2170 if let Some(prev_config) = channel.prev_config() {
2171 prev_config.forwarding_fee_base_msat
2173 channel.config().forwarding_fee_base_msat
2176 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2177 expected_total_fee_msat += fee as u64;
2178 check_added_monitors!($node, 1);
2179 let new_next_msgs = if $new_msgs {
2180 let events = $node.node.get_and_clear_pending_msg_events();
2181 assert_eq!(events.len(), 1);
2182 let (res, nexthop) = msgs_from_ev!(&events[0]);
2183 expected_next_node = nexthop;
2186 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2189 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2190 next_msgs = new_next_msgs;
2195 let mut prev_node = expected_route.last().unwrap();
2196 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2197 assert_eq!(expected_next_node, node.node.get_our_node_id());
2198 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2199 if next_msgs.is_some() {
2200 // Since we are traversing in reverse, next_node is actually the previous node
2201 let next_node: &Node;
2202 if idx == expected_route.len() - 1 {
2203 next_node = origin_node;
2205 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2207 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2209 assert!(!update_next_msgs);
2210 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2212 if !skip_last && idx == expected_route.len() - 1 {
2213 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2220 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2224 // Ensure that claim_funds is idempotent.
2225 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2226 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2227 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2229 expected_total_fee_msat
2231 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) {
2232 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2234 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2238 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2239 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2242 pub const TEST_FINAL_CLTV: u32 = 70;
2244 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) {
2245 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2246 .with_features(expected_route.last().unwrap().node.invoice_features());
2247 let route = get_route(origin_node, &payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2248 assert_eq!(route.paths.len(), 1);
2249 assert_eq!(route.paths[0].len(), expected_route.len());
2250 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2251 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2254 let res = send_along_route(origin_node, route, expected_route, recv_value);
2255 (res.0, res.1, res.2)
2258 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2259 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2260 .with_features(expected_route.last().unwrap().node.invoice_features());
2261 let network_graph = origin_node.network_graph.read_only();
2262 let scorer = test_utils::TestScorer::new();
2263 let seed = [0u8; 32];
2264 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2265 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2266 let route = router::get_route(
2267 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2268 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2269 assert_eq!(route.paths.len(), 1);
2270 assert_eq!(route.paths[0].len(), expected_route.len());
2271 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2272 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2275 let (_, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
2276 unwrap_send_err!(origin_node.node.send_payment_with_route(&route, our_payment_hash,
2277 RecipientOnionFields::secret_only(our_payment_secret), PaymentId(our_payment_hash.0)),
2278 true, APIError::ChannelUnavailable { ref err },
2279 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2282 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) -> (PaymentPreimage, PaymentHash, PaymentSecret) {
2283 let res = route_payment(&origin, expected_route, recv_value);
2284 claim_payment(&origin, expected_route, res.0);
2288 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) {
2289 for path in expected_paths.iter() {
2290 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2292 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2293 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2294 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2296 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash, PaymentFailureReason::RecipientRejected);
2299 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) {
2300 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2301 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2303 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2304 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2305 assert_eq!(events.len(), expected_paths.len());
2306 for ev in events.iter() {
2307 let (update_fail, commitment_signed, node_id) = match ev {
2308 &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 } } => {
2309 assert!(update_add_htlcs.is_empty());
2310 assert!(update_fulfill_htlcs.is_empty());
2311 assert_eq!(update_fail_htlcs.len(), 1);
2312 assert!(update_fail_malformed_htlcs.is_empty());
2313 assert!(update_fee.is_none());
2314 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2316 _ => panic!("Unexpected event"),
2318 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2320 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2321 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()));
2323 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2324 let mut next_msgs = Some(path_msgs);
2325 let mut expected_next_node = next_hop;
2326 let mut prev_node = expected_route.last().unwrap();
2328 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2329 assert_eq!(expected_next_node, node.node.get_our_node_id());
2330 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2331 if next_msgs.is_some() {
2332 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2333 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2334 if !update_next_node {
2335 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 }]);
2338 let events = node.node.get_and_clear_pending_msg_events();
2339 if update_next_node {
2340 assert_eq!(events.len(), 1);
2342 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 } } => {
2343 assert!(update_add_htlcs.is_empty());
2344 assert!(update_fulfill_htlcs.is_empty());
2345 assert_eq!(update_fail_htlcs.len(), 1);
2346 assert!(update_fail_malformed_htlcs.is_empty());
2347 assert!(update_fee.is_none());
2348 expected_next_node = node_id.clone();
2349 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2351 _ => panic!("Unexpected event"),
2354 assert!(events.is_empty());
2356 if !skip_last && idx == expected_route.len() - 1 {
2357 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2364 let prev_node = expected_route.first().unwrap();
2365 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2366 check_added_monitors!(origin_node, 0);
2367 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2368 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2369 let events = origin_node.node.get_and_clear_pending_events();
2370 if i == expected_paths.len() - 1 { assert_eq!(events.len(), 2); } else { assert_eq!(events.len(), 1); }
2372 let expected_payment_id = match events[0] {
2373 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, ref path, ref payment_id, .. } => {
2374 assert_eq!(payment_hash, our_payment_hash);
2375 assert!(payment_failed_permanently);
2376 for (idx, hop) in expected_route.iter().enumerate() {
2377 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2381 _ => panic!("Unexpected event"),
2383 if i == expected_paths.len() - 1 {
2385 Event::PaymentFailed { ref payment_hash, ref payment_id, ref reason } => {
2386 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2387 assert_eq!(*payment_id, expected_payment_id);
2388 assert_eq!(reason.unwrap(), expected_fail_reason);
2390 _ => panic!("Unexpected second event"),
2396 // Ensure that fail_htlc_backwards is idempotent.
2397 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2398 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2399 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2400 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2403 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2404 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2407 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2408 let mut chan_mon_cfgs = Vec::new();
2409 for i in 0..node_count {
2410 let tx_broadcaster = test_utils::TestBroadcaster {
2411 txn_broadcasted: Mutex::new(Vec::new()),
2412 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2414 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2415 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2416 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2417 let persister = test_utils::TestPersister::new();
2418 let seed = [i as u8; 32];
2419 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2420 let scorer = Mutex::new(test_utils::TestScorer::new());
2422 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2428 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2429 let mut nodes = Vec::new();
2431 for i in 0..node_count {
2432 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);
2433 let network_graph = Arc::new(NetworkGraph::new(Network::Testnet, &chanmon_cfgs[i].logger));
2434 let seed = [i as u8; 32];
2435 nodes.push(NodeCfg {
2436 chain_source: &chanmon_cfgs[i].chain_source,
2437 logger: &chanmon_cfgs[i].logger,
2438 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2439 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2440 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2442 keys_manager: &chanmon_cfgs[i].keys_manager,
2445 override_init_features: Rc::new(RefCell::new(None)),
2452 pub fn test_default_channel_config() -> UserConfig {
2453 let mut default_config = UserConfig::default();
2454 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2455 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2456 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2457 default_config.channel_handshake_config.announced_channel = true;
2458 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2459 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2460 // It now defaults to 1, so we simply set it to the expected value here.
2461 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2462 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2463 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2464 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2468 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>> {
2469 let mut chanmgrs = Vec::new();
2470 for i in 0..node_count {
2471 let network = Network::Testnet;
2472 let params = ChainParameters {
2474 best_block: BestBlock::from_network(network),
2476 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,
2477 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);
2478 chanmgrs.push(node);
2484 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>> {
2485 let mut nodes = Vec::new();
2486 let chan_count = Rc::new(RefCell::new(0));
2487 let payment_count = Rc::new(RefCell::new(0));
2488 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2490 for i in 0..node_count {
2491 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2493 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2494 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2495 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2496 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2497 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2498 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2499 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2500 connect_style: Rc::clone(&connect_style),
2501 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2505 for i in 0..node_count {
2506 for j in (i+1)..node_count {
2507 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();
2508 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();
2515 // Note that the following only works for CLTV values up to 128
2516 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2518 #[derive(PartialEq)]
2519 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2520 /// Tests that the given node has broadcast transactions for the given Channel
2522 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2523 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2524 /// broadcast and the revoked outputs were claimed.
2526 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2527 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2529 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2531 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> {
2532 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2533 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2535 let mut res = Vec::with_capacity(2);
2536 node_txn.retain(|tx| {
2537 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2538 check_spends!(tx, chan.3);
2539 if commitment_tx.is_none() {
2540 res.push(tx.clone());
2545 if let Some(explicit_tx) = commitment_tx {
2546 res.push(explicit_tx.clone());
2549 assert_eq!(res.len(), 1);
2551 if has_htlc_tx != HTLCType::NONE {
2552 node_txn.retain(|tx| {
2553 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2554 check_spends!(tx, res[0]);
2555 if has_htlc_tx == HTLCType::TIMEOUT {
2556 assert!(tx.lock_time.0 != 0);
2558 assert!(tx.lock_time.0 == 0);
2560 res.push(tx.clone());
2564 assert!(res.len() == 2 || res.len() == 3);
2566 assert_eq!(res[1], res[2]);
2570 assert!(node_txn.is_empty());
2574 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2575 /// HTLC transaction.
2576 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2577 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2578 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2579 // for revoked htlc outputs
2580 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2581 node_txn.retain(|tx| {
2582 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2583 check_spends!(tx, revoked_tx);
2587 node_txn.retain(|tx| {
2588 check_spends!(tx, commitment_revoked_tx);
2591 assert!(node_txn.is_empty());
2594 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2595 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2597 assert!(node_txn.len() >= 1);
2598 assert_eq!(node_txn[0].input.len(), 1);
2599 let mut found_prev = false;
2601 for tx in prev_txn {
2602 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2603 check_spends!(node_txn[0], tx);
2604 let mut iter = node_txn[0].input[0].witness.iter();
2605 iter.next().expect("expected 3 witness items");
2606 iter.next().expect("expected 3 witness items");
2607 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2608 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2614 assert!(found_prev);
2616 let mut res = Vec::new();
2617 mem::swap(&mut *node_txn, &mut res);
2621 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) {
2622 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2623 assert_eq!(events_1.len(), 2);
2624 let as_update = match events_1[0] {
2625 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2628 _ => panic!("Unexpected event"),
2631 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2632 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2633 assert_eq!(msg.data, expected_error);
2634 if needs_err_handle {
2635 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2638 _ => panic!("Unexpected event"),
2641 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2642 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2643 let bs_update = match events_2[0] {
2644 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2647 _ => panic!("Unexpected event"),
2649 if !needs_err_handle {
2651 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2652 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2653 assert_eq!(msg.data, expected_error);
2655 _ => panic!("Unexpected event"),
2660 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2661 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2665 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2666 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2670 macro_rules! get_channel_value_stat {
2671 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2672 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2673 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2674 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2675 chan.get_value_stat()
2679 macro_rules! get_chan_reestablish_msgs {
2680 ($src_node: expr, $dst_node: expr) => {
2682 let mut announcements = $crate::prelude::HashSet::new();
2683 let mut res = Vec::with_capacity(1);
2684 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2685 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2686 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2687 res.push(msg.clone());
2688 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2689 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2690 announcements.insert(msg.contents.short_channel_id);
2692 panic!("Unexpected event")
2695 for chan in $src_node.node.list_channels() {
2696 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2697 if let Some(scid) = chan.short_channel_id {
2698 assert!(announcements.remove(&scid));
2702 assert!(announcements.is_empty());
2708 macro_rules! handle_chan_reestablish_msgs {
2709 ($src_node: expr, $dst_node: expr) => {
2711 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2713 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2715 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2721 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2723 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2726 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2727 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2728 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2730 had_channel_update = true;
2733 let mut revoke_and_ack = None;
2734 let mut commitment_update = None;
2735 let order = if let Some(ev) = msg_events.get(idx) {
2737 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2738 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2739 revoke_and_ack = Some(msg.clone());
2741 RAACommitmentOrder::RevokeAndACKFirst
2743 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2744 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2745 commitment_update = Some(updates.clone());
2747 RAACommitmentOrder::CommitmentFirst
2749 _ => RAACommitmentOrder::CommitmentFirst,
2752 RAACommitmentOrder::CommitmentFirst
2755 if let Some(ev) = msg_events.get(idx) {
2757 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2758 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2759 assert!(revoke_and_ack.is_none());
2760 revoke_and_ack = Some(msg.clone());
2763 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2764 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2765 assert!(commitment_update.is_none());
2766 commitment_update = Some(updates.clone());
2773 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, .. }) = msg_events.get(idx) {
2774 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2776 assert!(!had_channel_update);
2779 assert_eq!(msg_events.len(), idx);
2781 (channel_ready, revoke_and_ack, commitment_update, order)
2786 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2787 /// for claims/fails they are separated out.
2788 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)) {
2789 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();
2790 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2791 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();
2792 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2794 if send_channel_ready.0 {
2795 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2797 for reestablish in reestablish_1.iter() {
2798 assert_eq!(reestablish.next_remote_commitment_number, 0);
2801 if send_channel_ready.1 {
2802 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2804 for reestablish in reestablish_2.iter() {
2805 assert_eq!(reestablish.next_remote_commitment_number, 0);
2808 if send_channel_ready.0 || send_channel_ready.1 {
2809 // If we expect any channel_ready's, both sides better have set
2810 // next_holder_commitment_number to 1
2811 for reestablish in reestablish_1.iter() {
2812 assert_eq!(reestablish.next_local_commitment_number, 1);
2814 for reestablish in reestablish_2.iter() {
2815 assert_eq!(reestablish.next_local_commitment_number, 1);
2819 let mut resp_1 = Vec::new();
2820 for msg in reestablish_1 {
2821 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2822 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2824 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2825 check_added_monitors!(node_b, 1);
2827 check_added_monitors!(node_b, 0);
2830 let mut resp_2 = Vec::new();
2831 for msg in reestablish_2 {
2832 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2833 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2835 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2836 check_added_monitors!(node_a, 1);
2838 check_added_monitors!(node_a, 0);
2841 // We don't yet support both needing updates, as that would require a different commitment dance:
2842 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2843 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2844 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2845 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2847 for chan_msgs in resp_1.drain(..) {
2848 if send_channel_ready.0 {
2849 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2850 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2851 if !announcement_event.is_empty() {
2852 assert_eq!(announcement_event.len(), 1);
2853 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2854 //TODO: Test announcement_sigs re-sending
2855 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2858 assert!(chan_msgs.0.is_none());
2861 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2862 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2863 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2864 check_added_monitors!(node_a, 1);
2866 assert!(chan_msgs.1.is_none());
2868 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 {
2869 let commitment_update = chan_msgs.2.unwrap();
2870 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2871 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2873 assert!(commitment_update.update_add_htlcs.is_empty());
2875 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2876 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2877 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2878 for update_add in commitment_update.update_add_htlcs {
2879 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2881 for update_fulfill in commitment_update.update_fulfill_htlcs {
2882 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2884 for update_fail in commitment_update.update_fail_htlcs {
2885 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2888 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2889 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2891 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2892 check_added_monitors!(node_a, 1);
2893 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2894 // No commitment_signed so get_event_msg's assert(len == 1) passes
2895 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2896 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2897 check_added_monitors!(node_b, 1);
2900 assert!(chan_msgs.2.is_none());
2904 for chan_msgs in resp_2.drain(..) {
2905 if send_channel_ready.1 {
2906 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2907 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2908 if !announcement_event.is_empty() {
2909 assert_eq!(announcement_event.len(), 1);
2910 match announcement_event[0] {
2911 MessageSendEvent::SendChannelUpdate { .. } => {},
2912 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2913 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2917 assert!(chan_msgs.0.is_none());
2920 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2921 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2922 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2923 check_added_monitors!(node_b, 1);
2925 assert!(chan_msgs.1.is_none());
2927 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 {
2928 let commitment_update = chan_msgs.2.unwrap();
2929 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2930 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2932 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2933 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2934 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2935 for update_add in commitment_update.update_add_htlcs {
2936 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2938 for update_fulfill in commitment_update.update_fulfill_htlcs {
2939 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2941 for update_fail in commitment_update.update_fail_htlcs {
2942 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2945 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2946 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2948 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2949 check_added_monitors!(node_b, 1);
2950 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2951 // No commitment_signed so get_event_msg's assert(len == 1) passes
2952 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2953 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2954 check_added_monitors!(node_a, 1);
2957 assert!(chan_msgs.2.is_none());