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,
308 pub scorer: Mutex<test_utils::TestScorer>,
311 pub struct NodeCfg<'a> {
312 pub chain_source: &'a test_utils::TestChainSource,
313 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
314 pub fee_estimator: &'a test_utils::TestFeeEstimator,
315 pub router: test_utils::TestRouter<'a>,
316 pub chain_monitor: test_utils::TestChainMonitor<'a>,
317 pub keys_manager: &'a test_utils::TestKeysInterface,
318 pub logger: &'a test_utils::TestLogger,
319 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
320 pub node_seed: [u8; 32],
321 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
324 pub struct Node<'a, 'b: 'a, 'c: 'b> {
325 pub chain_source: &'c test_utils::TestChainSource,
326 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
327 pub fee_estimator: &'c test_utils::TestFeeEstimator,
328 pub router: &'b test_utils::TestRouter<'c>,
329 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
330 pub keys_manager: &'b test_utils::TestKeysInterface,
331 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>,
332 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
333 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
334 pub node_seed: [u8; 32],
335 pub network_payment_count: Rc<RefCell<u8>>,
336 pub network_chan_count: Rc<RefCell<u32>>,
337 pub logger: &'c test_utils::TestLogger,
338 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
339 pub connect_style: Rc<RefCell<ConnectStyle>>,
340 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
342 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
343 pub fn best_block_hash(&self) -> BlockHash {
344 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
346 pub fn best_block_info(&self) -> (BlockHash, u32) {
347 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
349 pub fn get_block_header(&self, height: u32) -> BlockHeader {
350 self.blocks.lock().unwrap()[height as usize].0.header
354 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
357 // Check that we processed all pending events
358 let msg_events = self.node.get_and_clear_pending_msg_events();
359 if !msg_events.is_empty() {
360 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
362 let events = self.node.get_and_clear_pending_events();
363 if !events.is_empty() {
364 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
366 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
367 if !added_monitors.is_empty() {
368 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
371 // Check that if we serialize the network graph, we can deserialize it again.
372 let network_graph = {
373 let mut w = test_utils::TestVecWriter(Vec::new());
374 self.network_graph.write(&mut w).unwrap();
375 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
376 assert!(network_graph_deser == *self.network_graph);
377 let gossip_sync = P2PGossipSync::new(
378 &network_graph_deser, Some(self.chain_source), self.logger
380 let mut chan_progress = 0;
382 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
383 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
384 assert!(orig_announcements == deserialized_announcements);
385 chan_progress = match orig_announcements {
386 Some(announcement) => announcement.0.contents.short_channel_id + 1,
390 let mut node_progress = None;
392 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
393 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
394 assert!(orig_announcements == deserialized_announcements);
395 node_progress = match orig_announcements {
396 Some(announcement) => Some(announcement.contents.node_id),
403 // Check that if we serialize and then deserialize all our channel monitors we get the
404 // same set of outputs to watch for on chain as we have now. Note that if we write
405 // tests that fully close channels and remove the monitors at some point this may break.
406 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
407 let mut deserialized_monitors = Vec::new();
409 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
410 let mut w = test_utils::TestVecWriter(Vec::new());
411 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
412 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
413 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
414 deserialized_monitors.push(deserialized_monitor);
418 let broadcaster = test_utils::TestBroadcaster {
419 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
420 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
423 // Before using all the new monitors to check the watch outpoints, use the full set of
424 // them to ensure we can write and reload our ChannelManager.
426 let mut channel_monitors = HashMap::new();
427 for monitor in deserialized_monitors.iter_mut() {
428 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
431 let scorer = Mutex::new(test_utils::TestScorer::new());
432 let mut w = test_utils::TestVecWriter(Vec::new());
433 self.node.write(&mut w).unwrap();
434 <(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 {
435 default_config: *self.node.get_current_default_configuration(),
436 entropy_source: self.keys_manager,
437 node_signer: self.keys_manager,
438 signer_provider: self.keys_manager,
439 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
440 router: &test_utils::TestRouter::new(Arc::new(network_graph), &scorer),
441 chain_monitor: self.chain_monitor,
442 tx_broadcaster: &broadcaster,
443 logger: &self.logger,
448 let persister = test_utils::TestPersister::new();
449 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
450 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
451 for deserialized_monitor in deserialized_monitors.drain(..) {
452 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
456 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
457 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
462 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) {
463 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
466 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) {
467 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
468 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
469 (announcement, as_update, bs_update, channel_id, tx)
473 /// Gets an RAA and CS which were sent in response to a commitment update
474 macro_rules! get_revoke_commit_msgs {
475 ($node: expr, $node_id: expr) => {
477 use $crate::util::events::MessageSendEvent;
478 let events = $node.node.get_and_clear_pending_msg_events();
479 assert_eq!(events.len(), 2);
481 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
482 assert_eq!(*node_id, $node_id);
485 _ => panic!("Unexpected event"),
487 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
488 assert_eq!(*node_id, $node_id);
489 assert!(updates.update_add_htlcs.is_empty());
490 assert!(updates.update_fulfill_htlcs.is_empty());
491 assert!(updates.update_fail_htlcs.is_empty());
492 assert!(updates.update_fail_malformed_htlcs.is_empty());
493 assert!(updates.update_fee.is_none());
494 updates.commitment_signed.clone()
496 _ => panic!("Unexpected event"),
502 /// Get an specific event message from the pending events queue.
504 macro_rules! get_event_msg {
505 ($node: expr, $event_type: path, $node_id: expr) => {
507 let events = $node.node.get_and_clear_pending_msg_events();
508 assert_eq!(events.len(), 1);
510 $event_type { ref node_id, ref msg } => {
511 assert_eq!(*node_id, $node_id);
514 _ => panic!("Unexpected event"),
520 /// Get an error message from the pending events queue.
522 macro_rules! get_err_msg {
523 ($node: expr, $node_id: expr) => {
525 let events = $node.node.get_and_clear_pending_msg_events();
526 assert_eq!(events.len(), 1);
528 $crate::util::events::MessageSendEvent::HandleError {
529 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
531 assert_eq!(*node_id, $node_id);
534 _ => panic!("Unexpected event"),
540 /// Get a specific event from the pending events queue.
542 macro_rules! get_event {
543 ($node: expr, $event_type: path) => {
545 let mut events = $node.node.get_and_clear_pending_events();
546 assert_eq!(events.len(), 1);
547 let ev = events.pop().unwrap();
549 $event_type { .. } => {
552 _ => panic!("Unexpected event"),
559 /// Gets an UpdateHTLCs MessageSendEvent
560 macro_rules! get_htlc_update_msgs {
561 ($node: expr, $node_id: expr) => {
563 let events = $node.node.get_and_clear_pending_msg_events();
564 assert_eq!(events.len(), 1);
566 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
567 assert_eq!(*node_id, $node_id);
570 _ => panic!("Unexpected event"),
576 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
577 /// Returns the `msg_event`.
579 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
580 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
581 /// such messages are intended to all peers.
582 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &mut Vec<MessageSendEvent>) -> MessageSendEvent {
583 let ev_index = msg_events.iter().position(|e| { match e {
584 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
585 node_id == msg_node_id
587 MessageSendEvent::SendOpenChannel { node_id, .. } => {
588 node_id == msg_node_id
590 MessageSendEvent::SendFundingCreated { node_id, .. } => {
591 node_id == msg_node_id
593 MessageSendEvent::SendFundingSigned { node_id, .. } => {
594 node_id == msg_node_id
596 MessageSendEvent::SendChannelReady { node_id, .. } => {
597 node_id == msg_node_id
599 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
600 node_id == msg_node_id
602 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
603 node_id == msg_node_id
605 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
606 node_id == msg_node_id
608 MessageSendEvent::SendClosingSigned { node_id, .. } => {
609 node_id == msg_node_id
611 MessageSendEvent::SendShutdown { node_id, .. } => {
612 node_id == msg_node_id
614 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
615 node_id == msg_node_id
617 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
618 node_id == msg_node_id
620 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
623 MessageSendEvent::BroadcastChannelUpdate { .. } => {
626 MessageSendEvent::BroadcastNodeAnnouncement { .. } => {
629 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
630 node_id == msg_node_id
632 MessageSendEvent::HandleError { node_id, .. } => {
633 node_id == msg_node_id
635 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
636 node_id == msg_node_id
638 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
639 node_id == msg_node_id
641 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
642 node_id == msg_node_id
644 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
645 node_id == msg_node_id
648 if ev_index.is_some() {
649 msg_events.remove(ev_index.unwrap())
651 panic!("Couldn't find any MessageSendEvent to the node!")
656 macro_rules! get_channel_ref {
657 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
659 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
660 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
661 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
667 macro_rules! get_feerate {
668 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
670 let mut per_peer_state_lock;
671 let mut peer_state_lock;
672 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
679 macro_rules! get_opt_anchors {
680 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
682 let mut per_peer_state_lock;
683 let mut peer_state_lock;
684 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
690 /// Returns a channel monitor given a channel id, making some naive assumptions
692 macro_rules! get_monitor {
693 ($node: expr, $channel_id: expr) => {
695 use bitcoin::hashes::Hash;
696 let mut monitor = None;
697 // Assume funding vout is either 0 or 1 blindly
699 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
700 $crate::chain::transaction::OutPoint {
701 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
713 /// Returns any local commitment transactions for the channel.
715 macro_rules! get_local_commitment_txn {
716 ($node: expr, $channel_id: expr) => {
718 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
723 /// Check the error from attempting a payment.
725 macro_rules! unwrap_send_err {
726 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
728 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
729 assert_eq!(fails.len(), 1);
735 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
736 assert_eq!(results.len(), 1);
738 Err($type) => { $check },
747 /// Check whether N channel monitor(s) have been added.
749 macro_rules! check_added_monitors {
750 ($node: expr, $count: expr) => {
752 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
753 assert_eq!(added_monitors.len(), $count);
754 added_monitors.clear();
759 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> {
760 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
761 for encoded in monitors_encoded {
762 let mut monitor_read = &encoded[..];
763 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
764 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
765 assert!(monitor_read.is_empty());
766 monitors_read.push(monitor);
769 let mut node_read = &chanman_encoded[..];
770 let (_, node_deserialized) = {
771 let mut channel_monitors = HashMap::new();
772 for monitor in monitors_read.iter_mut() {
773 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
775 <(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 {
777 entropy_source: node.keys_manager,
778 node_signer: node.keys_manager,
779 signer_provider: node.keys_manager,
780 fee_estimator: node.fee_estimator,
782 chain_monitor: node.chain_monitor,
783 tx_broadcaster: node.tx_broadcaster,
788 assert!(node_read.is_empty());
790 for monitor in monitors_read.drain(..) {
791 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
792 ChannelMonitorUpdateStatus::Completed);
793 check_added_monitors!(node, 1);
800 macro_rules! reload_node {
801 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
802 let chanman_encoded = $chanman_encoded;
804 $persister = test_utils::TestPersister::new();
805 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
806 $node.chain_monitor = &$new_chain_monitor;
808 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
809 $node.node = &$new_channelmanager;
811 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
812 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
816 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) {
817 let chan_id = *node.network_chan_count.borrow();
819 let events = node.node.get_and_clear_pending_events();
820 assert_eq!(events.len(), 1);
822 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
823 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
824 assert_eq!(*channel_value_satoshis, expected_chan_value);
825 assert_eq!(user_channel_id, expected_user_chan_id);
827 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
828 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
830 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
831 (*temporary_channel_id, tx, funding_outpoint)
833 _ => panic!("Unexpected event"),
836 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 {
837 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
838 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
840 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
841 check_added_monitors!(node_a, 0);
843 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
844 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
845 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
847 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
848 assert_eq!(added_monitors.len(), 1);
849 assert_eq!(added_monitors[0].0, funding_output);
850 added_monitors.clear();
853 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()));
855 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
856 assert_eq!(added_monitors.len(), 1);
857 assert_eq!(added_monitors[0].0, funding_output);
858 added_monitors.clear();
861 let events_4 = node_a.node.get_and_clear_pending_events();
862 assert_eq!(events_4.len(), 0);
864 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
865 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
866 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
868 // Ensure that funding_transaction_generated is idempotent.
869 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
870 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
871 check_added_monitors!(node_a, 0);
876 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
877 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]) {
878 let initiator_channels = initiator.node.list_usable_channels().len();
879 let receiver_channels = receiver.node.list_usable_channels().len();
881 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
882 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
884 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), &open_channel);
885 let events = receiver.node.get_and_clear_pending_events();
886 assert_eq!(events.len(), 1);
888 Event::OpenChannelRequest { temporary_channel_id, .. } => {
889 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
891 _ => panic!("Unexpected event"),
894 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
895 assert_eq!(accept_channel.minimum_depth, 0);
896 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), &accept_channel);
898 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
899 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
900 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
902 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
903 check_added_monitors!(receiver, 1);
904 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
905 assert_eq!(bs_signed_locked.len(), 2);
906 let as_channel_ready;
907 match &bs_signed_locked[0] {
908 MessageSendEvent::SendFundingSigned { node_id, msg } => {
909 assert_eq!(*node_id, initiator.node.get_our_node_id());
910 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
911 check_added_monitors!(initiator, 1);
913 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
914 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
916 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
918 _ => panic!("Unexpected event"),
920 match &bs_signed_locked[1] {
921 MessageSendEvent::SendChannelReady { node_id, msg } => {
922 assert_eq!(*node_id, initiator.node.get_our_node_id());
923 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
925 _ => panic!("Unexpected event"),
928 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
930 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
931 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
933 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
934 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
936 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
937 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
939 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
940 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
942 (tx, as_channel_ready.channel_id)
945 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 {
946 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
947 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
948 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
949 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
950 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
951 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
952 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
953 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
954 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
956 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
959 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) {
960 confirm_transaction_at(node_conf, tx, conf_height);
961 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
962 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()));
965 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]) {
967 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
968 assert_eq!(events_6.len(), 3);
969 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
970 assert_eq!(*node_id, node_recv.node.get_our_node_id());
972 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
973 assert_eq!(*node_id, node_recv.node.get_our_node_id());
975 } else { panic!("Unexpected event: {:?}", events_6[1]); };
976 ((match events_6[0] {
977 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
978 channel_id = msg.channel_id.clone();
979 assert_eq!(*node_id, node_recv.node.get_our_node_id());
982 _ => panic!("Unexpected event"),
983 }, match events_6[announcement_sigs_idx] {
984 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
985 assert_eq!(*node_id, node_recv.node.get_our_node_id());
988 _ => panic!("Unexpected event"),
992 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]) {
993 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
994 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
995 confirm_transaction_at(node_a, tx, conf_height);
996 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
997 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
998 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
1001 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) {
1002 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
1003 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
1007 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) {
1008 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
1009 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
1010 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1012 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1013 assert_eq!(events_7.len(), 1);
1014 let (announcement, bs_update) = match events_7[0] {
1015 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1016 (msg, update_msg.clone().unwrap())
1018 _ => panic!("Unexpected event"),
1021 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1022 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1023 assert_eq!(events_8.len(), 1);
1024 let as_update = match events_8[0] {
1025 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1026 assert!(*announcement == *msg);
1027 let update_msg = update_msg.clone().unwrap();
1028 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1029 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1032 _ => panic!("Unexpected event"),
1035 *node_a.network_chan_count.borrow_mut() += 1;
1037 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1038 ((*announcement).clone(), as_update, bs_update)
1041 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) {
1042 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1045 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) {
1046 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1047 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1048 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1051 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) {
1052 let mut no_announce_cfg = test_default_channel_config();
1053 no_announce_cfg.channel_handshake_config.announced_channel = false;
1054 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1055 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1056 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1057 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1058 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1060 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1061 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1062 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()));
1063 check_added_monitors!(nodes[b], 1);
1065 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1066 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1067 check_added_monitors!(nodes[a], 1);
1069 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1070 confirm_transaction_at(&nodes[a], &tx, conf_height);
1071 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1072 confirm_transaction_at(&nodes[b], &tx, conf_height);
1073 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1074 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1075 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()));
1076 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1077 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1078 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1079 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1080 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1082 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1083 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1085 let mut found_a = false;
1086 for chan in nodes[a].node.list_usable_channels() {
1087 if chan.channel_id == as_channel_ready.channel_id {
1090 assert!(!chan.is_public);
1095 let mut found_b = false;
1096 for chan in nodes[b].node.list_usable_channels() {
1097 if chan.channel_id == as_channel_ready.channel_id {
1100 assert!(!chan.is_public);
1105 (as_channel_ready, tx)
1108 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) {
1110 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1111 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1112 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1114 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1115 // forwarding info for local channels even if its not accepted in the network graph.
1116 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1117 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1122 macro_rules! check_spends {
1123 ($tx: expr, $($spends_txn: expr),*) => {
1126 for outp in $spends_txn.output.iter() {
1127 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1130 for outp in $tx.output.iter() {
1131 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1133 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1135 if out_point.txid == $spends_txn.txid() {
1136 return $spends_txn.output.get(out_point.vout as usize).cloned()
1141 let mut total_value_in = 0;
1142 for input in $tx.input.iter() {
1143 total_value_in += get_output(&input.previous_output).unwrap().value;
1145 let mut total_value_out = 0;
1146 for output in $tx.output.iter() {
1147 total_value_out += output.value;
1149 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1150 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1151 assert!(total_value_out + min_fee <= total_value_in);
1152 $tx.verify(get_output).unwrap();
1157 macro_rules! get_closing_signed_broadcast {
1158 ($node: expr, $dest_pubkey: expr) => {
1160 let events = $node.get_and_clear_pending_msg_events();
1161 assert!(events.len() == 1 || events.len() == 2);
1162 (match events[events.len() - 1] {
1163 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1164 assert_eq!(msg.contents.flags & 2, 2);
1167 _ => panic!("Unexpected event"),
1168 }, if events.len() == 2 {
1170 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1171 assert_eq!(*node_id, $dest_pubkey);
1174 _ => panic!("Unexpected event"),
1182 macro_rules! check_warn_msg {
1183 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1184 let msg_events = $node.node.get_and_clear_pending_msg_events();
1185 assert_eq!(msg_events.len(), 1);
1186 match msg_events[0] {
1187 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1188 assert_eq!(node_id, $recipient_node_id);
1189 assert_eq!(msg.channel_id, $chan_id);
1192 _ => panic!("Unexpected event"),
1197 /// Check that a channel's closing channel update has been broadcasted, and optionally
1198 /// check whether an error message event has occurred.
1200 macro_rules! check_closed_broadcast {
1201 ($node: expr, $with_error_msg: expr) => {{
1202 use $crate::util::events::MessageSendEvent;
1203 use $crate::ln::msgs::ErrorAction;
1205 let msg_events = $node.node.get_and_clear_pending_msg_events();
1206 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1207 match msg_events[0] {
1208 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1209 assert_eq!(msg.contents.flags & 2, 2);
1211 _ => panic!("Unexpected event"),
1213 if $with_error_msg {
1214 match msg_events[1] {
1215 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1216 // TODO: Check node_id
1219 _ => panic!("Unexpected event"),
1225 /// Check that a channel's closing channel events has been issued
1227 macro_rules! check_closed_event {
1228 ($node: expr, $events: expr, $reason: expr) => {
1229 check_closed_event!($node, $events, $reason, false);
1231 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1232 use $crate::util::events::Event;
1234 let events = $node.node.get_and_clear_pending_events();
1235 assert_eq!(events.len(), $events, "{:?}", events);
1236 let expected_reason = $reason;
1237 let mut issues_discard_funding = false;
1238 for event in events {
1240 Event::ChannelClosed { ref reason, .. } => {
1241 assert_eq!(*reason, expected_reason);
1243 Event::DiscardFunding { .. } => {
1244 issues_discard_funding = true;
1246 _ => panic!("Unexpected event"),
1249 assert_eq!($is_check_discard_funding, issues_discard_funding);
1253 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) {
1254 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) };
1255 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) };
1258 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1259 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1261 let events_1 = node_b.get_and_clear_pending_msg_events();
1262 assert!(events_1.len() >= 1);
1263 let shutdown_b = match events_1[0] {
1264 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1265 assert_eq!(node_id, &node_a.get_our_node_id());
1268 _ => panic!("Unexpected event"),
1271 let closing_signed_b = if !close_inbound_first {
1272 assert_eq!(events_1.len(), 1);
1275 Some(match events_1[1] {
1276 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1277 assert_eq!(node_id, &node_a.get_our_node_id());
1280 _ => panic!("Unexpected event"),
1284 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1285 let (as_update, bs_update) = if close_inbound_first {
1286 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1287 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1289 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1290 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1291 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1292 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1294 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1295 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1296 assert!(none_a.is_none());
1297 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1298 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1299 (as_update, bs_update)
1301 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1303 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1304 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1306 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1307 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1308 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1310 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1311 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1312 assert!(none_b.is_none());
1313 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1314 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1315 (as_update, bs_update)
1317 assert_eq!(tx_a, tx_b);
1318 check_spends!(tx_a, funding_tx);
1320 (as_update, bs_update, tx_a)
1323 pub struct SendEvent {
1324 pub node_id: PublicKey,
1325 pub msgs: Vec<msgs::UpdateAddHTLC>,
1326 pub commitment_msg: msgs::CommitmentSigned,
1329 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1330 assert!(updates.update_fulfill_htlcs.is_empty());
1331 assert!(updates.update_fail_htlcs.is_empty());
1332 assert!(updates.update_fail_malformed_htlcs.is_empty());
1333 assert!(updates.update_fee.is_none());
1334 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1337 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1339 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1340 _ => panic!("Unexpected event type!"),
1344 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1345 let mut events = node.node.get_and_clear_pending_msg_events();
1346 assert_eq!(events.len(), 1);
1347 SendEvent::from_event(events.pop().unwrap())
1352 macro_rules! expect_pending_htlcs_forwardable_conditions {
1353 ($node: expr, $expected_failures: expr) => {{
1354 let expected_failures = $expected_failures;
1355 let events = $node.node.get_and_clear_pending_events();
1357 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1358 _ => panic!("Unexpected event {:?}", events),
1361 let count = expected_failures.len() + 1;
1362 assert_eq!(events.len(), count);
1364 if expected_failures.len() > 0 {
1365 expect_htlc_handling_failed_destinations!(events, expected_failures)
1371 macro_rules! expect_htlc_handling_failed_destinations {
1372 ($events: expr, $expected_failures: expr) => {{
1373 for event in $events {
1375 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1376 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1377 assert!($expected_failures.contains(&failed_next_destination))
1379 _ => panic!("Unexpected destination"),
1386 /// Clears (and ignores) a PendingHTLCsForwardable event
1387 macro_rules! expect_pending_htlcs_forwardable_ignore {
1389 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1394 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1395 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1396 ($node: expr, $expected_failures: expr) => {{
1397 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1402 /// Handles a PendingHTLCsForwardable event
1403 macro_rules! expect_pending_htlcs_forwardable {
1405 expect_pending_htlcs_forwardable_ignore!($node);
1406 $node.node.process_pending_htlc_forwards();
1408 // Ensure process_pending_htlc_forwards is idempotent.
1409 $node.node.process_pending_htlc_forwards();
1414 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1415 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1416 ($node: expr, $expected_failures: expr) => {{
1417 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1418 $node.node.process_pending_htlc_forwards();
1420 // Ensure process_pending_htlc_forwards is idempotent.
1421 $node.node.process_pending_htlc_forwards();
1426 macro_rules! expect_pending_htlcs_forwardable_from_events {
1427 ($node: expr, $events: expr, $ignore: expr) => {{
1428 assert_eq!($events.len(), 1);
1430 Event::PendingHTLCsForwardable { .. } => { },
1431 _ => panic!("Unexpected event"),
1434 $node.node.process_pending_htlc_forwards();
1436 // Ensure process_pending_htlc_forwards is idempotent.
1437 $node.node.process_pending_htlc_forwards();
1443 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1444 /// commitment update.
1445 macro_rules! commitment_signed_dance {
1446 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1447 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, true);
1449 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1450 $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards)
1452 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1454 check_added_monitors!($node_a, 0);
1455 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1456 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1457 check_added_monitors!($node_a, 1);
1458 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1459 assert!(extra_msg_option.is_none());
1463 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1465 let (extra_msg_option, bs_revoke_and_ack) = $crate::ln::functional_test_utils::do_main_commitment_signed_dance(&$node_a, &$node_b, $fail_backwards);
1466 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1467 check_added_monitors!($node_a, 1);
1471 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1472 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1474 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1475 $crate::ln::functional_test_utils::do_commitment_signed_dance(&$node_a, &$node_b, &$commitment_signed, $fail_backwards, false);
1480 pub fn do_main_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, fail_backwards: bool) -> (Option<MessageSendEvent>, msgs::RevokeAndACK) {
1481 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(node_a, node_b.node.get_our_node_id());
1482 check_added_monitors!(node_b, 0);
1483 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1484 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
1485 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
1486 check_added_monitors!(node_b, 1);
1487 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &as_commitment_signed);
1488 let (bs_revoke_and_ack, extra_msg_option) = {
1489 let mut events = node_b.node.get_and_clear_pending_msg_events();
1490 assert!(events.len() <= 2);
1491 let node_a_event = remove_first_msg_event_to_node(&node_a.node.get_our_node_id(), &mut events);
1492 (match node_a_event {
1493 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1494 assert_eq!(*node_id, node_a.node.get_our_node_id());
1497 _ => panic!("Unexpected event"),
1498 }, events.get(0).map(|e| e.clone()))
1500 check_added_monitors!(node_b, 1);
1502 assert!(node_a.node.get_and_clear_pending_events().is_empty());
1503 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1505 (extra_msg_option, bs_revoke_and_ack)
1508 pub fn do_commitment_signed_dance(node_a: &Node<'_, '_, '_>, node_b: &Node<'_, '_, '_>, commitment_signed: &msgs::CommitmentSigned, fail_backwards: bool, skip_last_step: bool) {
1509 check_added_monitors!(node_a, 0);
1510 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1511 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), commitment_signed);
1512 check_added_monitors!(node_a, 1);
1514 commitment_signed_dance!(node_a, node_b, (), fail_backwards, true, false);
1516 if skip_last_step { return; }
1519 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(node_a,
1520 vec![crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some(node_b.node.get_our_node_id()), channel_id: commitment_signed.channel_id }]);
1521 check_added_monitors!(node_a, 1);
1523 let node_a_per_peer_state = node_a.node.per_peer_state.read().unwrap();
1524 let mut number_of_msg_events = 0;
1525 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1526 let peer_state = peer_state_mutex.lock().unwrap();
1527 let cp_pending_msg_events = &peer_state.pending_msg_events;
1528 number_of_msg_events += cp_pending_msg_events.len();
1529 if cp_pending_msg_events.len() == 1 {
1530 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1531 assert_ne!(*cp_id, node_b.node.get_our_node_id());
1532 } else { panic!("Unexpected event"); }
1535 // Expecting the failure backwards event to the previous hop (not `node_b`)
1536 assert_eq!(number_of_msg_events, 1);
1538 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
1542 /// Get a payment preimage and hash.
1544 macro_rules! get_payment_preimage_hash {
1545 ($dest_node: expr) => {
1547 get_payment_preimage_hash!($dest_node, None)
1550 ($dest_node: expr, $min_value_msat: expr) => {
1552 crate::get_payment_preimage_hash!($dest_node, $min_value_msat, None)
1555 ($dest_node: expr, $min_value_msat: expr, $min_final_cltv_expiry_delta: expr) => {
1557 use bitcoin::hashes::Hash as _;
1558 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1559 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1560 *payment_count += 1;
1561 let payment_hash = $crate::ln::PaymentHash(
1562 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1563 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200, $min_final_cltv_expiry_delta).unwrap();
1564 (payment_preimage, payment_hash, payment_secret)
1570 macro_rules! get_route {
1571 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1572 use $crate::chain::keysinterface::EntropySource;
1573 let scorer = $crate::util::test_utils::TestScorer::new();
1574 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1575 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1576 $crate::routing::router::get_route(
1577 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1578 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1579 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1586 macro_rules! get_route_and_payment_hash {
1587 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1588 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id(), TEST_FINAL_CLTV)
1589 .with_features($recv_node.node.invoice_features());
1590 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1592 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1593 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1594 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1595 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1600 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1601 macro_rules! expect_payment_claimable {
1602 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1603 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1605 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1606 let events = $node.node.get_and_clear_pending_events();
1607 assert_eq!(events.len(), 1);
1609 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1610 assert_eq!($expected_payment_hash, *payment_hash);
1611 assert_eq!($expected_recv_value, amount_msat);
1612 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1614 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1615 assert_eq!(&$expected_payment_preimage, payment_preimage);
1616 assert_eq!($expected_payment_secret, *payment_secret);
1621 _ => panic!("Unexpected event"),
1627 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1628 macro_rules! expect_payment_claimed {
1629 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1630 let events = $node.node.get_and_clear_pending_events();
1631 assert_eq!(events.len(), 1);
1633 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1634 assert_eq!($expected_payment_hash, *payment_hash);
1635 assert_eq!($expected_recv_value, amount_msat);
1637 _ => panic!("Unexpected event"),
1644 macro_rules! expect_payment_sent_without_paths {
1645 ($node: expr, $expected_payment_preimage: expr) => {
1646 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1648 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1649 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1654 macro_rules! expect_payment_sent {
1655 ($node: expr, $expected_payment_preimage: expr) => {
1656 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1658 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1659 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1661 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1662 use bitcoin::hashes::Hash as _;
1663 let events = $node.node.get_and_clear_pending_events();
1664 let expected_payment_hash = $crate::ln::PaymentHash(
1665 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1667 assert!(events.len() > 1);
1669 assert_eq!(events.len(), 1);
1671 let expected_payment_id = match events[0] {
1672 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1673 assert_eq!($expected_payment_preimage, *payment_preimage);
1674 assert_eq!(expected_payment_hash, *payment_hash);
1675 assert!(fee_paid_msat.is_some());
1676 if $expected_fee_msat_opt.is_some() {
1677 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1681 _ => panic!("Unexpected event"),
1684 for i in 1..events.len() {
1686 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1687 assert_eq!(payment_id, expected_payment_id);
1688 assert_eq!(payment_hash, Some(expected_payment_hash));
1690 _ => panic!("Unexpected event"),
1699 macro_rules! expect_payment_path_successful {
1701 let events = $node.node.get_and_clear_pending_events();
1702 assert_eq!(events.len(), 1);
1704 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1705 _ => panic!("Unexpected event"),
1710 macro_rules! expect_payment_forwarded {
1711 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1712 let events = $node.node.get_and_clear_pending_events();
1713 assert_eq!(events.len(), 1);
1715 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1716 assert_eq!(fee_earned_msat, $expected_fee);
1717 if fee_earned_msat.is_some() {
1718 // Is the event prev_channel_id in one of the channels between the two nodes?
1719 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()));
1721 // We check for force closures since a force closed channel is removed from the
1722 // node's channel list
1723 if !$downstream_force_closed {
1724 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()));
1726 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1728 _ => panic!("Unexpected event"),
1733 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1734 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1735 let events = node.node.get_and_clear_pending_events();
1736 assert_eq!(events.len(), 1);
1738 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1739 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1741 _ => panic!("Unexpected event"),
1746 pub struct PaymentFailedConditions<'a> {
1747 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1748 pub(crate) expected_blamed_scid: Option<u64>,
1749 pub(crate) expected_blamed_chan_closed: Option<bool>,
1750 pub(crate) expected_mpp_parts_remain: bool,
1753 impl<'a> PaymentFailedConditions<'a> {
1754 pub fn new() -> Self {
1756 expected_htlc_error_data: None,
1757 expected_blamed_scid: None,
1758 expected_blamed_chan_closed: None,
1759 expected_mpp_parts_remain: false,
1762 pub fn mpp_parts_remain(mut self) -> Self {
1763 self.expected_mpp_parts_remain = true;
1766 pub fn blamed_scid(mut self, scid: u64) -> Self {
1767 self.expected_blamed_scid = Some(scid);
1770 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1771 self.expected_blamed_chan_closed = Some(closed);
1774 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1775 self.expected_htlc_error_data = Some((code, data));
1781 macro_rules! expect_payment_failed_with_update {
1782 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1783 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1784 &$node, $expected_payment_hash, $payment_failed_permanently,
1785 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1786 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1791 macro_rules! expect_payment_failed {
1792 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1793 #[allow(unused_mut)]
1794 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1796 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1798 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1802 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1803 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1804 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1806 let expected_payment_id = match payment_failed_event {
1807 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1811 error_data, .. } => {
1812 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1813 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1814 assert!(retry.is_some(), "expected retry.is_some()");
1815 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1816 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1817 if let Some(scid) = short_channel_id {
1818 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1823 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1824 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1825 if let Some((code, data)) = conditions.expected_htlc_error_data {
1826 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1827 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1831 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1832 match network_update {
1833 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1834 if let Some(scid) = conditions.expected_blamed_scid {
1835 assert_eq!(msg.contents.short_channel_id, scid);
1837 const CHAN_DISABLED_FLAG: u8 = 2;
1838 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1840 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1841 if let Some(scid) = conditions.expected_blamed_scid {
1842 assert_eq!(short_channel_id, scid);
1844 assert!(is_permanent);
1846 Some(_) => panic!("Unexpected update type"),
1847 None => panic!("Expected update"),
1853 _ => panic!("Unexpected event"),
1855 if !conditions.expected_mpp_parts_remain {
1856 node.node.abandon_payment(expected_payment_id);
1857 let events = node.node.get_and_clear_pending_events();
1858 assert_eq!(events.len(), 1);
1860 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1861 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1862 assert_eq!(*payment_id, expected_payment_id);
1864 _ => panic!("Unexpected second event"),
1869 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1870 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1871 conditions: PaymentFailedConditions<'e>
1873 let mut events = node.node.get_and_clear_pending_events();
1874 assert_eq!(events.len(), 1);
1875 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1878 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 {
1879 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1880 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1881 check_added_monitors!(origin_node, expected_paths.len());
1882 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1886 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>) {
1887 let mut payment_event = SendEvent::from_event(ev);
1888 let mut prev_node = origin_node;
1890 for (idx, &node) in expected_path.iter().enumerate() {
1891 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1893 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1894 check_added_monitors!(node, 0);
1895 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1897 expect_pending_htlcs_forwardable!(node);
1899 if idx == expected_path.len() - 1 && clear_recipient_events {
1900 let events_2 = node.node.get_and_clear_pending_events();
1901 if payment_claimable_expected {
1902 assert_eq!(events_2.len(), 1);
1904 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1905 assert_eq!(our_payment_hash, *payment_hash);
1906 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1908 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1909 assert_eq!(expected_preimage, *payment_preimage);
1910 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1912 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1913 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1914 assert!(our_payment_secret.is_none());
1917 assert_eq!(amount_msat, recv_value);
1918 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1919 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1921 _ => panic!("Unexpected event"),
1924 assert!(events_2.is_empty());
1926 } else if idx != expected_path.len() - 1 {
1927 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1928 assert_eq!(events_2.len(), 1);
1929 check_added_monitors!(node, 1);
1930 payment_event = SendEvent::from_event(events_2.remove(0));
1931 assert_eq!(payment_event.msgs.len(), 1);
1938 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>) {
1939 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1942 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) {
1943 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1944 assert_eq!(events.len(), expected_route.len());
1945 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1946 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
1947 // Once we've gotten through all the HTLCs, the last one should result in a
1948 // PaymentClaimable (but each previous one should not!), .
1949 let expect_payment = path_idx == expected_route.len() - 1;
1950 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1954 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) {
1955 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1956 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1957 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1960 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 {
1961 for path in expected_paths.iter() {
1962 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1964 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1966 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1967 assert_eq!(claim_event.len(), 1);
1968 match claim_event[0] {
1969 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1970 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1971 assert_eq!(preimage, our_payment_preimage),
1972 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1973 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1977 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1979 let mut expected_total_fee_msat = 0;
1981 macro_rules! msgs_from_ev {
1984 &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 } } => {
1985 assert!(update_add_htlcs.is_empty());
1986 assert_eq!(update_fulfill_htlcs.len(), 1);
1987 assert!(update_fail_htlcs.is_empty());
1988 assert!(update_fail_malformed_htlcs.is_empty());
1989 assert!(update_fee.is_none());
1990 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1992 _ => panic!("Unexpected event"),
1996 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1997 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1998 assert_eq!(events.len(), expected_paths.len());
2000 if events.len() == 1 {
2001 per_path_msgs.push(msgs_from_ev!(&events[0]));
2003 for expected_path in expected_paths.iter() {
2004 // For MPP payments, we always want the message to the first node in the path.
2005 let ev = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &mut events);
2006 per_path_msgs.push(msgs_from_ev!(&ev));
2010 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
2011 let mut next_msgs = Some(path_msgs);
2012 let mut expected_next_node = next_hop;
2014 macro_rules! last_update_fulfill_dance {
2015 ($node: expr, $prev_node: expr) => {
2017 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2018 check_added_monitors!($node, 0);
2019 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2020 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2024 macro_rules! mid_update_fulfill_dance {
2025 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2027 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2029 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2030 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2031 .unwrap().lock().unwrap();
2032 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2033 if let Some(prev_config) = channel.prev_config() {
2034 prev_config.forwarding_fee_base_msat
2036 channel.config().forwarding_fee_base_msat
2039 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2040 expected_total_fee_msat += fee as u64;
2041 check_added_monitors!($node, 1);
2042 let new_next_msgs = if $new_msgs {
2043 let events = $node.node.get_and_clear_pending_msg_events();
2044 assert_eq!(events.len(), 1);
2045 let (res, nexthop) = msgs_from_ev!(&events[0]);
2046 expected_next_node = nexthop;
2049 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2052 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2053 next_msgs = new_next_msgs;
2058 let mut prev_node = expected_route.last().unwrap();
2059 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2060 assert_eq!(expected_next_node, node.node.get_our_node_id());
2061 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2062 if next_msgs.is_some() {
2063 // Since we are traversing in reverse, next_node is actually the previous node
2064 let next_node: &Node;
2065 if idx == expected_route.len() - 1 {
2066 next_node = origin_node;
2068 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2070 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2072 assert!(!update_next_msgs);
2073 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2075 if !skip_last && idx == expected_route.len() - 1 {
2076 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2083 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2087 // Ensure that claim_funds is idempotent.
2088 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2089 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2090 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2092 expected_total_fee_msat
2094 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) {
2095 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2097 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2101 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2102 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2105 pub const TEST_FINAL_CLTV: u32 = 70;
2107 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) {
2108 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2109 .with_features(expected_route.last().unwrap().node.invoice_features());
2110 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2111 assert_eq!(route.paths.len(), 1);
2112 assert_eq!(route.paths[0].len(), expected_route.len());
2113 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2114 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2117 let res = send_along_route(origin_node, route, expected_route, recv_value);
2118 (res.0, res.1, res.2)
2121 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2122 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id(), TEST_FINAL_CLTV)
2123 .with_features(expected_route.last().unwrap().node.invoice_features());
2124 let network_graph = origin_node.network_graph.read_only();
2125 let scorer = test_utils::TestScorer::new();
2126 let seed = [0u8; 32];
2127 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2128 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2129 let route = get_route(
2130 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2131 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2132 assert_eq!(route.paths.len(), 1);
2133 assert_eq!(route.paths[0].len(), expected_route.len());
2134 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2135 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2138 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2139 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 },
2140 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2143 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2144 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2145 claim_payment(&origin, expected_route, our_payment_preimage);
2148 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) {
2149 for path in expected_paths.iter() {
2150 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2152 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2153 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2154 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2156 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2159 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) {
2160 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2162 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2163 let events = origin_node.node.get_and_clear_pending_events();
2164 assert_eq!(events.len(), 1);
2166 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2167 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2168 assert_eq!(*payment_id, expected_payment_id.unwrap());
2170 _ => panic!("Unexpected second event"),
2175 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> {
2176 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2177 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2179 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2180 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2181 assert_eq!(events.len(), expected_paths.len());
2182 for ev in events.iter() {
2183 let (update_fail, commitment_signed, node_id) = match ev {
2184 &MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
2185 assert!(update_add_htlcs.is_empty());
2186 assert!(update_fulfill_htlcs.is_empty());
2187 assert_eq!(update_fail_htlcs.len(), 1);
2188 assert!(update_fail_malformed_htlcs.is_empty());
2189 assert!(update_fee.is_none());
2190 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2192 _ => panic!("Unexpected event"),
2194 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2196 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2197 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()));
2199 let mut expected_payment_id = None;
2201 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2202 let mut next_msgs = Some(path_msgs);
2203 let mut expected_next_node = next_hop;
2204 let mut prev_node = expected_route.last().unwrap();
2206 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2207 assert_eq!(expected_next_node, node.node.get_our_node_id());
2208 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2209 if next_msgs.is_some() {
2210 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2211 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2212 if !update_next_node {
2213 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 }]);
2216 let events = node.node.get_and_clear_pending_msg_events();
2217 if update_next_node {
2218 assert_eq!(events.len(), 1);
2220 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 } } => {
2221 assert!(update_add_htlcs.is_empty());
2222 assert!(update_fulfill_htlcs.is_empty());
2223 assert_eq!(update_fail_htlcs.len(), 1);
2224 assert!(update_fail_malformed_htlcs.is_empty());
2225 assert!(update_fee.is_none());
2226 expected_next_node = node_id.clone();
2227 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2229 _ => panic!("Unexpected event"),
2232 assert!(events.is_empty());
2234 if !skip_last && idx == expected_route.len() - 1 {
2235 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2242 let prev_node = expected_route.first().unwrap();
2243 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2244 check_added_monitors!(origin_node, 0);
2245 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2246 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2247 let events = origin_node.node.get_and_clear_pending_events();
2248 assert_eq!(events.len(), 1);
2249 expected_payment_id = Some(match events[0] {
2250 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2251 assert_eq!(payment_hash, our_payment_hash);
2252 assert!(payment_failed_permanently);
2253 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2254 for (idx, hop) in expected_route.iter().enumerate() {
2255 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2259 _ => panic!("Unexpected event"),
2264 // Ensure that fail_htlc_backwards is idempotent.
2265 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2266 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2267 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2268 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2273 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2274 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2277 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2278 let mut chan_mon_cfgs = Vec::new();
2279 for i in 0..node_count {
2280 let tx_broadcaster = test_utils::TestBroadcaster {
2281 txn_broadcasted: Mutex::new(Vec::new()),
2282 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2284 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2285 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2286 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2287 let persister = test_utils::TestPersister::new();
2288 let seed = [i as u8; 32];
2289 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2290 let scorer = Mutex::new(test_utils::TestScorer::new());
2292 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager, scorer });
2298 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2299 let mut nodes = Vec::new();
2301 for i in 0..node_count {
2302 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);
2303 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2304 let seed = [i as u8; 32];
2305 nodes.push(NodeCfg {
2306 chain_source: &chanmon_cfgs[i].chain_source,
2307 logger: &chanmon_cfgs[i].logger,
2308 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2309 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2310 router: test_utils::TestRouter::new(network_graph.clone(), &chanmon_cfgs[i].scorer),
2312 keys_manager: &chanmon_cfgs[i].keys_manager,
2315 override_init_features: Rc::new(RefCell::new(None)),
2322 pub fn test_default_channel_config() -> UserConfig {
2323 let mut default_config = UserConfig::default();
2324 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2325 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2326 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2327 default_config.channel_handshake_config.announced_channel = true;
2328 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2329 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2330 // It now defaults to 1, so we simply set it to the expected value here.
2331 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2332 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2333 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2334 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2338 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>> {
2339 let mut chanmgrs = Vec::new();
2340 for i in 0..node_count {
2341 let network = Network::Testnet;
2342 let params = ChainParameters {
2344 best_block: BestBlock::from_genesis(network),
2346 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,
2347 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);
2348 chanmgrs.push(node);
2354 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>> {
2355 let mut nodes = Vec::new();
2356 let chan_count = Rc::new(RefCell::new(0));
2357 let payment_count = Rc::new(RefCell::new(0));
2358 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2360 for i in 0..node_count {
2361 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2363 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2364 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2365 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2366 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2367 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2368 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2369 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2370 connect_style: Rc::clone(&connect_style),
2371 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2375 for i in 0..node_count {
2376 for j in (i+1)..node_count {
2377 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();
2378 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();
2385 // Note that the following only works for CLTV values up to 128
2386 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2388 #[derive(PartialEq)]
2389 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2390 /// Tests that the given node has broadcast transactions for the given Channel
2392 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2393 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2394 /// broadcast and the revoked outputs were claimed.
2396 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2397 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2399 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2401 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> {
2402 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2403 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2405 let mut res = Vec::with_capacity(2);
2406 node_txn.retain(|tx| {
2407 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2408 check_spends!(tx, chan.3);
2409 if commitment_tx.is_none() {
2410 res.push(tx.clone());
2415 if let Some(explicit_tx) = commitment_tx {
2416 res.push(explicit_tx.clone());
2419 assert_eq!(res.len(), 1);
2421 if has_htlc_tx != HTLCType::NONE {
2422 node_txn.retain(|tx| {
2423 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2424 check_spends!(tx, res[0]);
2425 if has_htlc_tx == HTLCType::TIMEOUT {
2426 assert!(tx.lock_time.0 != 0);
2428 assert!(tx.lock_time.0 == 0);
2430 res.push(tx.clone());
2434 assert!(res.len() == 2 || res.len() == 3);
2436 assert_eq!(res[1], res[2]);
2440 assert!(node_txn.is_empty());
2444 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2445 /// HTLC transaction.
2446 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2447 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2448 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2449 // for revoked htlc outputs
2450 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2451 node_txn.retain(|tx| {
2452 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2453 check_spends!(tx, revoked_tx);
2457 node_txn.retain(|tx| {
2458 check_spends!(tx, commitment_revoked_tx);
2461 assert!(node_txn.is_empty());
2464 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2465 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2467 assert!(node_txn.len() >= 1);
2468 assert_eq!(node_txn[0].input.len(), 1);
2469 let mut found_prev = false;
2471 for tx in prev_txn {
2472 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2473 check_spends!(node_txn[0], tx);
2474 let mut iter = node_txn[0].input[0].witness.iter();
2475 iter.next().expect("expected 3 witness items");
2476 iter.next().expect("expected 3 witness items");
2477 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2478 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2484 assert!(found_prev);
2486 let mut res = Vec::new();
2487 mem::swap(&mut *node_txn, &mut res);
2491 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) {
2492 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2493 assert_eq!(events_1.len(), 2);
2494 let as_update = match events_1[0] {
2495 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2498 _ => panic!("Unexpected event"),
2501 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2502 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2503 assert_eq!(msg.data, expected_error);
2504 if needs_err_handle {
2505 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2508 _ => panic!("Unexpected event"),
2511 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2512 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2513 let bs_update = match events_2[0] {
2514 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2517 _ => panic!("Unexpected event"),
2519 if !needs_err_handle {
2521 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2522 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2523 assert_eq!(msg.data, expected_error);
2525 _ => panic!("Unexpected event"),
2530 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2531 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2535 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2536 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2540 macro_rules! get_channel_value_stat {
2541 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2542 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2543 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2544 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2545 chan.get_value_stat()
2549 macro_rules! get_chan_reestablish_msgs {
2550 ($src_node: expr, $dst_node: expr) => {
2552 let mut announcements = $crate::prelude::HashSet::new();
2553 let mut res = Vec::with_capacity(1);
2554 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2555 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2556 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2557 res.push(msg.clone());
2558 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2559 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2560 announcements.insert(msg.contents.short_channel_id);
2562 panic!("Unexpected event")
2565 for chan in $src_node.node.list_channels() {
2566 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2567 if let Some(scid) = chan.short_channel_id {
2568 assert!(announcements.remove(&scid));
2572 assert!(announcements.is_empty());
2578 macro_rules! handle_chan_reestablish_msgs {
2579 ($src_node: expr, $dst_node: expr) => {
2581 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2583 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2585 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2591 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2593 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2596 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2597 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2598 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2600 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2601 had_channel_update = true;
2604 let mut revoke_and_ack = None;
2605 let mut commitment_update = None;
2606 let order = if let Some(ev) = msg_events.get(idx) {
2608 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2609 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2610 revoke_and_ack = Some(msg.clone());
2612 RAACommitmentOrder::RevokeAndACKFirst
2614 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2615 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2616 commitment_update = Some(updates.clone());
2618 RAACommitmentOrder::CommitmentFirst
2620 _ => RAACommitmentOrder::CommitmentFirst,
2623 RAACommitmentOrder::CommitmentFirst
2626 if let Some(ev) = msg_events.get(idx) {
2628 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2629 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2630 assert!(revoke_and_ack.is_none());
2631 revoke_and_ack = Some(msg.clone());
2634 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2635 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2636 assert!(commitment_update.is_none());
2637 commitment_update = Some(updates.clone());
2644 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2645 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2647 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2648 assert!(!had_channel_update);
2651 assert_eq!(msg_events.len(), idx);
2653 (channel_ready, revoke_and_ack, commitment_update, order)
2658 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2659 /// for claims/fails they are separated out.
2660 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)) {
2661 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();
2662 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2663 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();
2664 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2666 if send_channel_ready.0 {
2667 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2669 for reestablish in reestablish_1.iter() {
2670 assert_eq!(reestablish.next_remote_commitment_number, 0);
2673 if send_channel_ready.1 {
2674 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2676 for reestablish in reestablish_2.iter() {
2677 assert_eq!(reestablish.next_remote_commitment_number, 0);
2680 if send_channel_ready.0 || send_channel_ready.1 {
2681 // If we expect any channel_ready's, both sides better have set
2682 // next_holder_commitment_number to 1
2683 for reestablish in reestablish_1.iter() {
2684 assert_eq!(reestablish.next_local_commitment_number, 1);
2686 for reestablish in reestablish_2.iter() {
2687 assert_eq!(reestablish.next_local_commitment_number, 1);
2691 let mut resp_1 = Vec::new();
2692 for msg in reestablish_1 {
2693 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2694 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2696 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2697 check_added_monitors!(node_b, 1);
2699 check_added_monitors!(node_b, 0);
2702 let mut resp_2 = Vec::new();
2703 for msg in reestablish_2 {
2704 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2705 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2707 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2708 check_added_monitors!(node_a, 1);
2710 check_added_monitors!(node_a, 0);
2713 // We don't yet support both needing updates, as that would require a different commitment dance:
2714 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2715 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2716 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2717 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2719 for chan_msgs in resp_1.drain(..) {
2720 if send_channel_ready.0 {
2721 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2722 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2723 if !announcement_event.is_empty() {
2724 assert_eq!(announcement_event.len(), 1);
2725 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2726 //TODO: Test announcement_sigs re-sending
2727 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2730 assert!(chan_msgs.0.is_none());
2733 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2734 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2735 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2736 check_added_monitors!(node_a, 1);
2738 assert!(chan_msgs.1.is_none());
2740 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 {
2741 let commitment_update = chan_msgs.2.unwrap();
2742 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2743 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2745 assert!(commitment_update.update_add_htlcs.is_empty());
2747 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2748 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2749 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2750 for update_add in commitment_update.update_add_htlcs {
2751 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2753 for update_fulfill in commitment_update.update_fulfill_htlcs {
2754 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2756 for update_fail in commitment_update.update_fail_htlcs {
2757 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2760 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2761 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2763 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2764 check_added_monitors!(node_a, 1);
2765 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2766 // No commitment_signed so get_event_msg's assert(len == 1) passes
2767 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2768 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2769 check_added_monitors!(node_b, 1);
2772 assert!(chan_msgs.2.is_none());
2776 for chan_msgs in resp_2.drain(..) {
2777 if send_channel_ready.1 {
2778 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2779 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2780 if !announcement_event.is_empty() {
2781 assert_eq!(announcement_event.len(), 1);
2782 match announcement_event[0] {
2783 MessageSendEvent::SendChannelUpdate { .. } => {},
2784 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2785 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2789 assert!(chan_msgs.0.is_none());
2792 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2793 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2794 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2795 check_added_monitors!(node_b, 1);
2797 assert!(chan_msgs.1.is_none());
2799 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 {
2800 let commitment_update = chan_msgs.2.unwrap();
2801 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2802 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2804 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2805 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2806 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2807 for update_add in commitment_update.update_add_htlcs {
2808 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2810 for update_fulfill in commitment_update.update_fulfill_htlcs {
2811 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2813 for update_fail in commitment_update.update_fail_htlcs {
2814 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2817 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2818 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2820 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2821 check_added_monitors!(node_b, 1);
2822 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2823 // No commitment_signed so get_event_msg's assert(len == 1) passes
2824 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2825 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2826 check_added_monitors!(node_a, 1);
2829 assert!(chan_msgs.2.is_none());