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::ln::{PaymentPreimage, PaymentHash, PaymentSecret};
17 use crate::ln::channelmanager::{ChainParameters, ChannelManager, ChannelManagerReadArgs, RAACommitmentOrder, PaymentSendFailure, PaymentId, MIN_CLTV_EXPIRY_DELTA};
18 use crate::routing::gossip::{P2PGossipSync, NetworkGraph, NetworkUpdate};
19 use crate::routing::router::{PaymentParameters, Route, get_route};
20 use crate::ln::features::InitFeatures;
22 use crate::ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
23 use crate::util::enforcing_trait_impls::EnforcingSigner;
24 use crate::util::scid_utils;
25 use crate::util::test_utils;
26 use crate::util::test_utils::{panicking, TestChainMonitor};
27 use crate::util::events::{Event, HTLCDestination, MessageSendEvent, MessageSendEventsProvider, PaymentPurpose};
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};
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
65 pub fn mine_transaction<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction) {
66 let height = node.best_block_info().1 + 1;
67 confirm_transaction_at(node, tx, height);
69 /// Mine a single block containing the given transactions
70 pub fn mine_transactions<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction]) {
71 let height = node.best_block_info().1 + 1;
72 confirm_transactions_at(node, txn, height);
74 /// Mine the given transaction at the given height, mining blocks as required to build to that
77 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
78 /// output is the 1st output in the transaction.
79 pub fn confirm_transactions_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, txn: &[&Transaction], conf_height: u32) -> u64 {
80 let first_connect_height = node.best_block_info().1 + 1;
81 assert!(first_connect_height <= conf_height);
82 if conf_height > first_connect_height {
83 connect_blocks(node, conf_height - first_connect_height);
85 let mut block = Block {
86 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
89 for _ in 0..*node.network_chan_count.borrow() { // Make sure we don't end up with channels at the same short id by offsetting by chan_count
90 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
93 block.txdata.push((*tx).clone());
95 connect_block(node, &block);
96 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
98 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
99 confirm_transactions_at(node, &[tx], conf_height)
102 /// The possible ways we may notify a ChannelManager of a new block
103 #[derive(Clone, Copy, Debug, PartialEq)]
104 pub enum ConnectStyle {
105 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
106 /// the header and height information.
108 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
109 /// make a single `best_block_updated` call.
110 BestBlockFirstSkippingBlocks,
111 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
112 /// `transaction_unconfirmed` is called.
113 BestBlockFirstReorgsOnlyTip,
114 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
115 /// the header and height information.
117 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
118 /// make a single `best_block_updated` call.
119 TransactionsFirstSkippingBlocks,
120 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
121 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
122 /// times to ensure it's idempotent.
123 TransactionsDuplicativelyFirstSkippingBlocks,
124 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
125 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
126 /// times to ensure it's idempotent.
127 HighlyRedundantTransactionsFirstSkippingBlocks,
128 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
129 /// `transaction_unconfirmed` is called.
130 TransactionsFirstReorgsOnlyTip,
131 /// Provides the full block via the `chain::Listen` interface. In the current code this is
132 /// equivalent to `TransactionsFirst` with some additional assertions.
137 fn random_style() -> ConnectStyle {
138 #[cfg(feature = "std")] {
139 use core::hash::{BuildHasher, Hasher};
140 // Get a random value using the only std API to do so - the DefaultHasher
141 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
142 let res = match rand_val % 9 {
143 0 => ConnectStyle::BestBlockFirst,
144 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
145 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
146 3 => ConnectStyle::TransactionsFirst,
147 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
148 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
149 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
150 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
151 8 => ConnectStyle::FullBlockViaListen,
154 eprintln!("Using Block Connection Style: {:?}", res);
157 #[cfg(not(feature = "std"))] {
158 ConnectStyle::FullBlockViaListen
163 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
164 let skip_intermediaries = match *node.connect_style.borrow() {
165 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
166 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
167 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
171 let height = node.best_block_info().1 + 1;
172 let mut block = Block {
173 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
178 let prev_blockhash = block.header.block_hash();
179 do_connect_block(node, block, skip_intermediaries);
181 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
185 let hash = block.header.block_hash();
186 do_connect_block(node, block, false);
190 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
191 do_connect_block(node, block.clone(), false);
194 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
195 // Ensure `get_claimable_balances`' self-tests never panic
196 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
197 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
201 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
202 call_claimable_balances(node);
203 let height = node.best_block_info().1 + 1;
204 #[cfg(feature = "std")] {
205 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
207 if !skip_intermediaries {
208 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
209 match *node.connect_style.borrow() {
210 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
211 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
212 call_claimable_balances(node);
213 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
214 node.node.best_block_updated(&block.header, height);
215 node.node.transactions_confirmed(&block.header, &txdata, height);
217 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
218 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
219 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
220 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
221 let mut connections = Vec::new();
222 for (block, height) in node.blocks.lock().unwrap().iter() {
223 if !block.txdata.is_empty() {
224 // Reconnect all transactions we've ever seen to ensure transaction connection
225 // is *really* idempotent. This is a somewhat likely deployment for some
226 // esplora implementations of chain sync which try to reduce state and
227 // complexity as much as possible.
229 // Sadly we have to clone the block here to maintain lockorder. In the
230 // future we should consider Arc'ing the blocks to avoid this.
231 connections.push((block.clone(), *height));
234 for (old_block, height) in connections {
235 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
236 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
239 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
240 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
241 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
243 call_claimable_balances(node);
244 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
245 node.node.transactions_confirmed(&block.header, &txdata, height);
246 node.node.best_block_updated(&block.header, height);
248 ConnectStyle::FullBlockViaListen => {
249 node.chain_monitor.chain_monitor.block_connected(&block, height);
250 node.node.block_connected(&block, height);
254 call_claimable_balances(node);
255 node.node.test_process_background_events();
256 node.blocks.lock().unwrap().push((block, height));
259 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
260 call_claimable_balances(node);
261 #[cfg(feature = "std")] {
262 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
265 let orig = node.blocks.lock().unwrap().pop().unwrap();
266 assert!(orig.1 > 0); // Cannot disconnect genesis
267 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
269 match *node.connect_style.borrow() {
270 ConnectStyle::FullBlockViaListen => {
271 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
272 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
274 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
275 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
277 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
278 node.node.best_block_updated(&prev.0.header, prev.1);
281 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
282 for tx in orig.0.txdata {
283 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
284 node.node.transaction_unconfirmed(&tx.txid());
288 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
289 node.node.best_block_updated(&prev.0.header, prev.1);
292 call_claimable_balances(node);
296 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
297 let count = node.blocks.lock().unwrap().len() as u32 - 1;
298 disconnect_blocks(node, count);
301 pub struct TestChanMonCfg {
302 pub tx_broadcaster: test_utils::TestBroadcaster,
303 pub fee_estimator: test_utils::TestFeeEstimator,
304 pub chain_source: test_utils::TestChainSource,
305 pub persister: test_utils::TestPersister,
306 pub logger: test_utils::TestLogger,
307 pub keys_manager: test_utils::TestKeysInterface,
310 pub struct NodeCfg<'a> {
311 pub chain_source: &'a test_utils::TestChainSource,
312 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
313 pub fee_estimator: &'a test_utils::TestFeeEstimator,
314 pub router: test_utils::TestRouter<'a>,
315 pub chain_monitor: test_utils::TestChainMonitor<'a>,
316 pub keys_manager: &'a test_utils::TestKeysInterface,
317 pub logger: &'a test_utils::TestLogger,
318 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
319 pub node_seed: [u8; 32],
320 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
323 pub struct Node<'a, 'b: 'a, 'c: 'b> {
324 pub chain_source: &'c test_utils::TestChainSource,
325 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
326 pub fee_estimator: &'c test_utils::TestFeeEstimator,
327 pub router: &'b test_utils::TestRouter<'c>,
328 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
329 pub keys_manager: &'b test_utils::TestKeysInterface,
330 pub node: &'a 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>,
331 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
332 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
333 pub node_seed: [u8; 32],
334 pub network_payment_count: Rc<RefCell<u8>>,
335 pub network_chan_count: Rc<RefCell<u32>>,
336 pub logger: &'c test_utils::TestLogger,
337 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
338 pub connect_style: Rc<RefCell<ConnectStyle>>,
339 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
341 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
342 pub fn best_block_hash(&self) -> BlockHash {
343 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
345 pub fn best_block_info(&self) -> (BlockHash, u32) {
346 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
348 pub fn get_block_header(&self, height: u32) -> BlockHeader {
349 self.blocks.lock().unwrap()[height as usize].0.header
353 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
356 // Check that we processed all pending events
357 let msg_events = self.node.get_and_clear_pending_msg_events();
358 if !msg_events.is_empty() {
359 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
361 let events = self.node.get_and_clear_pending_events();
362 if !events.is_empty() {
363 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
365 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
366 if !added_monitors.is_empty() {
367 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
370 // Check that if we serialize the network graph, we can deserialize it again.
371 let network_graph = {
372 let mut w = test_utils::TestVecWriter(Vec::new());
373 self.network_graph.write(&mut w).unwrap();
374 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
375 assert!(network_graph_deser == *self.network_graph);
376 let gossip_sync = P2PGossipSync::new(
377 &network_graph_deser, Some(self.chain_source), self.logger
379 let mut chan_progress = 0;
381 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
382 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
383 assert!(orig_announcements == deserialized_announcements);
384 chan_progress = match orig_announcements {
385 Some(announcement) => announcement.0.contents.short_channel_id + 1,
389 let mut node_progress = None;
391 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
392 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
393 assert!(orig_announcements == deserialized_announcements);
394 node_progress = match orig_announcements {
395 Some(announcement) => Some(announcement.contents.node_id),
402 // Check that if we serialize and then deserialize all our channel monitors we get the
403 // same set of outputs to watch for on chain as we have now. Note that if we write
404 // tests that fully close channels and remove the monitors at some point this may break.
405 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
406 let mut deserialized_monitors = Vec::new();
408 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
409 let mut w = test_utils::TestVecWriter(Vec::new());
410 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
411 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
412 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
413 deserialized_monitors.push(deserialized_monitor);
417 let broadcaster = test_utils::TestBroadcaster {
418 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
419 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
422 // Before using all the new monitors to check the watch outpoints, use the full set of
423 // them to ensure we can write and reload our ChannelManager.
425 let mut channel_monitors = HashMap::new();
426 for monitor in deserialized_monitors.iter_mut() {
427 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
430 let mut w = test_utils::TestVecWriter(Vec::new());
431 self.node.write(&mut w).unwrap();
432 <(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 {
433 default_config: *self.node.get_current_default_configuration(),
434 entropy_source: self.keys_manager,
435 node_signer: self.keys_manager,
436 signer_provider: self.keys_manager,
437 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
438 router: &test_utils::TestRouter::new(Arc::new(network_graph)),
439 chain_monitor: self.chain_monitor,
440 tx_broadcaster: &broadcaster,
441 logger: &self.logger,
446 let persister = test_utils::TestPersister::new();
447 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
448 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
449 for deserialized_monitor in deserialized_monitors.drain(..) {
450 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
454 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
455 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
460 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) {
461 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
464 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) {
465 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
466 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
467 (announcement, as_update, bs_update, channel_id, tx)
471 /// Gets an RAA and CS which were sent in response to a commitment update
472 macro_rules! get_revoke_commit_msgs {
473 ($node: expr, $node_id: expr) => {
475 use $crate::util::events::MessageSendEvent;
476 let events = $node.node.get_and_clear_pending_msg_events();
477 assert_eq!(events.len(), 2);
479 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
480 assert_eq!(*node_id, $node_id);
483 _ => panic!("Unexpected event"),
485 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
486 assert_eq!(*node_id, $node_id);
487 assert!(updates.update_add_htlcs.is_empty());
488 assert!(updates.update_fulfill_htlcs.is_empty());
489 assert!(updates.update_fail_htlcs.is_empty());
490 assert!(updates.update_fail_malformed_htlcs.is_empty());
491 assert!(updates.update_fee.is_none());
492 updates.commitment_signed.clone()
494 _ => panic!("Unexpected event"),
500 /// Get an specific event message from the pending events queue.
502 macro_rules! get_event_msg {
503 ($node: expr, $event_type: path, $node_id: expr) => {
505 let events = $node.node.get_and_clear_pending_msg_events();
506 assert_eq!(events.len(), 1);
508 $event_type { ref node_id, ref msg } => {
509 assert_eq!(*node_id, $node_id);
512 _ => panic!("Unexpected event"),
518 /// Get an error message from the pending events queue.
520 macro_rules! get_err_msg {
521 ($node: expr, $node_id: expr) => {
523 let events = $node.node.get_and_clear_pending_msg_events();
524 assert_eq!(events.len(), 1);
526 $crate::util::events::MessageSendEvent::HandleError {
527 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
529 assert_eq!(*node_id, $node_id);
532 _ => panic!("Unexpected event"),
538 /// Get a specific event from the pending events queue.
540 macro_rules! get_event {
541 ($node: expr, $event_type: path) => {
543 let mut events = $node.node.get_and_clear_pending_events();
544 assert_eq!(events.len(), 1);
545 let ev = events.pop().unwrap();
547 $event_type { .. } => {
550 _ => panic!("Unexpected event"),
557 /// Gets an UpdateHTLCs MessageSendEvent
558 macro_rules! get_htlc_update_msgs {
559 ($node: expr, $node_id: expr) => {
561 let events = $node.node.get_and_clear_pending_msg_events();
562 assert_eq!(events.len(), 1);
564 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
565 assert_eq!(*node_id, $node_id);
568 _ => panic!("Unexpected event"),
574 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
575 /// Returns the `msg_event`.
577 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
578 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
579 /// such messages are intended to all peers.
580 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
581 let ev_index = msg_events.iter().position(|e| { match e {
582 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
583 node_id == msg_node_id
585 MessageSendEvent::SendOpenChannel { node_id, .. } => {
586 node_id == msg_node_id
588 MessageSendEvent::SendFundingCreated { node_id, .. } => {
589 node_id == msg_node_id
591 MessageSendEvent::SendFundingSigned { node_id, .. } => {
592 node_id == msg_node_id
594 MessageSendEvent::SendChannelReady { node_id, .. } => {
595 node_id == msg_node_id
597 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
598 node_id == msg_node_id
600 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
601 node_id == msg_node_id
603 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
604 node_id == msg_node_id
606 MessageSendEvent::SendClosingSigned { node_id, .. } => {
607 node_id == msg_node_id
609 MessageSendEvent::SendShutdown { node_id, .. } => {
610 node_id == msg_node_id
612 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
613 node_id == msg_node_id
615 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
616 node_id == msg_node_id
618 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
621 MessageSendEvent::BroadcastChannelUpdate { .. } => {
624 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
627 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
628 node_id == msg_node_id
630 MessageSendEvent::HandleError { node_id, .. } => {
631 node_id == msg_node_id
633 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
634 node_id == msg_node_id
636 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
637 node_id == msg_node_id
639 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
640 node_id == msg_node_id
642 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
643 node_id == msg_node_id
646 if ev_index.is_some() {
647 msg_events.remove(ev_index.unwrap())
649 panic!("Couldn't find any MessageSendEvent to the node!")
654 macro_rules! get_channel_ref {
655 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
657 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
658 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
659 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
665 macro_rules! get_feerate {
666 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
668 let mut per_peer_state_lock;
669 let mut peer_state_lock;
670 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
677 macro_rules! get_opt_anchors {
678 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
680 let mut per_peer_state_lock;
681 let mut peer_state_lock;
682 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
688 /// Returns a channel monitor given a channel id, making some naive assumptions
690 macro_rules! get_monitor {
691 ($node: expr, $channel_id: expr) => {
693 use bitcoin::hashes::Hash;
694 let mut monitor = None;
695 // Assume funding vout is either 0 or 1 blindly
697 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
698 $crate::chain::transaction::OutPoint {
699 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
711 /// Returns any local commitment transactions for the channel.
713 macro_rules! get_local_commitment_txn {
714 ($node: expr, $channel_id: expr) => {
716 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
721 /// Check the error from attempting a payment.
723 macro_rules! unwrap_send_err {
724 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
726 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
727 assert_eq!(fails.len(), 1);
733 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
734 assert_eq!(results.len(), 1);
736 Err($type) => { $check },
745 /// Check whether N channel monitor(s) have been added.
747 macro_rules! check_added_monitors {
748 ($node: expr, $count: expr) => {
750 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
751 assert_eq!(added_monitors.len(), $count);
752 added_monitors.clear();
757 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> {
758 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
759 for encoded in monitors_encoded {
760 let mut monitor_read = &encoded[..];
761 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
762 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
763 assert!(monitor_read.is_empty());
764 monitors_read.push(monitor);
767 let mut node_read = &chanman_encoded[..];
768 let (_, node_deserialized) = {
769 let mut channel_monitors = HashMap::new();
770 for monitor in monitors_read.iter_mut() {
771 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
773 <(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 {
775 entropy_source: node.keys_manager,
776 node_signer: node.keys_manager,
777 signer_provider: node.keys_manager,
778 fee_estimator: node.fee_estimator,
780 chain_monitor: node.chain_monitor,
781 tx_broadcaster: node.tx_broadcaster,
786 assert!(node_read.is_empty());
788 for monitor in monitors_read.drain(..) {
789 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
790 ChannelMonitorUpdateStatus::Completed);
791 check_added_monitors!(node, 1);
798 macro_rules! reload_node {
799 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
800 let chanman_encoded = $chanman_encoded;
802 $persister = test_utils::TestPersister::new();
803 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
804 $node.chain_monitor = &$new_chain_monitor;
806 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
807 $node.node = &$new_channelmanager;
809 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
810 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
814 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) {
815 let chan_id = *node.network_chan_count.borrow();
817 let events = node.node.get_and_clear_pending_events();
818 assert_eq!(events.len(), 1);
820 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
821 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
822 assert_eq!(*channel_value_satoshis, expected_chan_value);
823 assert_eq!(user_channel_id, expected_user_chan_id);
825 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
826 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
828 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
829 (*temporary_channel_id, tx, funding_outpoint)
831 _ => panic!("Unexpected event"),
834 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 {
835 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
836 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
838 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
839 check_added_monitors!(node_a, 0);
841 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
842 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
843 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
845 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
846 assert_eq!(added_monitors.len(), 1);
847 assert_eq!(added_monitors[0].0, funding_output);
848 added_monitors.clear();
851 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()));
853 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
854 assert_eq!(added_monitors.len(), 1);
855 assert_eq!(added_monitors[0].0, funding_output);
856 added_monitors.clear();
859 let events_4 = node_a.node.get_and_clear_pending_events();
860 assert_eq!(events_4.len(), 0);
862 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
863 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
864 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
866 // Ensure that funding_transaction_generated is idempotent.
867 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
868 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
869 check_added_monitors!(node_a, 0);
874 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
875 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]) {
876 let initiator_channels = initiator.node.list_usable_channels().len();
877 let receiver_channels = receiver.node.list_usable_channels().len();
879 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
880 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
882 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
883 let events = receiver.node.get_and_clear_pending_events();
884 assert_eq!(events.len(), 1);
886 Event::OpenChannelRequest { temporary_channel_id, .. } => {
887 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
889 _ => panic!("Unexpected event"),
892 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
893 assert_eq!(accept_channel.minimum_depth, 0);
894 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
896 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
897 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
898 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
900 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
901 check_added_monitors!(receiver, 1);
902 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
903 assert_eq!(bs_signed_locked.len(), 2);
904 let as_channel_ready;
905 match &bs_signed_locked[0] {
906 MessageSendEvent::SendFundingSigned { node_id, msg } => {
907 assert_eq!(*node_id, initiator.node.get_our_node_id());
908 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
909 check_added_monitors!(initiator, 1);
911 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
912 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
914 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
916 _ => panic!("Unexpected event"),
918 match &bs_signed_locked[1] {
919 MessageSendEvent::SendChannelReady { node_id, msg } => {
920 assert_eq!(*node_id, initiator.node.get_our_node_id());
921 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
923 _ => panic!("Unexpected event"),
926 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
928 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
929 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
931 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
932 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
934 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
935 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
937 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
938 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
940 (tx, as_channel_ready.channel_id)
943 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 {
944 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
945 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
946 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
947 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
948 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
949 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
950 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
951 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
952 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
954 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
957 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) {
958 confirm_transaction_at(node_conf, tx, conf_height);
959 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
960 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()));
963 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]) {
965 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
966 assert_eq!(events_6.len(), 3);
967 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
968 assert_eq!(*node_id, node_recv.node.get_our_node_id());
970 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
971 assert_eq!(*node_id, node_recv.node.get_our_node_id());
973 } else { panic!("Unexpected event: {:?}", events_6[1]); };
974 ((match events_6[0] {
975 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
976 channel_id = msg.channel_id.clone();
977 assert_eq!(*node_id, node_recv.node.get_our_node_id());
980 _ => panic!("Unexpected event"),
981 }, match events_6[announcement_sigs_idx] {
982 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
983 assert_eq!(*node_id, node_recv.node.get_our_node_id());
986 _ => panic!("Unexpected event"),
990 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]) {
991 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
992 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
993 confirm_transaction_at(node_a, tx, conf_height);
994 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
995 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
996 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
999 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) {
1000 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1001 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1005 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) {
1006 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1007 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1008 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1010 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1011 assert_eq!(events_7.len(), 1);
1012 let (announcement, bs_update) = match events_7[0] {
1013 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1014 (msg, update_msg.clone().unwrap())
1016 _ => panic!("Unexpected event"),
1019 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1020 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1021 assert_eq!(events_8.len(), 1);
1022 let as_update = match events_8[0] {
1023 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1024 assert!(*announcement == *msg);
1025 let update_msg = update_msg.clone().unwrap();
1026 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1027 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1030 _ => panic!("Unexpected event"),
1033 *node_a.network_chan_count.borrow_mut() += 1;
1035 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1036 ((*announcement).clone(), as_update, bs_update)
1039 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) {
1040 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1043 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) {
1044 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1045 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1046 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1049 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) {
1050 let mut no_announce_cfg = test_default_channel_config();
1051 no_announce_cfg.channel_handshake_config.announced_channel = false;
1052 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1053 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1054 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1055 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1056 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1058 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1059 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1060 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()));
1061 check_added_monitors!(nodes[b], 1);
1063 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1064 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1065 check_added_monitors!(nodes[a], 1);
1067 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1068 confirm_transaction_at(&nodes[a], &tx, conf_height);
1069 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1070 confirm_transaction_at(&nodes[b], &tx, conf_height);
1071 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1072 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1073 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()));
1074 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1075 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1076 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1077 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1078 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1080 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1081 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1083 let mut found_a = false;
1084 for chan in nodes[a].node.list_usable_channels() {
1085 if chan.channel_id == as_channel_ready.channel_id {
1088 assert!(!chan.is_public);
1093 let mut found_b = false;
1094 for chan in nodes[b].node.list_usable_channels() {
1095 if chan.channel_id == as_channel_ready.channel_id {
1098 assert!(!chan.is_public);
1103 (as_channel_ready, tx)
1106 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) {
1108 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1109 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1110 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1112 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1113 // forwarding info for local channels even if its not accepted in the network graph.
1114 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1115 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1120 macro_rules! check_spends {
1121 ($tx: expr, $($spends_txn: expr),*) => {
1124 for outp in $spends_txn.output.iter() {
1125 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1128 for outp in $tx.output.iter() {
1129 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1131 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1133 if out_point.txid == $spends_txn.txid() {
1134 return $spends_txn.output.get(out_point.vout as usize).cloned()
1139 let mut total_value_in = 0;
1140 for input in $tx.input.iter() {
1141 total_value_in += get_output(&input.previous_output).unwrap().value;
1143 let mut total_value_out = 0;
1144 for output in $tx.output.iter() {
1145 total_value_out += output.value;
1147 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1148 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1149 assert!(total_value_out + min_fee <= total_value_in);
1150 $tx.verify(get_output).unwrap();
1155 macro_rules! get_closing_signed_broadcast {
1156 ($node: expr, $dest_pubkey: expr) => {
1158 let events = $node.get_and_clear_pending_msg_events();
1159 assert!(events.len() == 1 || events.len() == 2);
1160 (match events[events.len() - 1] {
1161 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1162 assert_eq!(msg.contents.flags & 2, 2);
1165 _ => panic!("Unexpected event"),
1166 }, if events.len() == 2 {
1168 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1169 assert_eq!(*node_id, $dest_pubkey);
1172 _ => panic!("Unexpected event"),
1180 macro_rules! check_warn_msg {
1181 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1182 let msg_events = $node.node.get_and_clear_pending_msg_events();
1183 assert_eq!(msg_events.len(), 1);
1184 match msg_events[0] {
1185 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1186 assert_eq!(node_id, $recipient_node_id);
1187 assert_eq!(msg.channel_id, $chan_id);
1190 _ => panic!("Unexpected event"),
1195 /// Check that a channel's closing channel update has been broadcasted, and optionally
1196 /// check whether an error message event has occurred.
1198 macro_rules! check_closed_broadcast {
1199 ($node: expr, $with_error_msg: expr) => {{
1200 use $crate::util::events::MessageSendEvent;
1201 use $crate::ln::msgs::ErrorAction;
1203 let msg_events = $node.node.get_and_clear_pending_msg_events();
1204 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1205 match msg_events[0] {
1206 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1207 assert_eq!(msg.contents.flags & 2, 2);
1209 _ => panic!("Unexpected event"),
1211 if $with_error_msg {
1212 match msg_events[1] {
1213 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1214 // TODO: Check node_id
1217 _ => panic!("Unexpected event"),
1223 /// Check that a channel's closing channel events has been issued
1225 macro_rules! check_closed_event {
1226 ($node: expr, $events: expr, $reason: expr) => {
1227 check_closed_event!($node, $events, $reason, false);
1229 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1230 use $crate::util::events::Event;
1232 let events = $node.node.get_and_clear_pending_events();
1233 assert_eq!(events.len(), $events, "{:?}", events);
1234 let expected_reason = $reason;
1235 let mut issues_discard_funding = false;
1236 for event in events {
1238 Event::ChannelClosed { ref reason, .. } => {
1239 assert_eq!(*reason, expected_reason);
1241 Event::DiscardFunding { .. } => {
1242 issues_discard_funding = true;
1244 _ => panic!("Unexpected event"),
1247 assert_eq!($is_check_discard_funding, issues_discard_funding);
1251 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) {
1252 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) };
1253 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) };
1256 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1257 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1259 let events_1 = node_b.get_and_clear_pending_msg_events();
1260 assert!(events_1.len() >= 1);
1261 let shutdown_b = match events_1[0] {
1262 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1263 assert_eq!(node_id, &node_a.get_our_node_id());
1266 _ => panic!("Unexpected event"),
1269 let closing_signed_b = if !close_inbound_first {
1270 assert_eq!(events_1.len(), 1);
1273 Some(match events_1[1] {
1274 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1275 assert_eq!(node_id, &node_a.get_our_node_id());
1278 _ => panic!("Unexpected event"),
1282 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1283 let (as_update, bs_update) = if close_inbound_first {
1284 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1285 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1287 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1288 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1289 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1290 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1292 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1293 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1294 assert!(none_a.is_none());
1295 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1296 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1297 (as_update, bs_update)
1299 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1301 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1302 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1304 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1305 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1306 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1308 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1309 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1310 assert!(none_b.is_none());
1311 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1312 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1313 (as_update, bs_update)
1315 assert_eq!(tx_a, tx_b);
1316 check_spends!(tx_a, funding_tx);
1318 (as_update, bs_update, tx_a)
1321 pub struct SendEvent {
1322 pub node_id: PublicKey,
1323 pub msgs: Vec<msgs::UpdateAddHTLC>,
1324 pub commitment_msg: msgs::CommitmentSigned,
1327 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1328 assert!(updates.update_fulfill_htlcs.is_empty());
1329 assert!(updates.update_fail_htlcs.is_empty());
1330 assert!(updates.update_fail_malformed_htlcs.is_empty());
1331 assert!(updates.update_fee.is_none());
1332 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1335 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1337 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1338 _ => panic!("Unexpected event type!"),
1342 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1343 let mut events = node.node.get_and_clear_pending_msg_events();
1344 assert_eq!(events.len(), 1);
1345 SendEvent::from_event(events.pop().unwrap())
1350 macro_rules! expect_pending_htlcs_forwardable_conditions {
1351 ($node: expr, $expected_failures: expr) => {{
1352 let expected_failures = $expected_failures;
1353 let events = $node.node.get_and_clear_pending_events();
1355 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1356 _ => panic!("Unexpected event {:?}", events),
1359 let count = expected_failures.len() + 1;
1360 assert_eq!(events.len(), count);
1362 if expected_failures.len() > 0 {
1363 expect_htlc_handling_failed_destinations!(events, expected_failures)
1369 macro_rules! expect_htlc_handling_failed_destinations {
1370 ($events: expr, $expected_failures: expr) => {{
1371 for event in $events {
1373 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1374 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1375 assert!($expected_failures.contains(&failed_next_destination))
1377 _ => panic!("Unexpected destination"),
1384 /// Clears (and ignores) a PendingHTLCsForwardable event
1385 macro_rules! expect_pending_htlcs_forwardable_ignore {
1387 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1392 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1393 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1394 ($node: expr, $expected_failures: expr) => {{
1395 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1400 /// Handles a PendingHTLCsForwardable event
1401 macro_rules! expect_pending_htlcs_forwardable {
1403 expect_pending_htlcs_forwardable_ignore!($node);
1404 $node.node.process_pending_htlc_forwards();
1406 // Ensure process_pending_htlc_forwards is idempotent.
1407 $node.node.process_pending_htlc_forwards();
1412 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1413 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1414 ($node: expr, $expected_failures: expr) => {{
1415 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1416 $node.node.process_pending_htlc_forwards();
1418 // Ensure process_pending_htlc_forwards is idempotent.
1419 $node.node.process_pending_htlc_forwards();
1424 macro_rules! expect_pending_htlcs_forwardable_from_events {
1425 ($node: expr, $events: expr, $ignore: expr) => {{
1426 assert_eq!($events.len(), 1);
1428 Event::PendingHTLCsForwardable { .. } => { },
1429 _ => panic!("Unexpected event"),
1432 $node.node.process_pending_htlc_forwards();
1434 // Ensure process_pending_htlc_forwards is idempotent.
1435 $node.node.process_pending_htlc_forwards();
1441 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1442 /// commitment update.
1443 macro_rules! commitment_signed_dance {
1444 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1445 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1447 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1448 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1450 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1452 check_added_monitors!($node_a, 0);
1453 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1454 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1455 check_added_monitors!($node_a, 1);
1456 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1457 assert!(extra_msg_option.is_none());
1461 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1463 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1464 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1465 check_added_monitors!($node_a, 1);
1469 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1470 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1472 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1473 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1478 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1479 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1480 check_added_monitors!(node_b, 0);
1481 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1482 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1483 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1484 check_added_monitors!(node_b, 1);
1485 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1486 let (bs_revoke_and_ack, extra_msg_option) = {
1487 let mut events = node_b.node.get_and_clear_pending_msg_events();
1488 assert!(events.len() <= 2);
1489 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1490 (match node_a_event {
1491 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1492 assert_eq!(*node_id, node_a.node.get_our_node_id());
1495 _ => panic!("Unexpected event"),
1496 }, events.get(0).map(|e| e.clone()))
1498 check_added_monitors!(node_b, 1);
1500 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1501 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1503 (extra_msg_option, bs_revoke_and_ack)
1506 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1507 check_added_monitors!(node_a, 0);
1508 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1509 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1510 check_added_monitors!(node_a, 1);
1512 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1514 if skip_last_step { return; }
1517 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1518 vec![crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1519 check_added_monitors!(node_a, 1);
1521 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1522 let mut number_of_msg_events = 0;
1523 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1524 let peer_state = peer_state_mutex.lock().unwrap();
1525 let cp_pending_msg_events = &peer_state.pending_msg_events;
1526 number_of_msg_events += cp_pending_msg_events.len();
1527 if cp_pending_msg_events.len() == 1 {
1528 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1529 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1530 } else { panic!("Unexpected event"); }
1533 // Expecting the failure backwards event to the previous hop (not `node_b`)
1534 assert_eq!(number_of_msg_events, 1);
1536 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1540 /// Get a payment preimage and hash.
1542 macro_rules! get_payment_preimage_hash {
1543 ($dest_node: expr) => {
1545 get_payment_preimage_hash!($dest_node, None)
1548 ($dest_node: expr, $min_value_msat: expr) => {
1550 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1553 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1555 use bitcoin::hashes::Hash as _;
1556 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1557 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1558 *payment_count += 1;
1559 let payment_hash = $crate::ln::PaymentHash(
1560 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1561 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200, $min_final_cltv_expiry_delta).unwrap();
1562 (payment_preimage, payment_hash, payment_secret)
1568 macro_rules! get_route {
1569 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1570 use $crate::chain::keysinterface::EntropySource;
1571 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1572 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1573 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1574 $crate::routing::router::get_route(
1575 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1576 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1577 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1584 macro_rules! get_route_and_payment_hash {
1585 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1586 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1587 .with_features($recv_node.node.invoice_features());
1588 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1590 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1591 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1592 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1593 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1598 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1599 macro_rules! expect_payment_claimable {
1600 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1601 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1603 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1604 let events = $node.node.get_and_clear_pending_events();
1605 assert_eq!(events.len(), 1);
1607 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1608 assert_eq!($expected_payment_hash, *payment_hash);
1609 assert_eq!($expected_recv_value, amount_msat);
1610 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1612 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1613 assert_eq!(&$expected_payment_preimage, payment_preimage);
1614 assert_eq!($expected_payment_secret, *payment_secret);
1619 _ => panic!("Unexpected event"),
1625 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1626 macro_rules! expect_payment_claimed {
1627 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1628 let events = $node.node.get_and_clear_pending_events();
1629 assert_eq!(events.len(), 1);
1631 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1632 assert_eq!($expected_payment_hash, *payment_hash);
1633 assert_eq!($expected_recv_value, amount_msat);
1635 _ => panic!("Unexpected event"),
1642 macro_rules! expect_payment_sent_without_paths {
1643 ($node: expr, $expected_payment_preimage: expr) => {
1644 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1646 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1647 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1652 macro_rules! expect_payment_sent {
1653 ($node: expr, $expected_payment_preimage: expr) => {
1654 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1656 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1657 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1659 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1660 use bitcoin::hashes::Hash as _;
1661 let events = $node.node.get_and_clear_pending_events();
1662 let expected_payment_hash = $crate::ln::PaymentHash(
1663 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1665 assert!(events.len() > 1);
1667 assert_eq!(events.len(), 1);
1669 let expected_payment_id = match events[0] {
1670 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1671 assert_eq!($expected_payment_preimage, *payment_preimage);
1672 assert_eq!(expected_payment_hash, *payment_hash);
1673 assert!(fee_paid_msat.is_some());
1674 if $expected_fee_msat_opt.is_some() {
1675 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1679 _ => panic!("Unexpected event"),
1682 for i in 1..events.len() {
1684 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1685 assert_eq!(payment_id, expected_payment_id);
1686 assert_eq!(payment_hash, Some(expected_payment_hash));
1688 _ => panic!("Unexpected event"),
1697 macro_rules! expect_payment_path_successful {
1699 let events = $node.node.get_and_clear_pending_events();
1700 assert_eq!(events.len(), 1);
1702 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1703 _ => panic!("Unexpected event"),
1708 macro_rules! expect_payment_forwarded {
1709 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1710 let events = $node.node.get_and_clear_pending_events();
1711 assert_eq!(events.len(), 1);
1713 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1714 assert_eq!(fee_earned_msat, $expected_fee);
1715 if fee_earned_msat.is_some() {
1716 // Is the event prev_channel_id in one of the channels between the two nodes?
1717 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()));
1719 // We check for force closures since a force closed channel is removed from the
1720 // node's channel list
1721 if !$downstream_force_closed {
1722 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()));
1724 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1726 _ => panic!("Unexpected event"),
1731 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1732 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1733 let events = node.node.get_and_clear_pending_events();
1734 assert_eq!(events.len(), 1);
1736 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1737 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1739 _ => panic!("Unexpected event"),
1744 pub struct PaymentFailedConditions<'a> {
1745 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1746 pub(crate) expected_blamed_scid: Option<u64>,
1747 pub(crate) expected_blamed_chan_closed: Option<bool>,
1748 pub(crate) expected_mpp_parts_remain: bool,
1751 impl<'a> PaymentFailedConditions<'a> {
1752 pub fn new() -> Self {
1754 expected_htlc_error_data: None,
1755 expected_blamed_scid: None,
1756 expected_blamed_chan_closed: None,
1757 expected_mpp_parts_remain: false,
1760 pub fn mpp_parts_remain(mut self) -> Self {
1761 self.expected_mpp_parts_remain = true;
1764 pub fn blamed_scid(mut self, scid: u64) -> Self {
1765 self.expected_blamed_scid = Some(scid);
1768 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1769 self.expected_blamed_chan_closed = Some(closed);
1772 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1773 self.expected_htlc_error_data = Some((code, data));
1779 macro_rules! expect_payment_failed_with_update {
1780 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1781 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1782 &$node, $expected_payment_hash, $payment_failed_permanently,
1783 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1784 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1789 macro_rules! expect_payment_failed {
1790 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1791 #[allow(unused_mut)]
1792 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1794 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1796 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1800 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1801 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1802 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1804 let expected_payment_id = match payment_failed_event {
1805 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1809 error_data, .. } => {
1810 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1811 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1812 assert!(retry.is_some(), "expected retry.is_some()");
1813 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1814 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1815 if let Some(scid) = short_channel_id {
1816 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1821 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1822 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1823 if let Some((code, data)) = conditions.expected_htlc_error_data {
1824 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1825 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1829 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1830 match network_update {
1831 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1832 if let Some(scid) = conditions.expected_blamed_scid {
1833 assert_eq!(msg.contents.short_channel_id, scid);
1835 const CHAN_DISABLED_FLAG: u8 = 2;
1836 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1838 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1839 if let Some(scid) = conditions.expected_blamed_scid {
1840 assert_eq!(short_channel_id, scid);
1842 assert!(is_permanent);
1844 Some(_) => panic!("Unexpected update type"),
1845 None => panic!("Expected update"),
1851 _ => panic!("Unexpected event"),
1853 if !conditions.expected_mpp_parts_remain {
1854 node.node.abandon_payment(expected_payment_id);
1855 let events = node.node.get_and_clear_pending_events();
1856 assert_eq!(events.len(), 1);
1858 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1859 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1860 assert_eq!(*payment_id, expected_payment_id);
1862 _ => panic!("Unexpected second event"),
1867 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1868 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1869 conditions: PaymentFailedConditions<'e>
1871 let mut events = node.node.get_and_clear_pending_events();
1872 assert_eq!(events.len(), 1);
1873 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1876 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 {
1877 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1878 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1879 check_added_monitors!(origin_node, expected_paths.len());
1880 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1884 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>) {
1885 let mut payment_event = SendEvent::from_event(ev);
1886 let mut prev_node = origin_node;
1888 for (idx, &node) in expected_path.iter().enumerate() {
1889 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1891 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1892 check_added_monitors!(node, 0);
1893 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1895 expect_pending_htlcs_forwardable!(node);
1897 if idx == expected_path.len() - 1 && clear_recipient_events {
1898 let events_2 = node.node.get_and_clear_pending_events();
1899 if payment_claimable_expected {
1900 assert_eq!(events_2.len(), 1);
1902 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1903 assert_eq!(our_payment_hash, *payment_hash);
1904 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1906 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1907 assert_eq!(expected_preimage, *payment_preimage);
1908 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1910 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1911 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1912 assert!(our_payment_secret.is_none());
1915 assert_eq!(amount_msat, recv_value);
1916 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1917 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1919 _ => panic!("Unexpected event"),
1922 assert!(events_2.is_empty());
1924 } else if idx != expected_path.len() - 1 {
1925 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1926 assert_eq!(events_2.len(), 1);
1927 check_added_monitors!(node, 1);
1928 payment_event = SendEvent::from_event(events_2.remove(0));
1929 assert_eq!(payment_event.msgs.len(), 1);
1936 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>) {
1937 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1940 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) {
1941 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1942 assert_eq!(events.len(), expected_route.len());
1943 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1944 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
1945 // Once we've gotten through all the HTLCs, the last one should result in a
1946 // PaymentClaimable (but each previous one should not!), .
1947 let expect_payment = path_idx == expected_route.len() - 1;
1948 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1952 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) {
1953 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1954 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1955 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1958 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 {
1959 for path in expected_paths.iter() {
1960 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1962 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1964 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1965 assert_eq!(claim_event.len(), 1);
1966 match claim_event[0] {
1967 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1968 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1969 assert_eq!(preimage, our_payment_preimage),
1970 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1971 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1975 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1977 let mut expected_total_fee_msat = 0;
1979 macro_rules! msgs_from_ev {
1982 &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 } } => {
1983 assert!(update_add_htlcs.is_empty());
1984 assert_eq!(update_fulfill_htlcs.len(), 1);
1985 assert!(update_fail_htlcs.is_empty());
1986 assert!(update_fail_malformed_htlcs.is_empty());
1987 assert!(update_fee.is_none());
1988 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1990 _ => panic!("Unexpected event"),
1994 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1995 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1996 assert_eq!(events.len(), expected_paths.len());
1998 if events.len() == 1 {
1999 per_path_msgs.push(msgs_from_ev!(&events[0]));
2001 for expected_path in expected_paths.iter() {
2002 // For MPP payments, we always want the message to the first node in the path.
2003 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2004 per_path_msgs.push(msgs_from_ev!(&ev));
2008 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2009 let mut next_msgs = Some(path_msgs);
2010 let mut expected_next_node = next_hop;
2012 macro_rules! last_update_fulfill_dance {
2013 ($node: expr, $prev_node: expr) => {
2015 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2016 check_added_monitors!($node, 0);
2017 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2018 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2022 macro_rules! mid_update_fulfill_dance {
2023 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2025 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2027 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2028 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2029 .unwrap().lock().unwrap();
2030 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2031 if let Some(prev_config) = channel.prev_config() {
2032 prev_config.forwarding_fee_base_msat
2034 channel.config().forwarding_fee_base_msat
2037 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2038 expected_total_fee_msat += fee as u64;
2039 check_added_monitors!($node, 1);
2040 let new_next_msgs = if $new_msgs {
2041 let events = $node.node.get_and_clear_pending_msg_events();
2042 assert_eq!(events.len(), 1);
2043 let (res, nexthop) = msgs_from_ev!(&events[0]);
2044 expected_next_node = nexthop;
2047 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2050 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2051 next_msgs = new_next_msgs;
2056 let mut prev_node = expected_route.last().unwrap();
2057 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2058 assert_eq!(expected_next_node, node.node.get_our_node_id());
2059 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2060 if next_msgs.is_some() {
2061 // Since we are traversing in reverse, next_node is actually the previous node
2062 let next_node: &Node;
2063 if idx == expected_route.len() - 1 {
2064 next_node = origin_node;
2066 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2068 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2070 assert!(!update_next_msgs);
2071 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2073 if !skip_last && idx == expected_route.len() - 1 {
2074 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2081 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2085 // Ensure that claim_funds is idempotent.
2086 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2087 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2088 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2090 expected_total_fee_msat
2092 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) {
2093 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2095 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2099 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2100 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2103 pub const TEST_FINAL_CLTV: u32 = 70;
2105 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) {
2106 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2107 .with_features(expected_route.last().unwrap().node.invoice_features());
2108 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2109 assert_eq!(route.paths.len(), 1);
2110 assert_eq!(route.paths[0].len(), expected_route.len());
2111 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2112 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2115 let res = send_along_route(origin_node, route, expected_route, recv_value);
2116 (res.0, res.1, res.2)
2119 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2120 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2121 .with_features(expected_route.last().unwrap().node.invoice_features());
2122 let network_graph = origin_node.network_graph.read_only();
2123 let scorer = test_utils::TestScorer::with_penalty(0);
2124 let seed = [0u8; 32];
2125 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2126 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2127 let route = get_route(
2128 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2129 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2130 assert_eq!(route.paths.len(), 1);
2131 assert_eq!(route.paths[0].len(), expected_route.len());
2132 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2133 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2136 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2137 unwrap_send_err!(origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_preimage), PaymentId(our_payment_hash.0)), true, APIError::ChannelUnavailable { ref err },
2138 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2141 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2142 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2143 claim_payment(&origin, expected_route, our_payment_preimage);
2146 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) {
2147 for path in expected_paths.iter() {
2148 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2150 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2151 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2152 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2154 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2157 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) {
2158 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2160 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2161 let events = origin_node.node.get_and_clear_pending_events();
2162 assert_eq!(events.len(), 1);
2164 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2165 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2166 assert_eq!(*payment_id, expected_payment_id.unwrap());
2168 _ => panic!("Unexpected second event"),
2173 pub fn pass_failed_payment_back_no_abandon<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_paths_slice: &[&[&Node<'a, 'b, 'c>]], skip_last: bool, our_payment_hash: PaymentHash) -> Option<PaymentId> {
2174 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2175 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2177 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2178 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2179 assert_eq!(events.len(), expected_paths.len());
2180 for ev in events.iter() {
2181 let (update_fail, commitment_signed, node_id) = match ev {
2182 &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 } } => {
2183 assert!(update_add_htlcs.is_empty());
2184 assert!(update_fulfill_htlcs.is_empty());
2185 assert_eq!(update_fail_htlcs.len(), 1);
2186 assert!(update_fail_malformed_htlcs.is_empty());
2187 assert!(update_fee.is_none());
2188 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2190 _ => panic!("Unexpected event"),
2192 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2194 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2195 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()));
2197 let mut expected_payment_id = None;
2199 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2200 let mut next_msgs = Some(path_msgs);
2201 let mut expected_next_node = next_hop;
2202 let mut prev_node = expected_route.last().unwrap();
2204 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2205 assert_eq!(expected_next_node, node.node.get_our_node_id());
2206 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2207 if next_msgs.is_some() {
2208 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2209 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2210 if !update_next_node {
2211 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 }]);
2214 let events = node.node.get_and_clear_pending_msg_events();
2215 if update_next_node {
2216 assert_eq!(events.len(), 1);
2218 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 } } => {
2219 assert!(update_add_htlcs.is_empty());
2220 assert!(update_fulfill_htlcs.is_empty());
2221 assert_eq!(update_fail_htlcs.len(), 1);
2222 assert!(update_fail_malformed_htlcs.is_empty());
2223 assert!(update_fee.is_none());
2224 expected_next_node = node_id.clone();
2225 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2227 _ => panic!("Unexpected event"),
2230 assert!(events.is_empty());
2232 if !skip_last && idx == expected_route.len() - 1 {
2233 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2240 let prev_node = expected_route.first().unwrap();
2241 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2242 check_added_monitors!(origin_node, 0);
2243 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2244 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2245 let events = origin_node.node.get_and_clear_pending_events();
2246 assert_eq!(events.len(), 1);
2247 expected_payment_id = Some(match events[0] {
2248 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2249 assert_eq!(payment_hash, our_payment_hash);
2250 assert!(payment_failed_permanently);
2251 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2252 for (idx, hop) in expected_route.iter().enumerate() {
2253 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2257 _ => panic!("Unexpected event"),
2262 // Ensure that fail_htlc_backwards is idempotent.
2263 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2264 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2265 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2266 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2271 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2272 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2275 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2276 let mut chan_mon_cfgs = Vec::new();
2277 for i in 0..node_count {
2278 let tx_broadcaster = test_utils::TestBroadcaster {
2279 txn_broadcasted: Mutex::new(Vec::new()),
2280 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2282 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2283 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2284 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2285 let persister = test_utils::TestPersister::new();
2286 let seed = [i as u8; 32];
2287 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2289 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2295 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2296 let mut nodes = Vec::new();
2298 for i in 0..node_count {
2299 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);
2300 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2301 let seed = [i as u8; 32];
2302 nodes.push(NodeCfg {
2303 chain_source: &chanmon_cfgs[i].chain_source,
2304 logger: &chanmon_cfgs[i].logger,
2305 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2306 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2307 router: test_utils::TestRouter::new(network_graph.clone()),
2309 keys_manager: &chanmon_cfgs[i].keys_manager,
2312 override_init_features: Rc::new(RefCell::new(None)),
2319 pub fn test_default_channel_config() -> UserConfig {
2320 let mut default_config = UserConfig::default();
2321 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2322 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2323 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2324 default_config.channel_handshake_config.announced_channel = true;
2325 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2326 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2327 // It now defaults to 1, so we simply set it to the expected value here.
2328 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2329 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2330 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2331 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2335 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>> {
2336 let mut chanmgrs = Vec::new();
2337 for i in 0..node_count {
2338 let network = Network::Testnet;
2339 let params = ChainParameters {
2341 best_block: BestBlock::from_genesis(network),
2343 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,
2344 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);
2345 chanmgrs.push(node);
2351 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>> {
2352 let mut nodes = Vec::new();
2353 let chan_count = Rc::new(RefCell::new(0));
2354 let payment_count = Rc::new(RefCell::new(0));
2355 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2357 for i in 0..node_count {
2358 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2360 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2361 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2362 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2363 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2364 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2365 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2366 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2367 connect_style: Rc::clone(&connect_style),
2368 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2372 for i in 0..node_count {
2373 for j in (i+1)..node_count {
2374 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 }).unwrap();
2375 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 }).unwrap();
2382 // Note that the following only works for CLTV values up to 128
2383 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2385 #[derive(PartialEq)]
2386 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2387 /// Tests that the given node has broadcast transactions for the given Channel
2389 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2390 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2391 /// broadcast and the revoked outputs were claimed.
2393 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2394 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2396 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2398 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> {
2399 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2400 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2402 let mut res = Vec::with_capacity(2);
2403 node_txn.retain(|tx| {
2404 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2405 check_spends!(tx, chan.3);
2406 if commitment_tx.is_none() {
2407 res.push(tx.clone());
2412 if let Some(explicit_tx) = commitment_tx {
2413 res.push(explicit_tx.clone());
2416 assert_eq!(res.len(), 1);
2418 if has_htlc_tx != HTLCType::NONE {
2419 node_txn.retain(|tx| {
2420 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2421 check_spends!(tx, res[0]);
2422 if has_htlc_tx == HTLCType::TIMEOUT {
2423 assert!(tx.lock_time.0 != 0);
2425 assert!(tx.lock_time.0 == 0);
2427 res.push(tx.clone());
2431 assert!(res.len() == 2 || res.len() == 3);
2433 assert_eq!(res[1], res[2]);
2437 assert!(node_txn.is_empty());
2441 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2442 /// HTLC transaction.
2443 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2444 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2445 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2446 // for revoked htlc outputs
2447 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2448 node_txn.retain(|tx| {
2449 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2450 check_spends!(tx, revoked_tx);
2454 node_txn.retain(|tx| {
2455 check_spends!(tx, commitment_revoked_tx);
2458 assert!(node_txn.is_empty());
2461 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2462 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2464 assert!(node_txn.len() >= 1);
2465 assert_eq!(node_txn[0].input.len(), 1);
2466 let mut found_prev = false;
2468 for tx in prev_txn {
2469 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2470 check_spends!(node_txn[0], tx);
2471 let mut iter = node_txn[0].input[0].witness.iter();
2472 iter.next().expect("expected 3 witness items");
2473 iter.next().expect("expected 3 witness items");
2474 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2475 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2481 assert!(found_prev);
2483 let mut res = Vec::new();
2484 mem::swap(&mut *node_txn, &mut res);
2488 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) {
2489 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2490 assert_eq!(events_1.len(), 2);
2491 let as_update = match events_1[0] {
2492 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2495 _ => panic!("Unexpected event"),
2498 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2499 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2500 assert_eq!(msg.data, expected_error);
2501 if needs_err_handle {
2502 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2505 _ => panic!("Unexpected event"),
2508 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2509 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2510 let bs_update = match events_2[0] {
2511 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2514 _ => panic!("Unexpected event"),
2516 if !needs_err_handle {
2518 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2519 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2520 assert_eq!(msg.data, expected_error);
2522 _ => panic!("Unexpected event"),
2527 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2528 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2532 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2533 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2537 macro_rules! get_channel_value_stat {
2538 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2539 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2540 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2541 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2542 chan.get_value_stat()
2546 macro_rules! get_chan_reestablish_msgs {
2547 ($src_node: expr, $dst_node: expr) => {
2549 let mut announcements = $crate::prelude::HashSet::new();
2550 let mut res = Vec::with_capacity(1);
2551 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2552 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2553 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2554 res.push(msg.clone());
2555 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2556 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2557 announcements.insert(msg.contents.short_channel_id);
2559 panic!("Unexpected event")
2562 for chan in $src_node.node.list_channels() {
2563 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2564 if let Some(scid) = chan.short_channel_id {
2565 assert!(announcements.remove(&scid));
2569 assert!(announcements.is_empty());
2575 macro_rules! handle_chan_reestablish_msgs {
2576 ($src_node: expr, $dst_node: expr) => {
2578 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2580 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2582 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2588 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2590 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2593 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2594 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2595 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2597 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2598 had_channel_update = true;
2601 let mut revoke_and_ack = None;
2602 let mut commitment_update = None;
2603 let order = if let Some(ev) = msg_events.get(idx) {
2605 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2606 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2607 revoke_and_ack = Some(msg.clone());
2609 RAACommitmentOrder::RevokeAndACKFirst
2611 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2612 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2613 commitment_update = Some(updates.clone());
2615 RAACommitmentOrder::CommitmentFirst
2617 _ => RAACommitmentOrder::CommitmentFirst,
2620 RAACommitmentOrder::CommitmentFirst
2623 if let Some(ev) = msg_events.get(idx) {
2625 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2626 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2627 assert!(revoke_and_ack.is_none());
2628 revoke_and_ack = Some(msg.clone());
2631 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2632 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2633 assert!(commitment_update.is_none());
2634 commitment_update = Some(updates.clone());
2641 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2642 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2644 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2645 assert!(!had_channel_update);
2648 assert_eq!(msg_events.len(), idx);
2650 (channel_ready, revoke_and_ack, commitment_update, order)
2655 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2656 /// for claims/fails they are separated out.
2657 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)) {
2658 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: node_b.node.init_features(), remote_network_address: None }).unwrap();
2659 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2660 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: node_a.node.init_features(), remote_network_address: None }).unwrap();
2661 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2663 if send_channel_ready.0 {
2664 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2666 for reestablish in reestablish_1.iter() {
2667 assert_eq!(reestablish.next_remote_commitment_number, 0);
2670 if send_channel_ready.1 {
2671 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2673 for reestablish in reestablish_2.iter() {
2674 assert_eq!(reestablish.next_remote_commitment_number, 0);
2677 if send_channel_ready.0 || send_channel_ready.1 {
2678 // If we expect any channel_ready's, both sides better have set
2679 // next_holder_commitment_number to 1
2680 for reestablish in reestablish_1.iter() {
2681 assert_eq!(reestablish.next_local_commitment_number, 1);
2683 for reestablish in reestablish_2.iter() {
2684 assert_eq!(reestablish.next_local_commitment_number, 1);
2688 let mut resp_1 = Vec::new();
2689 for msg in reestablish_1 {
2690 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2691 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2693 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2694 check_added_monitors!(node_b, 1);
2696 check_added_monitors!(node_b, 0);
2699 let mut resp_2 = Vec::new();
2700 for msg in reestablish_2 {
2701 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2702 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2704 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2705 check_added_monitors!(node_a, 1);
2707 check_added_monitors!(node_a, 0);
2710 // We don't yet support both needing updates, as that would require a different commitment dance:
2711 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2712 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2713 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2714 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2716 for chan_msgs in resp_1.drain(..) {
2717 if send_channel_ready.0 {
2718 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2719 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2720 if !announcement_event.is_empty() {
2721 assert_eq!(announcement_event.len(), 1);
2722 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2723 //TODO: Test announcement_sigs re-sending
2724 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2727 assert!(chan_msgs.0.is_none());
2730 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2731 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2732 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2733 check_added_monitors!(node_a, 1);
2735 assert!(chan_msgs.1.is_none());
2737 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 {
2738 let commitment_update = chan_msgs.2.unwrap();
2739 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2740 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2742 assert!(commitment_update.update_add_htlcs.is_empty());
2744 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2745 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2746 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2747 for update_add in commitment_update.update_add_htlcs {
2748 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2750 for update_fulfill in commitment_update.update_fulfill_htlcs {
2751 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2753 for update_fail in commitment_update.update_fail_htlcs {
2754 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2757 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2758 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2760 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2761 check_added_monitors!(node_a, 1);
2762 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2763 // No commitment_signed so get_event_msg's assert(len == 1) passes
2764 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2765 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2766 check_added_monitors!(node_b, 1);
2769 assert!(chan_msgs.2.is_none());
2773 for chan_msgs in resp_2.drain(..) {
2774 if send_channel_ready.1 {
2775 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2776 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2777 if !announcement_event.is_empty() {
2778 assert_eq!(announcement_event.len(), 1);
2779 match announcement_event[0] {
2780 MessageSendEvent::SendChannelUpdate { .. } => {},
2781 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2782 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2786 assert!(chan_msgs.0.is_none());
2789 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2790 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2791 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2792 check_added_monitors!(node_b, 1);
2794 assert!(chan_msgs.1.is_none());
2796 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 {
2797 let commitment_update = chan_msgs.2.unwrap();
2798 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2799 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2801 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2802 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2803 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2804 for update_add in commitment_update.update_add_htlcs {
2805 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2807 for update_fulfill in commitment_update.update_fulfill_htlcs {
2808 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2810 for update_fail in commitment_update.update_fail_htlcs {
2811 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2814 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2815 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2817 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2818 check_added_monitors!(node_b, 1);
2819 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2820 // No commitment_signed so get_event_msg's assert(len == 1) passes
2821 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2822 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2823 check_added_monitors!(node_a, 1);
2826 assert!(chan_msgs.2.is_none());