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`, along with an updated `msg_events` vec with the message removed.
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: &Vec<MessageSendEvent>) -> (MessageSendEvent, Vec<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::SendChannelUpdate { node_id, .. } => {
625 node_id == msg_node_id
627 MessageSendEvent::HandleError { node_id, .. } => {
628 node_id == msg_node_id
630 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
631 node_id == msg_node_id
633 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
634 node_id == msg_node_id
636 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
637 node_id == msg_node_id
639 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
640 node_id == msg_node_id
643 if ev_index.is_some() {
644 let mut updated_msg_events = msg_events.to_vec();
645 let ev = updated_msg_events.remove(ev_index.unwrap());
646 (ev, updated_msg_events)
648 panic!("Couldn't find any MessageSendEvent to the node!")
653 macro_rules! get_channel_ref {
654 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
656 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
657 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
658 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
664 macro_rules! get_feerate {
665 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
667 let mut per_peer_state_lock;
668 let mut peer_state_lock;
669 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
676 macro_rules! get_opt_anchors {
677 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
679 let mut per_peer_state_lock;
680 let mut peer_state_lock;
681 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
687 /// Returns a channel monitor given a channel id, making some naive assumptions
689 macro_rules! get_monitor {
690 ($node: expr, $channel_id: expr) => {
692 use bitcoin::hashes::Hash;
693 let mut monitor = None;
694 // Assume funding vout is either 0 or 1 blindly
696 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
697 $crate::chain::transaction::OutPoint {
698 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
710 /// Returns any local commitment transactions for the channel.
712 macro_rules! get_local_commitment_txn {
713 ($node: expr, $channel_id: expr) => {
715 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
720 /// Check the error from attempting a payment.
722 macro_rules! unwrap_send_err {
723 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
725 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
726 assert_eq!(fails.len(), 1);
732 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
733 assert_eq!(results.len(), 1);
735 Err($type) => { $check },
744 /// Check whether N channel monitor(s) have been added.
746 macro_rules! check_added_monitors {
747 ($node: expr, $count: expr) => {
749 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
750 assert_eq!(added_monitors.len(), $count);
751 added_monitors.clear();
756 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> {
757 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
758 for encoded in monitors_encoded {
759 let mut monitor_read = &encoded[..];
760 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
761 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
762 assert!(monitor_read.is_empty());
763 monitors_read.push(monitor);
766 let mut node_read = &chanman_encoded[..];
767 let (_, node_deserialized) = {
768 let mut channel_monitors = HashMap::new();
769 for monitor in monitors_read.iter_mut() {
770 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
772 <(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 {
774 entropy_source: node.keys_manager,
775 node_signer: node.keys_manager,
776 signer_provider: node.keys_manager,
777 fee_estimator: node.fee_estimator,
779 chain_monitor: node.chain_monitor,
780 tx_broadcaster: node.tx_broadcaster,
785 assert!(node_read.is_empty());
787 for monitor in monitors_read.drain(..) {
788 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
789 ChannelMonitorUpdateStatus::Completed);
790 check_added_monitors!(node, 1);
797 macro_rules! reload_node {
798 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
799 let chanman_encoded = $chanman_encoded;
801 $persister = test_utils::TestPersister::new();
802 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
803 $node.chain_monitor = &$new_chain_monitor;
805 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
806 $node.node = &$new_channelmanager;
808 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
809 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
813 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) {
814 let chan_id = *node.network_chan_count.borrow();
816 let events = node.node.get_and_clear_pending_events();
817 assert_eq!(events.len(), 1);
819 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
820 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
821 assert_eq!(*channel_value_satoshis, expected_chan_value);
822 assert_eq!(user_channel_id, expected_user_chan_id);
824 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
825 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
827 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
828 (*temporary_channel_id, tx, funding_outpoint)
830 _ => panic!("Unexpected event"),
833 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 {
834 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
835 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
837 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
838 check_added_monitors!(node_a, 0);
840 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
841 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
842 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
844 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
845 assert_eq!(added_monitors.len(), 1);
846 assert_eq!(added_monitors[0].0, funding_output);
847 added_monitors.clear();
850 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()));
852 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
853 assert_eq!(added_monitors.len(), 1);
854 assert_eq!(added_monitors[0].0, funding_output);
855 added_monitors.clear();
858 let events_4 = node_a.node.get_and_clear_pending_events();
859 assert_eq!(events_4.len(), 0);
861 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
862 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
863 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
865 // Ensure that funding_transaction_generated is idempotent.
866 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
867 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
868 check_added_monitors!(node_a, 0);
873 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
874 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]) {
875 let initiator_channels = initiator.node.list_usable_channels().len();
876 let receiver_channels = receiver.node.list_usable_channels().len();
878 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
879 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
881 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
882 let events = receiver.node.get_and_clear_pending_events();
883 assert_eq!(events.len(), 1);
885 Event::OpenChannelRequest { temporary_channel_id, .. } => {
886 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
888 _ => panic!("Unexpected event"),
891 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
892 assert_eq!(accept_channel.minimum_depth, 0);
893 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
895 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
896 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
897 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
899 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
900 check_added_monitors!(receiver, 1);
901 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
902 assert_eq!(bs_signed_locked.len(), 2);
903 let as_channel_ready;
904 match &bs_signed_locked[0] {
905 MessageSendEvent::SendFundingSigned { node_id, msg } => {
906 assert_eq!(*node_id, initiator.node.get_our_node_id());
907 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
908 check_added_monitors!(initiator, 1);
910 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
911 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
913 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
915 _ => panic!("Unexpected event"),
917 match &bs_signed_locked[1] {
918 MessageSendEvent::SendChannelReady { node_id, msg } => {
919 assert_eq!(*node_id, initiator.node.get_our_node_id());
920 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
922 _ => panic!("Unexpected event"),
925 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
927 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
928 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
930 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
931 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
933 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
934 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
936 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
937 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
939 (tx, as_channel_ready.channel_id)
942 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 {
943 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
944 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
945 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
946 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
947 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
948 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
949 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
950 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
951 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
953 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
956 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) {
957 confirm_transaction_at(node_conf, tx, conf_height);
958 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
959 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()));
962 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]) {
964 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
965 assert_eq!(events_6.len(), 3);
966 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
967 assert_eq!(*node_id, node_recv.node.get_our_node_id());
969 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
970 assert_eq!(*node_id, node_recv.node.get_our_node_id());
972 } else { panic!("Unexpected event: {:?}", events_6[1]); };
973 ((match events_6[0] {
974 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
975 channel_id = msg.channel_id.clone();
976 assert_eq!(*node_id, node_recv.node.get_our_node_id());
979 _ => panic!("Unexpected event"),
980 }, match events_6[announcement_sigs_idx] {
981 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
982 assert_eq!(*node_id, node_recv.node.get_our_node_id());
985 _ => panic!("Unexpected event"),
989 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]) {
990 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
991 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
992 confirm_transaction_at(node_a, tx, conf_height);
993 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
994 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
995 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
998 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) {
999 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1000 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1004 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) {
1005 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1006 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1007 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1009 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1010 assert_eq!(events_7.len(), 1);
1011 let (announcement, bs_update) = match events_7[0] {
1012 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1015 _ => panic!("Unexpected event"),
1018 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1019 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1020 assert_eq!(events_8.len(), 1);
1021 let as_update = match events_8[0] {
1022 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1023 assert!(*announcement == *msg);
1024 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1025 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1028 _ => panic!("Unexpected event"),
1031 *node_a.network_chan_count.borrow_mut() += 1;
1033 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1034 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
1037 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) {
1038 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1041 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) {
1042 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1043 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1044 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1047 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) {
1048 let mut no_announce_cfg = test_default_channel_config();
1049 no_announce_cfg.channel_handshake_config.announced_channel = false;
1050 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1051 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1052 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1053 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1054 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1056 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1057 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1058 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()));
1059 check_added_monitors!(nodes[b], 1);
1061 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1062 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1063 check_added_monitors!(nodes[a], 1);
1065 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1066 confirm_transaction_at(&nodes[a], &tx, conf_height);
1067 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1068 confirm_transaction_at(&nodes[b], &tx, conf_height);
1069 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1070 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1071 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()));
1072 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1073 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1074 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1075 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1076 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1078 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1079 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1081 let mut found_a = false;
1082 for chan in nodes[a].node.list_usable_channels() {
1083 if chan.channel_id == as_channel_ready.channel_id {
1086 assert!(!chan.is_public);
1091 let mut found_b = false;
1092 for chan in nodes[b].node.list_usable_channels() {
1093 if chan.channel_id == as_channel_ready.channel_id {
1096 assert!(!chan.is_public);
1101 (as_channel_ready, tx)
1104 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) {
1106 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1107 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1108 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1110 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1111 // forwarding info for local channels even if its not accepted in the network graph.
1112 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1113 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1118 macro_rules! check_spends {
1119 ($tx: expr, $($spends_txn: expr),*) => {
1122 for outp in $spends_txn.output.iter() {
1123 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1126 for outp in $tx.output.iter() {
1127 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1129 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1131 if out_point.txid == $spends_txn.txid() {
1132 return $spends_txn.output.get(out_point.vout as usize).cloned()
1137 let mut total_value_in = 0;
1138 for input in $tx.input.iter() {
1139 total_value_in += get_output(&input.previous_output).unwrap().value;
1141 let mut total_value_out = 0;
1142 for output in $tx.output.iter() {
1143 total_value_out += output.value;
1145 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1146 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1147 assert!(total_value_out + min_fee <= total_value_in);
1148 $tx.verify(get_output).unwrap();
1153 macro_rules! get_closing_signed_broadcast {
1154 ($node: expr, $dest_pubkey: expr) => {
1156 let events = $node.get_and_clear_pending_msg_events();
1157 assert!(events.len() == 1 || events.len() == 2);
1158 (match events[events.len() - 1] {
1159 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1160 assert_eq!(msg.contents.flags & 2, 2);
1163 _ => panic!("Unexpected event"),
1164 }, if events.len() == 2 {
1166 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1167 assert_eq!(*node_id, $dest_pubkey);
1170 _ => panic!("Unexpected event"),
1178 macro_rules! check_warn_msg {
1179 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1180 let msg_events = $node.node.get_and_clear_pending_msg_events();
1181 assert_eq!(msg_events.len(), 1);
1182 match msg_events[0] {
1183 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1184 assert_eq!(node_id, $recipient_node_id);
1185 assert_eq!(msg.channel_id, $chan_id);
1188 _ => panic!("Unexpected event"),
1193 /// Check that a channel's closing channel update has been broadcasted, and optionally
1194 /// check whether an error message event has occurred.
1196 macro_rules! check_closed_broadcast {
1197 ($node: expr, $with_error_msg: expr) => {{
1198 use $crate::util::events::MessageSendEvent;
1199 use $crate::ln::msgs::ErrorAction;
1201 let msg_events = $node.node.get_and_clear_pending_msg_events();
1202 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1203 match msg_events[0] {
1204 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1205 assert_eq!(msg.contents.flags & 2, 2);
1207 _ => panic!("Unexpected event"),
1209 if $with_error_msg {
1210 match msg_events[1] {
1211 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1212 // TODO: Check node_id
1215 _ => panic!("Unexpected event"),
1221 /// Check that a channel's closing channel events has been issued
1223 macro_rules! check_closed_event {
1224 ($node: expr, $events: expr, $reason: expr) => {
1225 check_closed_event!($node, $events, $reason, false);
1227 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1228 use $crate::util::events::Event;
1230 let events = $node.node.get_and_clear_pending_events();
1231 assert_eq!(events.len(), $events, "{:?}", events);
1232 let expected_reason = $reason;
1233 let mut issues_discard_funding = false;
1234 for event in events {
1236 Event::ChannelClosed { ref reason, .. } => {
1237 assert_eq!(*reason, expected_reason);
1239 Event::DiscardFunding { .. } => {
1240 issues_discard_funding = true;
1242 _ => panic!("Unexpected event"),
1245 assert_eq!($is_check_discard_funding, issues_discard_funding);
1249 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) {
1250 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) };
1251 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) };
1254 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1255 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1257 let events_1 = node_b.get_and_clear_pending_msg_events();
1258 assert!(events_1.len() >= 1);
1259 let shutdown_b = match events_1[0] {
1260 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1261 assert_eq!(node_id, &node_a.get_our_node_id());
1264 _ => panic!("Unexpected event"),
1267 let closing_signed_b = if !close_inbound_first {
1268 assert_eq!(events_1.len(), 1);
1271 Some(match events_1[1] {
1272 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1273 assert_eq!(node_id, &node_a.get_our_node_id());
1276 _ => panic!("Unexpected event"),
1280 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1281 let (as_update, bs_update) = if close_inbound_first {
1282 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1283 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1285 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1286 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1287 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1288 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1290 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1291 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1292 assert!(none_a.is_none());
1293 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1294 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1295 (as_update, bs_update)
1297 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1299 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1300 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1302 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1303 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1304 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1306 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1307 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1308 assert!(none_b.is_none());
1309 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1310 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1311 (as_update, bs_update)
1313 assert_eq!(tx_a, tx_b);
1314 check_spends!(tx_a, funding_tx);
1316 (as_update, bs_update, tx_a)
1319 pub struct SendEvent {
1320 pub node_id: PublicKey,
1321 pub msgs: Vec<msgs::UpdateAddHTLC>,
1322 pub commitment_msg: msgs::CommitmentSigned,
1325 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1326 assert!(updates.update_fulfill_htlcs.is_empty());
1327 assert!(updates.update_fail_htlcs.is_empty());
1328 assert!(updates.update_fail_malformed_htlcs.is_empty());
1329 assert!(updates.update_fee.is_none());
1330 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1333 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1335 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1336 _ => panic!("Unexpected event type!"),
1340 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1341 let mut events = node.node.get_and_clear_pending_msg_events();
1342 assert_eq!(events.len(), 1);
1343 SendEvent::from_event(events.pop().unwrap())
1348 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1349 /// commitment update.
1350 macro_rules! commitment_signed_dance {
1351 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1353 check_added_monitors!($node_a, 0);
1354 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1355 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1356 check_added_monitors!($node_a, 1);
1357 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1360 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1362 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1363 check_added_monitors!($node_b, 0);
1364 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1365 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1366 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1367 check_added_monitors!($node_b, 1);
1368 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1369 let (bs_revoke_and_ack, extra_msg_option) = {
1370 let events = $node_b.node.get_and_clear_pending_msg_events();
1371 assert!(events.len() <= 2);
1372 let (node_a_event, events) = remove_first_msg_event_to_node(&$node_a.node.get_our_node_id(), &events);
1373 (match node_a_event {
1374 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1375 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1378 _ => panic!("Unexpected event"),
1379 }, events.get(0).map(|e| e.clone()))
1381 check_added_monitors!($node_b, 1);
1382 if $fail_backwards {
1383 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1384 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1386 (extra_msg_option, bs_revoke_and_ack)
1389 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1391 check_added_monitors!($node_a, 0);
1392 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1393 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1394 check_added_monitors!($node_a, 1);
1395 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1396 assert!(extra_msg_option.is_none());
1400 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1402 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1403 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1404 check_added_monitors!($node_a, 1);
1408 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1410 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1413 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1415 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1416 if $fail_backwards {
1417 expect_pending_htlcs_forwardable_and_htlc_handling_failed!($node_a, vec![$crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some($node_b.node.get_our_node_id()), channel_id: $commitment_signed.channel_id }]);
1418 check_added_monitors!($node_a, 1);
1420 let node_a_per_peer_state = $node_a.node.per_peer_state.read().unwrap();
1421 let mut number_of_msg_events = 0;
1422 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1423 let peer_state = peer_state_mutex.lock().unwrap();
1424 let cp_pending_msg_events = &peer_state.pending_msg_events;
1425 number_of_msg_events += cp_pending_msg_events.len();
1426 if cp_pending_msg_events.len() == 1 {
1427 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1428 assert_ne!(*cp_id, $node_b.node.get_our_node_id());
1429 } else { panic!("Unexpected event"); }
1432 // Expecting the failure backwards event to the previous hop (not `node_b`)
1433 assert_eq!(number_of_msg_events, 1);
1435 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1441 /// Get a payment preimage and hash.
1443 macro_rules! get_payment_preimage_hash {
1444 ($dest_node: expr) => {
1446 get_payment_preimage_hash!($dest_node, None)
1449 ($dest_node: expr, $min_value_msat: expr) => {
1451 use bitcoin::hashes::Hash as _;
1452 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1453 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1454 *payment_count += 1;
1455 let payment_hash = $crate::ln::PaymentHash(
1456 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1457 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1458 (payment_preimage, payment_hash, payment_secret)
1464 macro_rules! get_route {
1465 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1466 use $crate::chain::keysinterface::EntropySource;
1467 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1468 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1469 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1470 $crate::routing::router::get_route(
1471 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1472 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1473 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1480 macro_rules! get_route_and_payment_hash {
1481 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1482 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1483 .with_features($recv_node.node.invoice_features());
1484 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1486 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1487 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1488 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1489 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1494 macro_rules! expect_pending_htlcs_forwardable_conditions {
1495 ($node: expr, $expected_failures: expr) => {{
1496 let expected_failures = $expected_failures;
1497 let events = $node.node.get_and_clear_pending_events();
1499 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1500 _ => panic!("Unexpected event {:?}", events),
1503 let count = expected_failures.len() + 1;
1504 assert_eq!(events.len(), count);
1506 if expected_failures.len() > 0 {
1507 expect_htlc_handling_failed_destinations!(events, expected_failures)
1513 macro_rules! expect_htlc_handling_failed_destinations {
1514 ($events: expr, $expected_failures: expr) => {{
1515 for event in $events {
1517 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1518 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1519 assert!($expected_failures.contains(&failed_next_destination))
1521 _ => panic!("Unexpected destination"),
1528 /// Clears (and ignores) a PendingHTLCsForwardable event
1529 macro_rules! expect_pending_htlcs_forwardable_ignore {
1531 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1536 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1537 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1538 ($node: expr, $expected_failures: expr) => {{
1539 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1544 /// Handles a PendingHTLCsForwardable event
1545 macro_rules! expect_pending_htlcs_forwardable {
1547 expect_pending_htlcs_forwardable_ignore!($node);
1548 $node.node.process_pending_htlc_forwards();
1550 // Ensure process_pending_htlc_forwards is idempotent.
1551 $node.node.process_pending_htlc_forwards();
1556 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1557 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1558 ($node: expr, $expected_failures: expr) => {{
1559 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1560 $node.node.process_pending_htlc_forwards();
1562 // Ensure process_pending_htlc_forwards is idempotent.
1563 $node.node.process_pending_htlc_forwards();
1568 macro_rules! expect_pending_htlcs_forwardable_from_events {
1569 ($node: expr, $events: expr, $ignore: expr) => {{
1570 assert_eq!($events.len(), 1);
1572 Event::PendingHTLCsForwardable { .. } => { },
1573 _ => panic!("Unexpected event"),
1576 $node.node.process_pending_htlc_forwards();
1578 // Ensure process_pending_htlc_forwards is idempotent.
1579 $node.node.process_pending_htlc_forwards();
1584 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1585 macro_rules! expect_payment_claimable {
1586 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1587 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1589 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1590 let events = $node.node.get_and_clear_pending_events();
1591 assert_eq!(events.len(), 1);
1593 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1594 assert_eq!($expected_payment_hash, *payment_hash);
1595 assert_eq!($expected_recv_value, amount_msat);
1596 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1598 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1599 assert_eq!(&$expected_payment_preimage, payment_preimage);
1600 assert_eq!($expected_payment_secret, *payment_secret);
1605 _ => panic!("Unexpected event"),
1611 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1612 macro_rules! expect_payment_claimed {
1613 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1614 let events = $node.node.get_and_clear_pending_events();
1615 assert_eq!(events.len(), 1);
1617 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1618 assert_eq!($expected_payment_hash, *payment_hash);
1619 assert_eq!($expected_recv_value, amount_msat);
1621 _ => panic!("Unexpected event"),
1628 macro_rules! expect_payment_sent_without_paths {
1629 ($node: expr, $expected_payment_preimage: expr) => {
1630 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1632 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1633 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1638 macro_rules! expect_payment_sent {
1639 ($node: expr, $expected_payment_preimage: expr) => {
1640 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1642 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1643 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1645 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1646 use bitcoin::hashes::Hash as _;
1647 let events = $node.node.get_and_clear_pending_events();
1648 let expected_payment_hash = $crate::ln::PaymentHash(
1649 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1651 assert!(events.len() > 1);
1653 assert_eq!(events.len(), 1);
1655 let expected_payment_id = match events[0] {
1656 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1657 assert_eq!($expected_payment_preimage, *payment_preimage);
1658 assert_eq!(expected_payment_hash, *payment_hash);
1659 assert!(fee_paid_msat.is_some());
1660 if $expected_fee_msat_opt.is_some() {
1661 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1665 _ => panic!("Unexpected event"),
1668 for i in 1..events.len() {
1670 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1671 assert_eq!(payment_id, expected_payment_id);
1672 assert_eq!(payment_hash, Some(expected_payment_hash));
1674 _ => panic!("Unexpected event"),
1683 macro_rules! expect_payment_path_successful {
1685 let events = $node.node.get_and_clear_pending_events();
1686 assert_eq!(events.len(), 1);
1688 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1689 _ => panic!("Unexpected event"),
1694 macro_rules! expect_payment_forwarded {
1695 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1696 let events = $node.node.get_and_clear_pending_events();
1697 assert_eq!(events.len(), 1);
1699 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1700 assert_eq!(fee_earned_msat, $expected_fee);
1701 if fee_earned_msat.is_some() {
1702 // Is the event prev_channel_id in one of the channels between the two nodes?
1703 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()));
1705 // We check for force closures since a force closed channel is removed from the
1706 // node's channel list
1707 if !$downstream_force_closed {
1708 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()));
1710 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1712 _ => panic!("Unexpected event"),
1717 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1718 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1719 let events = node.node.get_and_clear_pending_events();
1720 assert_eq!(events.len(), 1);
1722 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1723 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1725 _ => panic!("Unexpected event"),
1730 pub struct PaymentFailedConditions<'a> {
1731 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1732 pub(crate) expected_blamed_scid: Option<u64>,
1733 pub(crate) expected_blamed_chan_closed: Option<bool>,
1734 pub(crate) expected_mpp_parts_remain: bool,
1737 impl<'a> PaymentFailedConditions<'a> {
1738 pub fn new() -> Self {
1740 expected_htlc_error_data: None,
1741 expected_blamed_scid: None,
1742 expected_blamed_chan_closed: None,
1743 expected_mpp_parts_remain: false,
1746 pub fn mpp_parts_remain(mut self) -> Self {
1747 self.expected_mpp_parts_remain = true;
1750 pub fn blamed_scid(mut self, scid: u64) -> Self {
1751 self.expected_blamed_scid = Some(scid);
1754 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1755 self.expected_blamed_chan_closed = Some(closed);
1758 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1759 self.expected_htlc_error_data = Some((code, data));
1765 macro_rules! expect_payment_failed_with_update {
1766 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1767 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1768 &$node, $expected_payment_hash, $payment_failed_permanently,
1769 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1770 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1775 macro_rules! expect_payment_failed {
1776 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1777 #[allow(unused_mut)]
1778 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1780 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1782 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1786 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1787 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1788 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1790 let expected_payment_id = match payment_failed_event {
1791 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1795 error_data, .. } => {
1796 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1797 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1798 assert!(retry.is_some(), "expected retry.is_some()");
1799 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1800 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1801 if let Some(scid) = short_channel_id {
1802 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1807 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1808 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1809 if let Some((code, data)) = conditions.expected_htlc_error_data {
1810 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1811 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1815 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1816 match network_update {
1817 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1818 if let Some(scid) = conditions.expected_blamed_scid {
1819 assert_eq!(msg.contents.short_channel_id, scid);
1821 const CHAN_DISABLED_FLAG: u8 = 2;
1822 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1824 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1825 if let Some(scid) = conditions.expected_blamed_scid {
1826 assert_eq!(short_channel_id, scid);
1828 assert!(is_permanent);
1830 Some(_) => panic!("Unexpected update type"),
1831 None => panic!("Expected update"),
1837 _ => panic!("Unexpected event"),
1839 if !conditions.expected_mpp_parts_remain {
1840 node.node.abandon_payment(expected_payment_id);
1841 let events = node.node.get_and_clear_pending_events();
1842 assert_eq!(events.len(), 1);
1844 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1845 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1846 assert_eq!(*payment_id, expected_payment_id);
1848 _ => panic!("Unexpected second event"),
1853 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1854 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1855 conditions: PaymentFailedConditions<'e>
1857 let mut events = node.node.get_and_clear_pending_events();
1858 assert_eq!(events.len(), 1);
1859 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1862 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 {
1863 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1864 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1865 check_added_monitors!(origin_node, expected_paths.len());
1866 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1870 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>) {
1871 let mut payment_event = SendEvent::from_event(ev);
1872 let mut prev_node = origin_node;
1874 for (idx, &node) in expected_path.iter().enumerate() {
1875 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1877 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1878 check_added_monitors!(node, 0);
1879 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1881 expect_pending_htlcs_forwardable!(node);
1883 if idx == expected_path.len() - 1 && clear_recipient_events {
1884 let events_2 = node.node.get_and_clear_pending_events();
1885 if payment_claimable_expected {
1886 assert_eq!(events_2.len(), 1);
1888 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1889 assert_eq!(our_payment_hash, *payment_hash);
1890 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1892 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1893 assert_eq!(expected_preimage, *payment_preimage);
1894 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1896 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1897 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1898 assert!(our_payment_secret.is_none());
1901 assert_eq!(amount_msat, recv_value);
1902 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1903 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1905 _ => panic!("Unexpected event"),
1908 assert!(events_2.is_empty());
1910 } else if idx != expected_path.len() - 1 {
1911 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1912 assert_eq!(events_2.len(), 1);
1913 check_added_monitors!(node, 1);
1914 payment_event = SendEvent::from_event(events_2.remove(0));
1915 assert_eq!(payment_event.msgs.len(), 1);
1922 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>) {
1923 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1926 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) {
1927 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1928 assert_eq!(events.len(), expected_route.len());
1929 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1930 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1931 events = updated_events;
1932 // Once we've gotten through all the HTLCs, the last one should result in a
1933 // PaymentClaimable (but each previous one should not!), .
1934 let expect_payment = path_idx == expected_route.len() - 1;
1935 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1939 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) {
1940 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1941 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1942 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1945 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 {
1946 for path in expected_paths.iter() {
1947 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1949 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1951 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1952 assert_eq!(claim_event.len(), 1);
1953 match claim_event[0] {
1954 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1955 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1956 assert_eq!(preimage, our_payment_preimage),
1957 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1958 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1962 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1964 let mut expected_total_fee_msat = 0;
1966 macro_rules! msgs_from_ev {
1969 &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 } } => {
1970 assert!(update_add_htlcs.is_empty());
1971 assert_eq!(update_fulfill_htlcs.len(), 1);
1972 assert!(update_fail_htlcs.is_empty());
1973 assert!(update_fail_malformed_htlcs.is_empty());
1974 assert!(update_fee.is_none());
1975 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1977 _ => panic!("Unexpected event"),
1981 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1982 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1983 assert_eq!(events.len(), expected_paths.len());
1985 if events.len() == 1 {
1986 per_path_msgs.push(msgs_from_ev!(&events[0]));
1988 for expected_path in expected_paths.iter() {
1989 // For MPP payments, we always want the message to the first node in the path.
1990 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1991 per_path_msgs.push(msgs_from_ev!(&ev));
1992 events = updated_events;
1996 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1997 let mut next_msgs = Some(path_msgs);
1998 let mut expected_next_node = next_hop;
2000 macro_rules! last_update_fulfill_dance {
2001 ($node: expr, $prev_node: expr) => {
2003 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2004 check_added_monitors!($node, 0);
2005 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2006 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2010 macro_rules! mid_update_fulfill_dance {
2011 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2013 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2015 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2016 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2017 .unwrap().lock().unwrap();
2018 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2019 if let Some(prev_config) = channel.prev_config() {
2020 prev_config.forwarding_fee_base_msat
2022 channel.config().forwarding_fee_base_msat
2025 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2026 expected_total_fee_msat += fee as u64;
2027 check_added_monitors!($node, 1);
2028 let new_next_msgs = if $new_msgs {
2029 let events = $node.node.get_and_clear_pending_msg_events();
2030 assert_eq!(events.len(), 1);
2031 let (res, nexthop) = msgs_from_ev!(&events[0]);
2032 expected_next_node = nexthop;
2035 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2038 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2039 next_msgs = new_next_msgs;
2044 let mut prev_node = expected_route.last().unwrap();
2045 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2046 assert_eq!(expected_next_node, node.node.get_our_node_id());
2047 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2048 if next_msgs.is_some() {
2049 // Since we are traversing in reverse, next_node is actually the previous node
2050 let next_node: &Node;
2051 if idx == expected_route.len() - 1 {
2052 next_node = origin_node;
2054 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2056 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2058 assert!(!update_next_msgs);
2059 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2061 if !skip_last && idx == expected_route.len() - 1 {
2062 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2069 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2073 // Ensure that claim_funds is idempotent.
2074 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2075 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2076 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2078 expected_total_fee_msat
2080 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) {
2081 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2083 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2087 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2088 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2091 pub const TEST_FINAL_CLTV: u32 = 70;
2093 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) {
2094 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2095 .with_features(expected_route.last().unwrap().node.invoice_features());
2096 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2097 assert_eq!(route.paths.len(), 1);
2098 assert_eq!(route.paths[0].len(), expected_route.len());
2099 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2100 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2103 let res = send_along_route(origin_node, route, expected_route, recv_value);
2104 (res.0, res.1, res.2)
2107 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2108 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2109 .with_features(expected_route.last().unwrap().node.invoice_features());
2110 let network_graph = origin_node.network_graph.read_only();
2111 let scorer = test_utils::TestScorer::with_penalty(0);
2112 let seed = [0u8; 32];
2113 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2114 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2115 let route = get_route(
2116 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2117 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2118 assert_eq!(route.paths.len(), 1);
2119 assert_eq!(route.paths[0].len(), expected_route.len());
2120 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2121 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2124 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2125 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 },
2126 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2129 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2130 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2131 claim_payment(&origin, expected_route, our_payment_preimage);
2134 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) {
2135 for path in expected_paths.iter() {
2136 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2138 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2139 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2140 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2142 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2145 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) {
2146 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2148 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2149 let events = origin_node.node.get_and_clear_pending_events();
2150 assert_eq!(events.len(), 1);
2152 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2153 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2154 assert_eq!(*payment_id, expected_payment_id.unwrap());
2156 _ => panic!("Unexpected second event"),
2161 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> {
2162 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2163 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2165 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2166 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2167 assert_eq!(events.len(), expected_paths.len());
2168 for ev in events.iter() {
2169 let (update_fail, commitment_signed, node_id) = match ev {
2170 &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 } } => {
2171 assert!(update_add_htlcs.is_empty());
2172 assert!(update_fulfill_htlcs.is_empty());
2173 assert_eq!(update_fail_htlcs.len(), 1);
2174 assert!(update_fail_malformed_htlcs.is_empty());
2175 assert!(update_fee.is_none());
2176 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2178 _ => panic!("Unexpected event"),
2180 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2182 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2183 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()));
2185 let mut expected_payment_id = None;
2187 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2188 let mut next_msgs = Some(path_msgs);
2189 let mut expected_next_node = next_hop;
2190 let mut prev_node = expected_route.last().unwrap();
2192 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2193 assert_eq!(expected_next_node, node.node.get_our_node_id());
2194 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2195 if next_msgs.is_some() {
2196 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2197 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2198 if !update_next_node {
2199 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 }]);
2202 let events = node.node.get_and_clear_pending_msg_events();
2203 if update_next_node {
2204 assert_eq!(events.len(), 1);
2206 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 } } => {
2207 assert!(update_add_htlcs.is_empty());
2208 assert!(update_fulfill_htlcs.is_empty());
2209 assert_eq!(update_fail_htlcs.len(), 1);
2210 assert!(update_fail_malformed_htlcs.is_empty());
2211 assert!(update_fee.is_none());
2212 expected_next_node = node_id.clone();
2213 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2215 _ => panic!("Unexpected event"),
2218 assert!(events.is_empty());
2220 if !skip_last && idx == expected_route.len() - 1 {
2221 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2228 let prev_node = expected_route.first().unwrap();
2229 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2230 check_added_monitors!(origin_node, 0);
2231 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2232 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2233 let events = origin_node.node.get_and_clear_pending_events();
2234 assert_eq!(events.len(), 1);
2235 expected_payment_id = Some(match events[0] {
2236 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2237 assert_eq!(payment_hash, our_payment_hash);
2238 assert!(payment_failed_permanently);
2239 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2240 for (idx, hop) in expected_route.iter().enumerate() {
2241 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2245 _ => panic!("Unexpected event"),
2250 // Ensure that fail_htlc_backwards is idempotent.
2251 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2252 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2253 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2254 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2259 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2260 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2263 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2264 let mut chan_mon_cfgs = Vec::new();
2265 for i in 0..node_count {
2266 let tx_broadcaster = test_utils::TestBroadcaster {
2267 txn_broadcasted: Mutex::new(Vec::new()),
2268 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2270 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2271 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2272 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2273 let persister = test_utils::TestPersister::new();
2274 let seed = [i as u8; 32];
2275 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2277 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2283 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2284 let mut nodes = Vec::new();
2286 for i in 0..node_count {
2287 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);
2288 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2289 let seed = [i as u8; 32];
2290 nodes.push(NodeCfg {
2291 chain_source: &chanmon_cfgs[i].chain_source,
2292 logger: &chanmon_cfgs[i].logger,
2293 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2294 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2295 router: test_utils::TestRouter::new(network_graph.clone()),
2297 keys_manager: &chanmon_cfgs[i].keys_manager,
2300 override_init_features: Rc::new(RefCell::new(None)),
2307 pub fn test_default_channel_config() -> UserConfig {
2308 let mut default_config = UserConfig::default();
2309 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2310 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2311 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2312 default_config.channel_handshake_config.announced_channel = true;
2313 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2314 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2315 // It now defaults to 1, so we simply set it to the expected value here.
2316 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2317 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2318 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2319 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2323 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>> {
2324 let mut chanmgrs = Vec::new();
2325 for i in 0..node_count {
2326 let network = Network::Testnet;
2327 let params = ChainParameters {
2329 best_block: BestBlock::from_genesis(network),
2331 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,
2332 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);
2333 chanmgrs.push(node);
2339 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>> {
2340 let mut nodes = Vec::new();
2341 let chan_count = Rc::new(RefCell::new(0));
2342 let payment_count = Rc::new(RefCell::new(0));
2343 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2345 for i in 0..node_count {
2346 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2348 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2349 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2350 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2351 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2352 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2353 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2354 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2355 connect_style: Rc::clone(&connect_style),
2356 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2360 for i in 0..node_count {
2361 for j in (i+1)..node_count {
2362 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();
2363 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();
2370 // Note that the following only works for CLTV values up to 128
2371 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2373 #[derive(PartialEq)]
2374 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2375 /// Tests that the given node has broadcast transactions for the given Channel
2377 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2378 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2379 /// broadcast and the revoked outputs were claimed.
2381 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2382 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2384 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2386 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> {
2387 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2388 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2390 let mut res = Vec::with_capacity(2);
2391 node_txn.retain(|tx| {
2392 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2393 check_spends!(tx, chan.3);
2394 if commitment_tx.is_none() {
2395 res.push(tx.clone());
2400 if let Some(explicit_tx) = commitment_tx {
2401 res.push(explicit_tx.clone());
2404 assert_eq!(res.len(), 1);
2406 if has_htlc_tx != HTLCType::NONE {
2407 node_txn.retain(|tx| {
2408 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2409 check_spends!(tx, res[0]);
2410 if has_htlc_tx == HTLCType::TIMEOUT {
2411 assert!(tx.lock_time.0 != 0);
2413 assert!(tx.lock_time.0 == 0);
2415 res.push(tx.clone());
2419 assert!(res.len() == 2 || res.len() == 3);
2421 assert_eq!(res[1], res[2]);
2425 assert!(node_txn.is_empty());
2429 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2430 /// HTLC transaction.
2431 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2432 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2433 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2434 // for revoked htlc outputs
2435 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2436 node_txn.retain(|tx| {
2437 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2438 check_spends!(tx, revoked_tx);
2442 node_txn.retain(|tx| {
2443 check_spends!(tx, commitment_revoked_tx);
2446 assert!(node_txn.is_empty());
2449 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2450 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2452 assert!(node_txn.len() >= 1);
2453 assert_eq!(node_txn[0].input.len(), 1);
2454 let mut found_prev = false;
2456 for tx in prev_txn {
2457 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2458 check_spends!(node_txn[0], tx);
2459 let mut iter = node_txn[0].input[0].witness.iter();
2460 iter.next().expect("expected 3 witness items");
2461 iter.next().expect("expected 3 witness items");
2462 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2463 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2469 assert!(found_prev);
2471 let mut res = Vec::new();
2472 mem::swap(&mut *node_txn, &mut res);
2476 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) {
2477 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2478 assert_eq!(events_1.len(), 2);
2479 let as_update = match events_1[0] {
2480 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2483 _ => panic!("Unexpected event"),
2486 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2487 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2488 assert_eq!(msg.data, expected_error);
2489 if needs_err_handle {
2490 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2493 _ => panic!("Unexpected event"),
2496 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2497 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2498 let bs_update = match events_2[0] {
2499 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2502 _ => panic!("Unexpected event"),
2504 if !needs_err_handle {
2506 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2507 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2508 assert_eq!(msg.data, expected_error);
2510 _ => panic!("Unexpected event"),
2515 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2516 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2520 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2521 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2525 macro_rules! get_channel_value_stat {
2526 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2527 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2528 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2529 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2530 chan.get_value_stat()
2534 macro_rules! get_chan_reestablish_msgs {
2535 ($src_node: expr, $dst_node: expr) => {
2537 let mut announcements = $crate::prelude::HashSet::new();
2538 let mut res = Vec::with_capacity(1);
2539 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2540 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2541 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2542 res.push(msg.clone());
2543 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2544 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2545 announcements.insert(msg.contents.short_channel_id);
2547 panic!("Unexpected event")
2550 for chan in $src_node.node.list_channels() {
2551 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2552 if let Some(scid) = chan.short_channel_id {
2553 assert!(announcements.remove(&scid));
2557 assert!(announcements.is_empty());
2563 macro_rules! handle_chan_reestablish_msgs {
2564 ($src_node: expr, $dst_node: expr) => {
2566 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2568 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2570 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2576 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2578 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2581 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2582 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2583 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2585 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2586 had_channel_update = true;
2589 let mut revoke_and_ack = None;
2590 let mut commitment_update = None;
2591 let order = if let Some(ev) = msg_events.get(idx) {
2593 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2594 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2595 revoke_and_ack = Some(msg.clone());
2597 RAACommitmentOrder::RevokeAndACKFirst
2599 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2600 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2601 commitment_update = Some(updates.clone());
2603 RAACommitmentOrder::CommitmentFirst
2605 _ => RAACommitmentOrder::CommitmentFirst,
2608 RAACommitmentOrder::CommitmentFirst
2611 if let Some(ev) = msg_events.get(idx) {
2613 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2614 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2615 assert!(revoke_and_ack.is_none());
2616 revoke_and_ack = Some(msg.clone());
2619 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2620 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2621 assert!(commitment_update.is_none());
2622 commitment_update = Some(updates.clone());
2629 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2630 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2632 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2633 assert!(!had_channel_update);
2636 assert_eq!(msg_events.len(), idx);
2638 (channel_ready, revoke_and_ack, commitment_update, order)
2643 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2644 /// for claims/fails they are separated out.
2645 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)) {
2646 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();
2647 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2648 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();
2649 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2651 if send_channel_ready.0 {
2652 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2654 for reestablish in reestablish_1.iter() {
2655 assert_eq!(reestablish.next_remote_commitment_number, 0);
2658 if send_channel_ready.1 {
2659 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2661 for reestablish in reestablish_2.iter() {
2662 assert_eq!(reestablish.next_remote_commitment_number, 0);
2665 if send_channel_ready.0 || send_channel_ready.1 {
2666 // If we expect any channel_ready's, both sides better have set
2667 // next_holder_commitment_number to 1
2668 for reestablish in reestablish_1.iter() {
2669 assert_eq!(reestablish.next_local_commitment_number, 1);
2671 for reestablish in reestablish_2.iter() {
2672 assert_eq!(reestablish.next_local_commitment_number, 1);
2676 let mut resp_1 = Vec::new();
2677 for msg in reestablish_1 {
2678 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2679 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2681 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2682 check_added_monitors!(node_b, 1);
2684 check_added_monitors!(node_b, 0);
2687 let mut resp_2 = Vec::new();
2688 for msg in reestablish_2 {
2689 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2690 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2692 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2693 check_added_monitors!(node_a, 1);
2695 check_added_monitors!(node_a, 0);
2698 // We don't yet support both needing updates, as that would require a different commitment dance:
2699 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2700 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2701 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2702 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2704 for chan_msgs in resp_1.drain(..) {
2705 if send_channel_ready.0 {
2706 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2707 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2708 if !announcement_event.is_empty() {
2709 assert_eq!(announcement_event.len(), 1);
2710 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2711 //TODO: Test announcement_sigs re-sending
2712 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2715 assert!(chan_msgs.0.is_none());
2718 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2719 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2720 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2721 check_added_monitors!(node_a, 1);
2723 assert!(chan_msgs.1.is_none());
2725 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 {
2726 let commitment_update = chan_msgs.2.unwrap();
2727 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2728 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2730 assert!(commitment_update.update_add_htlcs.is_empty());
2732 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2733 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2734 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2735 for update_add in commitment_update.update_add_htlcs {
2736 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2738 for update_fulfill in commitment_update.update_fulfill_htlcs {
2739 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2741 for update_fail in commitment_update.update_fail_htlcs {
2742 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2745 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2746 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2748 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2749 check_added_monitors!(node_a, 1);
2750 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2751 // No commitment_signed so get_event_msg's assert(len == 1) passes
2752 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2753 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2754 check_added_monitors!(node_b, 1);
2757 assert!(chan_msgs.2.is_none());
2761 for chan_msgs in resp_2.drain(..) {
2762 if send_channel_ready.1 {
2763 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2764 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2765 if !announcement_event.is_empty() {
2766 assert_eq!(announcement_event.len(), 1);
2767 match announcement_event[0] {
2768 MessageSendEvent::SendChannelUpdate { .. } => {},
2769 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2770 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2774 assert!(chan_msgs.0.is_none());
2777 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2778 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2779 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2780 check_added_monitors!(node_b, 1);
2782 assert!(chan_msgs.1.is_none());
2784 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 {
2785 let commitment_update = chan_msgs.2.unwrap();
2786 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2787 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2789 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2790 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2791 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2792 for update_add in commitment_update.update_add_htlcs {
2793 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2795 for update_fulfill in commitment_update.update_fulfill_htlcs {
2796 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2798 for update_fail in commitment_update.update_fail_htlcs {
2799 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2802 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2803 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2805 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2806 check_added_monitors!(node_b, 1);
2807 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2808 // No commitment_signed so get_event_msg's assert(len == 1) passes
2809 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2810 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2811 check_added_monitors!(node_a, 1);
2814 assert!(chan_msgs.2.is_none());