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 signle 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 the given transaction at the given height, mining blocks as required to build to that
72 /// Returns the SCID a channel confirmed in the given transaction will have, assuming the funding
73 /// output is the 1st output in the transaction.
74 pub fn confirm_transaction_at<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, tx: &Transaction, conf_height: u32) -> u64 {
75 let first_connect_height = node.best_block_info().1 + 1;
76 assert!(first_connect_height <= conf_height);
77 if conf_height > first_connect_height {
78 connect_blocks(node, conf_height - first_connect_height);
80 let mut block = Block {
81 header: BlockHeader { version: 0x20000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: conf_height, bits: 42, nonce: 42 },
84 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
85 block.txdata.push(Transaction { version: 0, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: Vec::new() });
87 block.txdata.push(tx.clone());
88 connect_block(node, &block);
89 scid_utils::scid_from_parts(conf_height as u64, block.txdata.len() as u64 - 1, 0).unwrap()
92 /// The possible ways we may notify a ChannelManager of a new block
93 #[derive(Clone, Copy, Debug, PartialEq)]
94 pub enum ConnectStyle {
95 /// Calls `best_block_updated` first, detecting transactions in the block only after receiving
96 /// the header and height information.
98 /// The same as `BestBlockFirst`, however when we have multiple blocks to connect, we only
99 /// make a single `best_block_updated` call.
100 BestBlockFirstSkippingBlocks,
101 /// The same as `BestBlockFirst` when connecting blocks. During disconnection only
102 /// `transaction_unconfirmed` is called.
103 BestBlockFirstReorgsOnlyTip,
104 /// Calls `transactions_confirmed` first, detecting transactions in the block before updating
105 /// the header and height information.
107 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
108 /// make a single `best_block_updated` call.
109 TransactionsFirstSkippingBlocks,
110 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
111 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
112 /// times to ensure it's idempotent.
113 TransactionsDuplicativelyFirstSkippingBlocks,
114 /// The same as `TransactionsFirst`, however when we have multiple blocks to connect, we only
115 /// make a single `best_block_updated` call. Further, we call `transactions_confirmed` multiple
116 /// times to ensure it's idempotent.
117 HighlyRedundantTransactionsFirstSkippingBlocks,
118 /// The same as `TransactionsFirst` when connecting blocks. During disconnection only
119 /// `transaction_unconfirmed` is called.
120 TransactionsFirstReorgsOnlyTip,
121 /// Provides the full block via the `chain::Listen` interface. In the current code this is
122 /// equivalent to `TransactionsFirst` with some additional assertions.
127 fn random_style() -> ConnectStyle {
128 #[cfg(feature = "std")] {
129 use core::hash::{BuildHasher, Hasher};
130 // Get a random value using the only std API to do so - the DefaultHasher
131 let rand_val = std::collections::hash_map::RandomState::new().build_hasher().finish();
132 let res = match rand_val % 9 {
133 0 => ConnectStyle::BestBlockFirst,
134 1 => ConnectStyle::BestBlockFirstSkippingBlocks,
135 2 => ConnectStyle::BestBlockFirstReorgsOnlyTip,
136 3 => ConnectStyle::TransactionsFirst,
137 4 => ConnectStyle::TransactionsFirstSkippingBlocks,
138 5 => ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks,
139 6 => ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks,
140 7 => ConnectStyle::TransactionsFirstReorgsOnlyTip,
141 8 => ConnectStyle::FullBlockViaListen,
144 eprintln!("Using Block Connection Style: {:?}", res);
147 #[cfg(not(feature = "std"))] {
148 ConnectStyle::FullBlockViaListen
153 pub fn connect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, depth: u32) -> BlockHash {
154 let skip_intermediaries = match *node.connect_style.borrow() {
155 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
156 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
157 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => true,
161 let height = node.best_block_info().1 + 1;
162 let mut block = Block {
163 header: BlockHeader { version: 0x2000000, prev_blockhash: node.best_block_hash(), merkle_root: TxMerkleNode::all_zeros(), time: height, bits: 42, nonce: 42 },
168 let prev_blockhash = block.header.block_hash();
169 do_connect_block(node, block, skip_intermediaries);
171 header: BlockHeader { version: 0x20000000, prev_blockhash, merkle_root: TxMerkleNode::all_zeros(), time: height + i, bits: 42, nonce: 42 },
175 let hash = block.header.block_hash();
176 do_connect_block(node, block, false);
180 pub fn connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: &Block) {
181 do_connect_block(node, block.clone(), false);
184 fn call_claimable_balances<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
185 // Ensure `get_claimable_balances`' self-tests never panic
186 for funding_outpoint in node.chain_monitor.chain_monitor.list_monitors() {
187 node.chain_monitor.chain_monitor.get_monitor(funding_outpoint).unwrap().get_claimable_balances();
191 fn do_connect_block<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, block: Block, skip_intermediaries: bool) {
192 call_claimable_balances(node);
193 let height = node.best_block_info().1 + 1;
194 #[cfg(feature = "std")] {
195 eprintln!("Connecting block using Block Connection Style: {:?}", *node.connect_style.borrow());
197 if !skip_intermediaries {
198 let txdata: Vec<_> = block.txdata.iter().enumerate().collect();
199 match *node.connect_style.borrow() {
200 ConnectStyle::BestBlockFirst|ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::BestBlockFirstReorgsOnlyTip => {
201 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
202 call_claimable_balances(node);
203 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
204 node.node.best_block_updated(&block.header, height);
205 node.node.transactions_confirmed(&block.header, &txdata, height);
207 ConnectStyle::TransactionsFirst|ConnectStyle::TransactionsFirstSkippingBlocks|
208 ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks|ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|
209 ConnectStyle::TransactionsFirstReorgsOnlyTip => {
210 if *node.connect_style.borrow() == ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks {
211 let mut connections = Vec::new();
212 for (block, height) in node.blocks.lock().unwrap().iter() {
213 if !block.txdata.is_empty() {
214 // Reconnect all transactions we've ever seen to ensure transaction connection
215 // is *really* idempotent. This is a somewhat likely deployment for some
216 // esplora implementations of chain sync which try to reduce state and
217 // complexity as much as possible.
219 // Sadly we have to clone the block here to maintain lockorder. In the
220 // future we should consider Arc'ing the blocks to avoid this.
221 connections.push((block.clone(), *height));
224 for (old_block, height) in connections {
225 node.chain_monitor.chain_monitor.transactions_confirmed(&old_block.header,
226 &old_block.txdata.iter().enumerate().collect::<Vec<_>>(), height);
229 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
230 if *node.connect_style.borrow() == ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks {
231 node.chain_monitor.chain_monitor.transactions_confirmed(&block.header, &txdata, height);
233 call_claimable_balances(node);
234 node.chain_monitor.chain_monitor.best_block_updated(&block.header, height);
235 node.node.transactions_confirmed(&block.header, &txdata, height);
236 node.node.best_block_updated(&block.header, height);
238 ConnectStyle::FullBlockViaListen => {
239 node.chain_monitor.chain_monitor.block_connected(&block, height);
240 node.node.block_connected(&block, height);
244 call_claimable_balances(node);
245 node.node.test_process_background_events();
246 node.blocks.lock().unwrap().push((block, height));
249 pub fn disconnect_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, count: u32) {
250 call_claimable_balances(node);
251 #[cfg(feature = "std")] {
252 eprintln!("Disconnecting {} blocks using Block Connection Style: {:?}", count, *node.connect_style.borrow());
255 let orig = node.blocks.lock().unwrap().pop().unwrap();
256 assert!(orig.1 > 0); // Cannot disconnect genesis
257 let prev = node.blocks.lock().unwrap().last().unwrap().clone();
259 match *node.connect_style.borrow() {
260 ConnectStyle::FullBlockViaListen => {
261 node.chain_monitor.chain_monitor.block_disconnected(&orig.0.header, orig.1);
262 Listen::block_disconnected(node.node, &orig.0.header, orig.1);
264 ConnectStyle::BestBlockFirstSkippingBlocks|ConnectStyle::TransactionsFirstSkippingBlocks|
265 ConnectStyle::HighlyRedundantTransactionsFirstSkippingBlocks|ConnectStyle::TransactionsDuplicativelyFirstSkippingBlocks => {
267 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
268 node.node.best_block_updated(&prev.0.header, prev.1);
271 ConnectStyle::BestBlockFirstReorgsOnlyTip|ConnectStyle::TransactionsFirstReorgsOnlyTip => {
272 for tx in orig.0.txdata {
273 node.chain_monitor.chain_monitor.transaction_unconfirmed(&tx.txid());
274 node.node.transaction_unconfirmed(&tx.txid());
278 node.chain_monitor.chain_monitor.best_block_updated(&prev.0.header, prev.1);
279 node.node.best_block_updated(&prev.0.header, prev.1);
282 call_claimable_balances(node);
286 pub fn disconnect_all_blocks<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>) {
287 let count = node.blocks.lock().unwrap().len() as u32 - 1;
288 disconnect_blocks(node, count);
291 pub struct TestChanMonCfg {
292 pub tx_broadcaster: test_utils::TestBroadcaster,
293 pub fee_estimator: test_utils::TestFeeEstimator,
294 pub chain_source: test_utils::TestChainSource,
295 pub persister: test_utils::TestPersister,
296 pub logger: test_utils::TestLogger,
297 pub keys_manager: test_utils::TestKeysInterface,
300 pub struct NodeCfg<'a> {
301 pub chain_source: &'a test_utils::TestChainSource,
302 pub tx_broadcaster: &'a test_utils::TestBroadcaster,
303 pub fee_estimator: &'a test_utils::TestFeeEstimator,
304 pub router: test_utils::TestRouter<'a>,
305 pub chain_monitor: test_utils::TestChainMonitor<'a>,
306 pub keys_manager: &'a test_utils::TestKeysInterface,
307 pub logger: &'a test_utils::TestLogger,
308 pub network_graph: Arc<NetworkGraph<&'a test_utils::TestLogger>>,
309 pub node_seed: [u8; 32],
310 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
313 pub struct Node<'a, 'b: 'a, 'c: 'b> {
314 pub chain_source: &'c test_utils::TestChainSource,
315 pub tx_broadcaster: &'c test_utils::TestBroadcaster,
316 pub fee_estimator: &'c test_utils::TestFeeEstimator,
317 pub router: &'b test_utils::TestRouter<'c>,
318 pub chain_monitor: &'b test_utils::TestChainMonitor<'c>,
319 pub keys_manager: &'b test_utils::TestKeysInterface,
320 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>,
321 pub network_graph: &'a NetworkGraph<&'c test_utils::TestLogger>,
322 pub gossip_sync: P2PGossipSync<&'b NetworkGraph<&'c test_utils::TestLogger>, &'c test_utils::TestChainSource, &'c test_utils::TestLogger>,
323 pub node_seed: [u8; 32],
324 pub network_payment_count: Rc<RefCell<u8>>,
325 pub network_chan_count: Rc<RefCell<u32>>,
326 pub logger: &'c test_utils::TestLogger,
327 pub blocks: Arc<Mutex<Vec<(Block, u32)>>>,
328 pub connect_style: Rc<RefCell<ConnectStyle>>,
329 pub override_init_features: Rc<RefCell<Option<InitFeatures>>>,
331 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
332 pub fn best_block_hash(&self) -> BlockHash {
333 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
335 pub fn best_block_info(&self) -> (BlockHash, u32) {
336 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
338 pub fn get_block_header(&self, height: u32) -> BlockHeader {
339 self.blocks.lock().unwrap()[height as usize].0.header
343 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
346 // Check that we processed all pending events
347 let msg_events = self.node.get_and_clear_pending_msg_events();
348 if !msg_events.is_empty() {
349 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
351 let events = self.node.get_and_clear_pending_events();
352 if !events.is_empty() {
353 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
355 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
356 if !added_monitors.is_empty() {
357 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
360 // Check that if we serialize the network graph, we can deserialize it again.
361 let network_graph = {
362 let mut w = test_utils::TestVecWriter(Vec::new());
363 self.network_graph.write(&mut w).unwrap();
364 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
365 assert!(network_graph_deser == *self.network_graph);
366 let gossip_sync = P2PGossipSync::new(
367 &network_graph_deser, Some(self.chain_source), self.logger
369 let mut chan_progress = 0;
371 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
372 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
373 assert!(orig_announcements == deserialized_announcements);
374 chan_progress = match orig_announcements {
375 Some(announcement) => announcement.0.contents.short_channel_id + 1,
379 let mut node_progress = None;
381 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
382 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
383 assert!(orig_announcements == deserialized_announcements);
384 node_progress = match orig_announcements {
385 Some(announcement) => Some(announcement.contents.node_id),
392 // Check that if we serialize and then deserialize all our channel monitors we get the
393 // same set of outputs to watch for on chain as we have now. Note that if we write
394 // tests that fully close channels and remove the monitors at some point this may break.
395 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
396 let mut deserialized_monitors = Vec::new();
398 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
399 let mut w = test_utils::TestVecWriter(Vec::new());
400 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
401 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
402 &mut io::Cursor::new(&w.0), (self.keys_manager, self.keys_manager)).unwrap();
403 deserialized_monitors.push(deserialized_monitor);
407 let broadcaster = test_utils::TestBroadcaster {
408 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
409 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
412 // Before using all the new monitors to check the watch outpoints, use the full set of
413 // them to ensure we can write and reload our ChannelManager.
415 let mut channel_monitors = HashMap::new();
416 for monitor in deserialized_monitors.iter_mut() {
417 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
420 let mut w = test_utils::TestVecWriter(Vec::new());
421 self.node.write(&mut w).unwrap();
422 <(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 {
423 default_config: *self.node.get_current_default_configuration(),
424 entropy_source: self.keys_manager,
425 node_signer: self.keys_manager,
426 signer_provider: self.keys_manager,
427 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
428 router: &test_utils::TestRouter::new(Arc::new(network_graph)),
429 chain_monitor: self.chain_monitor,
430 tx_broadcaster: &broadcaster,
431 logger: &self.logger,
436 let persister = test_utils::TestPersister::new();
437 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
438 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
439 for deserialized_monitor in deserialized_monitors.drain(..) {
440 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
444 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
445 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
450 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) {
451 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
454 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) {
455 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
456 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
457 (announcement, as_update, bs_update, channel_id, tx)
461 /// Gets an RAA and CS which were sent in response to a commitment update
462 macro_rules! get_revoke_commit_msgs {
463 ($node: expr, $node_id: expr) => {
465 use $crate::util::events::MessageSendEvent;
466 let events = $node.node.get_and_clear_pending_msg_events();
467 assert_eq!(events.len(), 2);
469 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
470 assert_eq!(*node_id, $node_id);
473 _ => panic!("Unexpected event"),
475 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
476 assert_eq!(*node_id, $node_id);
477 assert!(updates.update_add_htlcs.is_empty());
478 assert!(updates.update_fulfill_htlcs.is_empty());
479 assert!(updates.update_fail_htlcs.is_empty());
480 assert!(updates.update_fail_malformed_htlcs.is_empty());
481 assert!(updates.update_fee.is_none());
482 updates.commitment_signed.clone()
484 _ => panic!("Unexpected event"),
490 /// Get an specific event message from the pending events queue.
492 macro_rules! get_event_msg {
493 ($node: expr, $event_type: path, $node_id: expr) => {
495 let events = $node.node.get_and_clear_pending_msg_events();
496 assert_eq!(events.len(), 1);
498 $event_type { ref node_id, ref msg } => {
499 assert_eq!(*node_id, $node_id);
502 _ => panic!("Unexpected event"),
508 /// Get an error message from the pending events queue.
510 macro_rules! get_err_msg {
511 ($node: expr, $node_id: expr) => {
513 let events = $node.node.get_and_clear_pending_msg_events();
514 assert_eq!(events.len(), 1);
516 $crate::util::events::MessageSendEvent::HandleError {
517 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
519 assert_eq!(*node_id, $node_id);
522 _ => panic!("Unexpected event"),
528 /// Get a specific event from the pending events queue.
530 macro_rules! get_event {
531 ($node: expr, $event_type: path) => {
533 let mut events = $node.node.get_and_clear_pending_events();
534 assert_eq!(events.len(), 1);
535 let ev = events.pop().unwrap();
537 $event_type { .. } => {
540 _ => panic!("Unexpected event"),
547 /// Gets an UpdateHTLCs MessageSendEvent
548 macro_rules! get_htlc_update_msgs {
549 ($node: expr, $node_id: expr) => {
551 let events = $node.node.get_and_clear_pending_msg_events();
552 assert_eq!(events.len(), 1);
554 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
555 assert_eq!(*node_id, $node_id);
558 _ => panic!("Unexpected event"),
564 /// Fetches the first `msg_event` to the passed `node_id` in the passed `msg_events` vec.
565 /// Returns the `msg_event`, along with an updated `msg_events` vec with the message removed.
567 /// Note that even though `BroadcastChannelAnnouncement` and `BroadcastChannelUpdate`
568 /// `msg_events` are stored under specific peers, this function does not fetch such `msg_events` as
569 /// such messages are intended to all peers.
570 pub fn remove_first_msg_event_to_node(msg_node_id: &PublicKey, msg_events: &Vec<MessageSendEvent>) -> (MessageSendEvent, Vec<MessageSendEvent>) {
571 let ev_index = msg_events.iter().position(|e| { match e {
572 MessageSendEvent::SendAcceptChannel { node_id, .. } => {
573 node_id == msg_node_id
575 MessageSendEvent::SendOpenChannel { node_id, .. } => {
576 node_id == msg_node_id
578 MessageSendEvent::SendFundingCreated { node_id, .. } => {
579 node_id == msg_node_id
581 MessageSendEvent::SendFundingSigned { node_id, .. } => {
582 node_id == msg_node_id
584 MessageSendEvent::SendChannelReady { node_id, .. } => {
585 node_id == msg_node_id
587 MessageSendEvent::SendAnnouncementSignatures { node_id, .. } => {
588 node_id == msg_node_id
590 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
591 node_id == msg_node_id
593 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
594 node_id == msg_node_id
596 MessageSendEvent::SendClosingSigned { node_id, .. } => {
597 node_id == msg_node_id
599 MessageSendEvent::SendShutdown { node_id, .. } => {
600 node_id == msg_node_id
602 MessageSendEvent::SendChannelReestablish { node_id, .. } => {
603 node_id == msg_node_id
605 MessageSendEvent::SendChannelAnnouncement { node_id, .. } => {
606 node_id == msg_node_id
608 MessageSendEvent::BroadcastChannelAnnouncement { .. } => {
611 MessageSendEvent::BroadcastChannelUpdate { .. } => {
614 MessageSendEvent::SendChannelUpdate { node_id, .. } => {
615 node_id == msg_node_id
617 MessageSendEvent::HandleError { node_id, .. } => {
618 node_id == msg_node_id
620 MessageSendEvent::SendChannelRangeQuery { node_id, .. } => {
621 node_id == msg_node_id
623 MessageSendEvent::SendShortIdsQuery { node_id, .. } => {
624 node_id == msg_node_id
626 MessageSendEvent::SendReplyChannelRange { node_id, .. } => {
627 node_id == msg_node_id
629 MessageSendEvent::SendGossipTimestampFilter { node_id, .. } => {
630 node_id == msg_node_id
633 if ev_index.is_some() {
634 let mut updated_msg_events = msg_events.to_vec();
635 let ev = updated_msg_events.remove(ev_index.unwrap());
636 (ev, updated_msg_events)
638 panic!("Couldn't find any MessageSendEvent to the node!")
643 macro_rules! get_channel_ref {
644 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
646 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
647 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
648 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
654 macro_rules! get_feerate {
655 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
657 let mut per_peer_state_lock;
658 let mut peer_state_lock;
659 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
666 macro_rules! get_opt_anchors {
667 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
669 let mut per_peer_state_lock;
670 let mut peer_state_lock;
671 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
677 /// Returns a channel monitor given a channel id, making some naive assumptions
679 macro_rules! get_monitor {
680 ($node: expr, $channel_id: expr) => {
682 use bitcoin::hashes::Hash;
683 let mut monitor = None;
684 // Assume funding vout is either 0 or 1 blindly
686 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
687 $crate::chain::transaction::OutPoint {
688 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
700 /// Returns any local commitment transactions for the channel.
702 macro_rules! get_local_commitment_txn {
703 ($node: expr, $channel_id: expr) => {
705 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
710 /// Check the error from attempting a payment.
712 macro_rules! unwrap_send_err {
713 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
715 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
716 assert_eq!(fails.len(), 1);
722 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
723 assert_eq!(results.len(), 1);
725 Err($type) => { $check },
734 /// Check whether N channel monitor(s) have been added.
736 macro_rules! check_added_monitors {
737 ($node: expr, $count: expr) => {
739 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
740 assert_eq!(added_monitors.len(), $count);
741 added_monitors.clear();
746 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> {
747 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
748 for encoded in monitors_encoded {
749 let mut monitor_read = &encoded[..];
750 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
751 ::read(&mut monitor_read, (node.keys_manager, node.keys_manager)).unwrap();
752 assert!(monitor_read.is_empty());
753 monitors_read.push(monitor);
756 let mut node_read = &chanman_encoded[..];
757 let (_, node_deserialized) = {
758 let mut channel_monitors = HashMap::new();
759 for monitor in monitors_read.iter_mut() {
760 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
762 <(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 {
764 entropy_source: node.keys_manager,
765 node_signer: node.keys_manager,
766 signer_provider: node.keys_manager,
767 fee_estimator: node.fee_estimator,
769 chain_monitor: node.chain_monitor,
770 tx_broadcaster: node.tx_broadcaster,
775 assert!(node_read.is_empty());
777 for monitor in monitors_read.drain(..) {
778 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
779 ChannelMonitorUpdateStatus::Completed);
780 check_added_monitors!(node, 1);
787 macro_rules! reload_node {
788 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
789 let chanman_encoded = $chanman_encoded;
791 $persister = test_utils::TestPersister::new();
792 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
793 $node.chain_monitor = &$new_chain_monitor;
795 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
796 $node.node = &$new_channelmanager;
798 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
799 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
803 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) {
804 let chan_id = *node.network_chan_count.borrow();
806 let events = node.node.get_and_clear_pending_events();
807 assert_eq!(events.len(), 1);
809 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
810 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
811 assert_eq!(*channel_value_satoshis, expected_chan_value);
812 assert_eq!(user_channel_id, expected_user_chan_id);
814 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
815 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
817 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
818 (*temporary_channel_id, tx, funding_outpoint)
820 _ => panic!("Unexpected event"),
823 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 {
824 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
825 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
827 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
828 check_added_monitors!(node_a, 0);
830 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
831 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
832 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
834 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
835 assert_eq!(added_monitors.len(), 1);
836 assert_eq!(added_monitors[0].0, funding_output);
837 added_monitors.clear();
840 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()));
842 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
843 assert_eq!(added_monitors.len(), 1);
844 assert_eq!(added_monitors[0].0, funding_output);
845 added_monitors.clear();
848 let events_4 = node_a.node.get_and_clear_pending_events();
849 assert_eq!(events_4.len(), 0);
851 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
852 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
853 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
855 // Ensure that funding_transaction_generated is idempotent.
856 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
857 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
858 check_added_monitors!(node_a, 0);
863 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
864 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]) {
865 let initiator_channels = initiator.node.list_usable_channels().len();
866 let receiver_channels = receiver.node.list_usable_channels().len();
868 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
869 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
871 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), initiator.node.init_features(), &open_channel);
872 let events = receiver.node.get_and_clear_pending_events();
873 assert_eq!(events.len(), 1);
875 Event::OpenChannelRequest { temporary_channel_id, .. } => {
876 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
878 _ => panic!("Unexpected event"),
881 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
882 assert_eq!(accept_channel.minimum_depth, 0);
883 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), receiver.node.init_features(), &accept_channel);
885 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
886 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
887 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
889 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
890 check_added_monitors!(receiver, 1);
891 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
892 assert_eq!(bs_signed_locked.len(), 2);
893 let as_channel_ready;
894 match &bs_signed_locked[0] {
895 MessageSendEvent::SendFundingSigned { node_id, msg } => {
896 assert_eq!(*node_id, initiator.node.get_our_node_id());
897 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
898 check_added_monitors!(initiator, 1);
900 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
901 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
903 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
905 _ => panic!("Unexpected event"),
907 match &bs_signed_locked[1] {
908 MessageSendEvent::SendChannelReady { node_id, msg } => {
909 assert_eq!(*node_id, initiator.node.get_our_node_id());
910 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
912 _ => panic!("Unexpected event"),
915 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
917 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
918 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
920 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
921 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
923 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
924 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
926 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
927 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
929 (tx, as_channel_ready.channel_id)
932 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 {
933 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
934 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
935 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
936 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
937 let a_flags = node_a.override_init_features.borrow().clone().unwrap_or_else(|| node_a.node.init_features());
938 let b_flags = node_b.override_init_features.borrow().clone().unwrap_or_else(|| node_b.node.init_features());
939 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
940 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
941 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
942 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
943 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
945 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
948 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) {
949 confirm_transaction_at(node_conf, tx, conf_height);
950 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
951 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()));
954 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]) {
956 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
957 assert_eq!(events_6.len(), 3);
958 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
959 assert_eq!(*node_id, node_recv.node.get_our_node_id());
961 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
962 assert_eq!(*node_id, node_recv.node.get_our_node_id());
964 } else { panic!("Unexpected event: {:?}", events_6[1]); };
965 ((match events_6[0] {
966 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
967 channel_id = msg.channel_id.clone();
968 assert_eq!(*node_id, node_recv.node.get_our_node_id());
971 _ => panic!("Unexpected event"),
972 }, match events_6[announcement_sigs_idx] {
973 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
974 assert_eq!(*node_id, node_recv.node.get_our_node_id());
977 _ => panic!("Unexpected event"),
981 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]) {
982 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
983 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
984 confirm_transaction_at(node_a, tx, conf_height);
985 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
986 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
987 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
990 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) {
991 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
992 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
996 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) {
997 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
998 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
999 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
1001 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1002 assert_eq!(events_7.len(), 1);
1003 let (announcement, bs_update) = match events_7[0] {
1004 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1007 _ => panic!("Unexpected event"),
1010 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1011 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1012 assert_eq!(events_8.len(), 1);
1013 let as_update = match events_8[0] {
1014 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1015 assert!(*announcement == *msg);
1016 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1017 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1020 _ => panic!("Unexpected event"),
1023 *node_a.network_chan_count.borrow_mut() += 1;
1025 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1026 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
1029 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) {
1030 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1033 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) {
1034 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1035 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1036 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1039 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) {
1040 let mut no_announce_cfg = test_default_channel_config();
1041 no_announce_cfg.channel_handshake_config.announced_channel = false;
1042 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1043 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1044 let a_flags = nodes[a].override_init_features.borrow().clone().unwrap_or_else(|| nodes[a].node.init_features());
1045 let b_flags = nodes[b].override_init_features.borrow().clone().unwrap_or_else(|| nodes[b].node.init_features());
1046 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
1047 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1048 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
1050 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1051 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1052 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()));
1053 check_added_monitors!(nodes[b], 1);
1055 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1056 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1057 check_added_monitors!(nodes[a], 1);
1059 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1060 confirm_transaction_at(&nodes[a], &tx, conf_height);
1061 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1062 confirm_transaction_at(&nodes[b], &tx, conf_height);
1063 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1064 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1065 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()));
1066 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1067 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1068 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1069 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1070 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1072 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1073 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1075 let mut found_a = false;
1076 for chan in nodes[a].node.list_usable_channels() {
1077 if chan.channel_id == as_channel_ready.channel_id {
1080 assert!(!chan.is_public);
1085 let mut found_b = false;
1086 for chan in nodes[b].node.list_usable_channels() {
1087 if chan.channel_id == as_channel_ready.channel_id {
1090 assert!(!chan.is_public);
1095 (as_channel_ready, tx)
1098 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) {
1100 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1101 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1102 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1104 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1105 // forwarding info for local channels even if its not accepted in the network graph.
1106 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1107 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1112 macro_rules! check_spends {
1113 ($tx: expr, $($spends_txn: expr),*) => {
1116 for outp in $spends_txn.output.iter() {
1117 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1120 for outp in $tx.output.iter() {
1121 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1123 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1125 if out_point.txid == $spends_txn.txid() {
1126 return $spends_txn.output.get(out_point.vout as usize).cloned()
1131 let mut total_value_in = 0;
1132 for input in $tx.input.iter() {
1133 total_value_in += get_output(&input.previous_output).unwrap().value;
1135 let mut total_value_out = 0;
1136 for output in $tx.output.iter() {
1137 total_value_out += output.value;
1139 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1140 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1141 assert!(total_value_out + min_fee <= total_value_in);
1142 $tx.verify(get_output).unwrap();
1147 macro_rules! get_closing_signed_broadcast {
1148 ($node: expr, $dest_pubkey: expr) => {
1150 let events = $node.get_and_clear_pending_msg_events();
1151 assert!(events.len() == 1 || events.len() == 2);
1152 (match events[events.len() - 1] {
1153 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1154 assert_eq!(msg.contents.flags & 2, 2);
1157 _ => panic!("Unexpected event"),
1158 }, if events.len() == 2 {
1160 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1161 assert_eq!(*node_id, $dest_pubkey);
1164 _ => panic!("Unexpected event"),
1172 macro_rules! check_warn_msg {
1173 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1174 let msg_events = $node.node.get_and_clear_pending_msg_events();
1175 assert_eq!(msg_events.len(), 1);
1176 match msg_events[0] {
1177 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1178 assert_eq!(node_id, $recipient_node_id);
1179 assert_eq!(msg.channel_id, $chan_id);
1182 _ => panic!("Unexpected event"),
1187 /// Check that a channel's closing channel update has been broadcasted, and optionally
1188 /// check whether an error message event has occurred.
1190 macro_rules! check_closed_broadcast {
1191 ($node: expr, $with_error_msg: expr) => {{
1192 use $crate::util::events::MessageSendEvent;
1193 use $crate::ln::msgs::ErrorAction;
1195 let msg_events = $node.node.get_and_clear_pending_msg_events();
1196 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1197 match msg_events[0] {
1198 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1199 assert_eq!(msg.contents.flags & 2, 2);
1201 _ => panic!("Unexpected event"),
1203 if $with_error_msg {
1204 match msg_events[1] {
1205 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1206 // TODO: Check node_id
1209 _ => panic!("Unexpected event"),
1215 /// Check that a channel's closing channel events has been issued
1217 macro_rules! check_closed_event {
1218 ($node: expr, $events: expr, $reason: expr) => {
1219 check_closed_event!($node, $events, $reason, false);
1221 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1222 use $crate::util::events::Event;
1224 let events = $node.node.get_and_clear_pending_events();
1225 assert_eq!(events.len(), $events, "{:?}", events);
1226 let expected_reason = $reason;
1227 let mut issues_discard_funding = false;
1228 for event in events {
1230 Event::ChannelClosed { ref reason, .. } => {
1231 assert_eq!(*reason, expected_reason);
1233 Event::DiscardFunding { .. } => {
1234 issues_discard_funding = true;
1236 _ => panic!("Unexpected event"),
1239 assert_eq!($is_check_discard_funding, issues_discard_funding);
1243 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) {
1244 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) };
1245 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) };
1248 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1249 node_b.handle_shutdown(&node_a.get_our_node_id(), &node_a.init_features(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1251 let events_1 = node_b.get_and_clear_pending_msg_events();
1252 assert!(events_1.len() >= 1);
1253 let shutdown_b = match events_1[0] {
1254 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1255 assert_eq!(node_id, &node_a.get_our_node_id());
1258 _ => panic!("Unexpected event"),
1261 let closing_signed_b = if !close_inbound_first {
1262 assert_eq!(events_1.len(), 1);
1265 Some(match events_1[1] {
1266 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1267 assert_eq!(node_id, &node_a.get_our_node_id());
1270 _ => panic!("Unexpected event"),
1274 node_a.handle_shutdown(&node_b.get_our_node_id(), &node_b.init_features(), &shutdown_b);
1275 let (as_update, bs_update) = if close_inbound_first {
1276 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1277 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1279 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1280 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1281 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1282 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1284 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1285 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1286 assert!(none_a.is_none());
1287 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1288 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1289 (as_update, bs_update)
1291 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1293 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1294 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1296 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1297 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1298 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1300 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1301 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1302 assert!(none_b.is_none());
1303 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1304 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1305 (as_update, bs_update)
1307 assert_eq!(tx_a, tx_b);
1308 check_spends!(tx_a, funding_tx);
1310 (as_update, bs_update, tx_a)
1313 pub struct SendEvent {
1314 pub node_id: PublicKey,
1315 pub msgs: Vec<msgs::UpdateAddHTLC>,
1316 pub commitment_msg: msgs::CommitmentSigned,
1319 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1320 assert!(updates.update_fulfill_htlcs.is_empty());
1321 assert!(updates.update_fail_htlcs.is_empty());
1322 assert!(updates.update_fail_malformed_htlcs.is_empty());
1323 assert!(updates.update_fee.is_none());
1324 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1327 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1329 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1330 _ => panic!("Unexpected event type!"),
1334 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1335 let mut events = node.node.get_and_clear_pending_msg_events();
1336 assert_eq!(events.len(), 1);
1337 SendEvent::from_event(events.pop().unwrap())
1342 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1343 /// commitment update.
1344 macro_rules! commitment_signed_dance {
1345 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1347 check_added_monitors!($node_a, 0);
1348 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1349 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1350 check_added_monitors!($node_a, 1);
1351 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1354 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1356 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1357 check_added_monitors!($node_b, 0);
1358 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1359 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1360 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1361 check_added_monitors!($node_b, 1);
1362 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1363 let (bs_revoke_and_ack, extra_msg_option) = {
1364 let events = $node_b.node.get_and_clear_pending_msg_events();
1365 assert!(events.len() <= 2);
1366 let (node_a_event, events) = remove_first_msg_event_to_node(&$node_a.node.get_our_node_id(), &events);
1367 (match node_a_event {
1368 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1369 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1372 _ => panic!("Unexpected event"),
1373 }, events.get(0).map(|e| e.clone()))
1375 check_added_monitors!($node_b, 1);
1376 if $fail_backwards {
1377 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1378 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1380 (extra_msg_option, bs_revoke_and_ack)
1383 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1385 check_added_monitors!($node_a, 0);
1386 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1387 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1388 check_added_monitors!($node_a, 1);
1389 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1390 assert!(extra_msg_option.is_none());
1394 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1396 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1397 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1398 check_added_monitors!($node_a, 1);
1402 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1404 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1407 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1409 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1410 if $fail_backwards {
1411 expect_pending_htlcs_forwardable_and_htlc_handling_failed!($node_a, vec![$crate::util::events::HTLCDestination::NextHopChannel{ node_id: Some($node_b.node.get_our_node_id()), channel_id: $commitment_signed.channel_id }]);
1412 check_added_monitors!($node_a, 1);
1414 let node_a_per_peer_state = $node_a.node.per_peer_state.read().unwrap();
1415 let mut number_of_msg_events = 0;
1416 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1417 let peer_state = peer_state_mutex.lock().unwrap();
1418 let cp_pending_msg_events = &peer_state.pending_msg_events;
1419 number_of_msg_events += cp_pending_msg_events.len();
1420 if cp_pending_msg_events.len() == 1 {
1421 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1422 assert_ne!(*cp_id, $node_b.node.get_our_node_id());
1423 } else { panic!("Unexpected event"); }
1426 // Expecting the failure backwards event to the previous hop (not `node_b`)
1427 assert_eq!(number_of_msg_events, 1);
1429 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1435 /// Get a payment preimage and hash.
1437 macro_rules! get_payment_preimage_hash {
1438 ($dest_node: expr) => {
1440 get_payment_preimage_hash!($dest_node, None)
1443 ($dest_node: expr, $min_value_msat: expr) => {
1445 use bitcoin::hashes::Hash as _;
1446 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1447 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1448 *payment_count += 1;
1449 let payment_hash = $crate::ln::PaymentHash(
1450 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1451 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1452 (payment_preimage, payment_hash, payment_secret)
1458 macro_rules! get_route {
1459 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1460 use $crate::chain::keysinterface::EntropySource;
1461 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1462 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1463 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1464 $crate::routing::router::get_route(
1465 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1466 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1467 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1474 macro_rules! get_route_and_payment_hash {
1475 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1476 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1477 .with_features($recv_node.node.invoice_features());
1478 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1480 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1481 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1482 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1483 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1488 macro_rules! expect_pending_htlcs_forwardable_conditions {
1489 ($node: expr, $expected_failures: expr) => {{
1490 let expected_failures = $expected_failures;
1491 let events = $node.node.get_and_clear_pending_events();
1493 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1494 _ => panic!("Unexpected event {:?}", events),
1497 let count = expected_failures.len() + 1;
1498 assert_eq!(events.len(), count);
1500 if expected_failures.len() > 0 {
1501 expect_htlc_handling_failed_destinations!(events, expected_failures)
1507 macro_rules! expect_htlc_handling_failed_destinations {
1508 ($events: expr, $expected_failures: expr) => {{
1509 for event in $events {
1511 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1512 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1513 assert!($expected_failures.contains(&failed_next_destination))
1515 _ => panic!("Unexpected destination"),
1522 /// Clears (and ignores) a PendingHTLCsForwardable event
1523 macro_rules! expect_pending_htlcs_forwardable_ignore {
1525 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1530 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1531 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1532 ($node: expr, $expected_failures: expr) => {{
1533 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1538 /// Handles a PendingHTLCsForwardable event
1539 macro_rules! expect_pending_htlcs_forwardable {
1541 expect_pending_htlcs_forwardable_ignore!($node);
1542 $node.node.process_pending_htlc_forwards();
1544 // Ensure process_pending_htlc_forwards is idempotent.
1545 $node.node.process_pending_htlc_forwards();
1550 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1551 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1552 ($node: expr, $expected_failures: expr) => {{
1553 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1554 $node.node.process_pending_htlc_forwards();
1556 // Ensure process_pending_htlc_forwards is idempotent.
1557 $node.node.process_pending_htlc_forwards();
1562 macro_rules! expect_pending_htlcs_forwardable_from_events {
1563 ($node: expr, $events: expr, $ignore: expr) => {{
1564 assert_eq!($events.len(), 1);
1566 Event::PendingHTLCsForwardable { .. } => { },
1567 _ => panic!("Unexpected event"),
1570 $node.node.process_pending_htlc_forwards();
1572 // Ensure process_pending_htlc_forwards is idempotent.
1573 $node.node.process_pending_htlc_forwards();
1578 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1579 macro_rules! expect_payment_claimable {
1580 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1581 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1583 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1584 let events = $node.node.get_and_clear_pending_events();
1585 assert_eq!(events.len(), 1);
1587 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1588 assert_eq!($expected_payment_hash, *payment_hash);
1589 assert_eq!($expected_recv_value, amount_msat);
1590 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1592 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1593 assert_eq!(&$expected_payment_preimage, payment_preimage);
1594 assert_eq!($expected_payment_secret, *payment_secret);
1599 _ => panic!("Unexpected event"),
1605 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1606 macro_rules! expect_payment_claimed {
1607 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1608 let events = $node.node.get_and_clear_pending_events();
1609 assert_eq!(events.len(), 1);
1611 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1612 assert_eq!($expected_payment_hash, *payment_hash);
1613 assert_eq!($expected_recv_value, amount_msat);
1615 _ => panic!("Unexpected event"),
1622 macro_rules! expect_payment_sent_without_paths {
1623 ($node: expr, $expected_payment_preimage: expr) => {
1624 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1626 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1627 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1632 macro_rules! expect_payment_sent {
1633 ($node: expr, $expected_payment_preimage: expr) => {
1634 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1636 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1637 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1639 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1640 use bitcoin::hashes::Hash as _;
1641 let events = $node.node.get_and_clear_pending_events();
1642 let expected_payment_hash = $crate::ln::PaymentHash(
1643 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1645 assert!(events.len() > 1);
1647 assert_eq!(events.len(), 1);
1649 let expected_payment_id = match events[0] {
1650 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1651 assert_eq!($expected_payment_preimage, *payment_preimage);
1652 assert_eq!(expected_payment_hash, *payment_hash);
1653 assert!(fee_paid_msat.is_some());
1654 if $expected_fee_msat_opt.is_some() {
1655 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1659 _ => panic!("Unexpected event"),
1662 for i in 1..events.len() {
1664 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1665 assert_eq!(payment_id, expected_payment_id);
1666 assert_eq!(payment_hash, Some(expected_payment_hash));
1668 _ => panic!("Unexpected event"),
1677 macro_rules! expect_payment_path_successful {
1679 let events = $node.node.get_and_clear_pending_events();
1680 assert_eq!(events.len(), 1);
1682 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1683 _ => panic!("Unexpected event"),
1688 macro_rules! expect_payment_forwarded {
1689 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1690 let events = $node.node.get_and_clear_pending_events();
1691 assert_eq!(events.len(), 1);
1693 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1694 assert_eq!(fee_earned_msat, $expected_fee);
1695 if fee_earned_msat.is_some() {
1696 // Is the event prev_channel_id in one of the channels between the two nodes?
1697 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()));
1699 // We check for force closures since a force closed channel is removed from the
1700 // node's channel list
1701 if !$downstream_force_closed {
1702 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()));
1704 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1706 _ => panic!("Unexpected event"),
1711 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1712 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1713 let events = node.node.get_and_clear_pending_events();
1714 assert_eq!(events.len(), 1);
1716 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1717 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1719 _ => panic!("Unexpected event"),
1724 pub struct PaymentFailedConditions<'a> {
1725 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1726 pub(crate) expected_blamed_scid: Option<u64>,
1727 pub(crate) expected_blamed_chan_closed: Option<bool>,
1728 pub(crate) expected_mpp_parts_remain: bool,
1731 impl<'a> PaymentFailedConditions<'a> {
1732 pub fn new() -> Self {
1734 expected_htlc_error_data: None,
1735 expected_blamed_scid: None,
1736 expected_blamed_chan_closed: None,
1737 expected_mpp_parts_remain: false,
1740 pub fn mpp_parts_remain(mut self) -> Self {
1741 self.expected_mpp_parts_remain = true;
1744 pub fn blamed_scid(mut self, scid: u64) -> Self {
1745 self.expected_blamed_scid = Some(scid);
1748 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1749 self.expected_blamed_chan_closed = Some(closed);
1752 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1753 self.expected_htlc_error_data = Some((code, data));
1759 macro_rules! expect_payment_failed_with_update {
1760 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1761 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1762 &$node, $expected_payment_hash, $payment_failed_permanently,
1763 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1764 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1769 macro_rules! expect_payment_failed {
1770 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1771 #[allow(unused_mut)]
1772 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1774 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1776 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1780 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1781 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1782 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1784 let expected_payment_id = match payment_failed_event {
1785 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1789 error_data, .. } => {
1790 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1791 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1792 assert!(retry.is_some(), "expected retry.is_some()");
1793 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1794 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1795 if let Some(scid) = short_channel_id {
1796 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1801 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1802 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1803 if let Some((code, data)) = conditions.expected_htlc_error_data {
1804 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1805 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1809 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1810 match network_update {
1811 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1812 if let Some(scid) = conditions.expected_blamed_scid {
1813 assert_eq!(msg.contents.short_channel_id, scid);
1815 const CHAN_DISABLED_FLAG: u8 = 2;
1816 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1818 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1819 if let Some(scid) = conditions.expected_blamed_scid {
1820 assert_eq!(short_channel_id, scid);
1822 assert!(is_permanent);
1824 Some(_) => panic!("Unexpected update type"),
1825 None => panic!("Expected update"),
1831 _ => panic!("Unexpected event"),
1833 if !conditions.expected_mpp_parts_remain {
1834 node.node.abandon_payment(expected_payment_id);
1835 let events = node.node.get_and_clear_pending_events();
1836 assert_eq!(events.len(), 1);
1838 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1839 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1840 assert_eq!(*payment_id, expected_payment_id);
1842 _ => panic!("Unexpected second event"),
1847 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1848 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1849 conditions: PaymentFailedConditions<'e>
1851 let mut events = node.node.get_and_clear_pending_events();
1852 assert_eq!(events.len(), 1);
1853 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1856 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 {
1857 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1858 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1859 check_added_monitors!(origin_node, expected_paths.len());
1860 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1864 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>) {
1865 let mut payment_event = SendEvent::from_event(ev);
1866 let mut prev_node = origin_node;
1868 for (idx, &node) in expected_path.iter().enumerate() {
1869 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1871 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1872 check_added_monitors!(node, 0);
1873 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1875 expect_pending_htlcs_forwardable!(node);
1877 if idx == expected_path.len() - 1 && clear_recipient_events {
1878 let events_2 = node.node.get_and_clear_pending_events();
1879 if payment_claimable_expected {
1880 assert_eq!(events_2.len(), 1);
1882 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1883 assert_eq!(our_payment_hash, *payment_hash);
1884 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1886 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1887 assert_eq!(expected_preimage, *payment_preimage);
1888 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1890 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1891 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1892 assert!(our_payment_secret.is_none());
1895 assert_eq!(amount_msat, recv_value);
1896 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1897 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1899 _ => panic!("Unexpected event"),
1902 assert!(events_2.is_empty());
1904 } else if idx != expected_path.len() - 1 {
1905 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1906 assert_eq!(events_2.len(), 1);
1907 check_added_monitors!(node, 1);
1908 payment_event = SendEvent::from_event(events_2.remove(0));
1909 assert_eq!(payment_event.msgs.len(), 1);
1916 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>) {
1917 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1920 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) {
1921 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1922 assert_eq!(events.len(), expected_route.len());
1923 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1924 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1925 events = updated_events;
1926 // Once we've gotten through all the HTLCs, the last one should result in a
1927 // PaymentClaimable (but each previous one should not!), .
1928 let expect_payment = path_idx == expected_route.len() - 1;
1929 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1933 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) {
1934 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1935 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1936 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1939 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 {
1940 for path in expected_paths.iter() {
1941 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1943 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1945 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1946 assert_eq!(claim_event.len(), 1);
1947 match claim_event[0] {
1948 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1949 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1950 assert_eq!(preimage, our_payment_preimage),
1951 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1952 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1956 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1958 let mut expected_total_fee_msat = 0;
1960 macro_rules! msgs_from_ev {
1963 &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 } } => {
1964 assert!(update_add_htlcs.is_empty());
1965 assert_eq!(update_fulfill_htlcs.len(), 1);
1966 assert!(update_fail_htlcs.is_empty());
1967 assert!(update_fail_malformed_htlcs.is_empty());
1968 assert!(update_fee.is_none());
1969 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1971 _ => panic!("Unexpected event"),
1975 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1976 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1977 assert_eq!(events.len(), expected_paths.len());
1979 if events.len() == 1 {
1980 per_path_msgs.push(msgs_from_ev!(&events[0]));
1982 for expected_path in expected_paths.iter() {
1983 // For MPP payments, we always want the message to the first node in the path.
1984 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1985 per_path_msgs.push(msgs_from_ev!(&ev));
1986 events = updated_events;
1990 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1991 let mut next_msgs = Some(path_msgs);
1992 let mut expected_next_node = next_hop;
1994 macro_rules! last_update_fulfill_dance {
1995 ($node: expr, $prev_node: expr) => {
1997 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1998 check_added_monitors!($node, 0);
1999 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2000 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2004 macro_rules! mid_update_fulfill_dance {
2005 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2007 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2009 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2010 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2011 .unwrap().lock().unwrap();
2012 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2013 if let Some(prev_config) = channel.prev_config() {
2014 prev_config.forwarding_fee_base_msat
2016 channel.config().forwarding_fee_base_msat
2019 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2020 expected_total_fee_msat += fee as u64;
2021 check_added_monitors!($node, 1);
2022 let new_next_msgs = if $new_msgs {
2023 let events = $node.node.get_and_clear_pending_msg_events();
2024 assert_eq!(events.len(), 1);
2025 let (res, nexthop) = msgs_from_ev!(&events[0]);
2026 expected_next_node = nexthop;
2029 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2032 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2033 next_msgs = new_next_msgs;
2038 let mut prev_node = expected_route.last().unwrap();
2039 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2040 assert_eq!(expected_next_node, node.node.get_our_node_id());
2041 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2042 if next_msgs.is_some() {
2043 // Since we are traversing in reverse, next_node is actually the previous node
2044 let next_node: &Node;
2045 if idx == expected_route.len() - 1 {
2046 next_node = origin_node;
2048 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2050 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2052 assert!(!update_next_msgs);
2053 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2055 if !skip_last && idx == expected_route.len() - 1 {
2056 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2063 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2067 // Ensure that claim_funds is idempotent.
2068 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2069 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2070 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2072 expected_total_fee_msat
2074 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) {
2075 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2077 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2081 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2082 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2085 pub const TEST_FINAL_CLTV: u32 = 70;
2087 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) {
2088 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2089 .with_features(expected_route.last().unwrap().node.invoice_features());
2090 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2091 assert_eq!(route.paths.len(), 1);
2092 assert_eq!(route.paths[0].len(), expected_route.len());
2093 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2094 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2097 let res = send_along_route(origin_node, route, expected_route, recv_value);
2098 (res.0, res.1, res.2)
2101 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2102 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2103 .with_features(expected_route.last().unwrap().node.invoice_features());
2104 let network_graph = origin_node.network_graph.read_only();
2105 let scorer = test_utils::TestScorer::with_penalty(0);
2106 let seed = [0u8; 32];
2107 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2108 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2109 let route = get_route(
2110 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2111 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2112 assert_eq!(route.paths.len(), 1);
2113 assert_eq!(route.paths[0].len(), expected_route.len());
2114 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2115 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2118 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2119 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 },
2120 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2123 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2124 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2125 claim_payment(&origin, expected_route, our_payment_preimage);
2128 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) {
2129 for path in expected_paths.iter() {
2130 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2132 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2133 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2134 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2136 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2139 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) {
2140 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2142 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2143 let events = origin_node.node.get_and_clear_pending_events();
2144 assert_eq!(events.len(), 1);
2146 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2147 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2148 assert_eq!(*payment_id, expected_payment_id.unwrap());
2150 _ => panic!("Unexpected second event"),
2155 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> {
2156 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2157 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2159 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2160 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2161 assert_eq!(events.len(), expected_paths.len());
2162 for ev in events.iter() {
2163 let (update_fail, commitment_signed, node_id) = match ev {
2164 &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 } } => {
2165 assert!(update_add_htlcs.is_empty());
2166 assert!(update_fulfill_htlcs.is_empty());
2167 assert_eq!(update_fail_htlcs.len(), 1);
2168 assert!(update_fail_malformed_htlcs.is_empty());
2169 assert!(update_fee.is_none());
2170 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2172 _ => panic!("Unexpected event"),
2174 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2176 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2177 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()));
2179 let mut expected_payment_id = None;
2181 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2182 let mut next_msgs = Some(path_msgs);
2183 let mut expected_next_node = next_hop;
2184 let mut prev_node = expected_route.last().unwrap();
2186 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2187 assert_eq!(expected_next_node, node.node.get_our_node_id());
2188 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2189 if next_msgs.is_some() {
2190 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2191 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2192 if !update_next_node {
2193 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 }]);
2196 let events = node.node.get_and_clear_pending_msg_events();
2197 if update_next_node {
2198 assert_eq!(events.len(), 1);
2200 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 } } => {
2201 assert!(update_add_htlcs.is_empty());
2202 assert!(update_fulfill_htlcs.is_empty());
2203 assert_eq!(update_fail_htlcs.len(), 1);
2204 assert!(update_fail_malformed_htlcs.is_empty());
2205 assert!(update_fee.is_none());
2206 expected_next_node = node_id.clone();
2207 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2209 _ => panic!("Unexpected event"),
2212 assert!(events.is_empty());
2214 if !skip_last && idx == expected_route.len() - 1 {
2215 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2222 let prev_node = expected_route.first().unwrap();
2223 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2224 check_added_monitors!(origin_node, 0);
2225 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2226 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2227 let events = origin_node.node.get_and_clear_pending_events();
2228 assert_eq!(events.len(), 1);
2229 expected_payment_id = Some(match events[0] {
2230 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2231 assert_eq!(payment_hash, our_payment_hash);
2232 assert!(payment_failed_permanently);
2233 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2234 for (idx, hop) in expected_route.iter().enumerate() {
2235 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2239 _ => panic!("Unexpected event"),
2244 // Ensure that fail_htlc_backwards is idempotent.
2245 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2246 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2247 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2248 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2253 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2254 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2257 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2258 let mut chan_mon_cfgs = Vec::new();
2259 for i in 0..node_count {
2260 let tx_broadcaster = test_utils::TestBroadcaster {
2261 txn_broadcasted: Mutex::new(Vec::new()),
2262 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2264 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2265 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2266 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2267 let persister = test_utils::TestPersister::new();
2268 let seed = [i as u8; 32];
2269 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2271 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2277 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2278 let mut nodes = Vec::new();
2280 for i in 0..node_count {
2281 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);
2282 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2283 let seed = [i as u8; 32];
2284 nodes.push(NodeCfg {
2285 chain_source: &chanmon_cfgs[i].chain_source,
2286 logger: &chanmon_cfgs[i].logger,
2287 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2288 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2289 router: test_utils::TestRouter::new(network_graph.clone()),
2291 keys_manager: &chanmon_cfgs[i].keys_manager,
2294 override_init_features: Rc::new(RefCell::new(None)),
2301 pub fn test_default_channel_config() -> UserConfig {
2302 let mut default_config = UserConfig::default();
2303 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2304 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2305 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2306 default_config.channel_handshake_config.announced_channel = true;
2307 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2308 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2309 // It now defaults to 1, so we simply set it to the expected value here.
2310 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2311 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2312 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2313 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2317 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>> {
2318 let mut chanmgrs = Vec::new();
2319 for i in 0..node_count {
2320 let network = Network::Testnet;
2321 let params = ChainParameters {
2323 best_block: BestBlock::from_genesis(network),
2325 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,
2326 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);
2327 chanmgrs.push(node);
2333 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>> {
2334 let mut nodes = Vec::new();
2335 let chan_count = Rc::new(RefCell::new(0));
2336 let payment_count = Rc::new(RefCell::new(0));
2337 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2339 for i in 0..node_count {
2340 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2342 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2343 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2344 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2345 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2346 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2347 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2348 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2349 connect_style: Rc::clone(&connect_style),
2350 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2354 for i in 0..node_count {
2355 for j in (i+1)..node_count {
2356 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();
2357 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();
2364 // Note that the following only works for CLTV values up to 128
2365 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2367 #[derive(PartialEq)]
2368 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2369 /// Tests that the given node has broadcast transactions for the given Channel
2371 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2372 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2373 /// broadcast and the revoked outputs were claimed.
2375 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2376 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2378 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2380 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> {
2381 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2382 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2384 let mut res = Vec::with_capacity(2);
2385 node_txn.retain(|tx| {
2386 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2387 check_spends!(tx, chan.3);
2388 if commitment_tx.is_none() {
2389 res.push(tx.clone());
2394 if let Some(explicit_tx) = commitment_tx {
2395 res.push(explicit_tx.clone());
2398 assert_eq!(res.len(), 1);
2400 if has_htlc_tx != HTLCType::NONE {
2401 node_txn.retain(|tx| {
2402 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2403 check_spends!(tx, res[0]);
2404 if has_htlc_tx == HTLCType::TIMEOUT {
2405 assert!(tx.lock_time.0 != 0);
2407 assert!(tx.lock_time.0 == 0);
2409 res.push(tx.clone());
2413 assert!(res.len() == 2 || res.len() == 3);
2415 assert_eq!(res[1], res[2]);
2419 assert!(node_txn.is_empty());
2423 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2424 /// HTLC transaction.
2425 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2426 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2427 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2428 // for revoked htlc outputs
2429 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2430 node_txn.retain(|tx| {
2431 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2432 check_spends!(tx, revoked_tx);
2436 node_txn.retain(|tx| {
2437 check_spends!(tx, commitment_revoked_tx);
2440 assert!(node_txn.is_empty());
2443 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2444 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2446 assert!(node_txn.len() >= 1);
2447 assert_eq!(node_txn[0].input.len(), 1);
2448 let mut found_prev = false;
2450 for tx in prev_txn {
2451 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2452 check_spends!(node_txn[0], tx);
2453 let mut iter = node_txn[0].input[0].witness.iter();
2454 iter.next().expect("expected 3 witness items");
2455 iter.next().expect("expected 3 witness items");
2456 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2457 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2463 assert!(found_prev);
2465 let mut res = Vec::new();
2466 mem::swap(&mut *node_txn, &mut res);
2470 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) {
2471 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2472 assert_eq!(events_1.len(), 2);
2473 let as_update = match events_1[0] {
2474 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2477 _ => panic!("Unexpected event"),
2480 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2481 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2482 assert_eq!(msg.data, expected_error);
2483 if needs_err_handle {
2484 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2487 _ => panic!("Unexpected event"),
2490 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2491 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2492 let bs_update = match events_2[0] {
2493 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2496 _ => panic!("Unexpected event"),
2498 if !needs_err_handle {
2500 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2501 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2502 assert_eq!(msg.data, expected_error);
2504 _ => panic!("Unexpected event"),
2509 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2510 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2514 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2515 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2519 macro_rules! get_channel_value_stat {
2520 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2521 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2522 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2523 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2524 chan.get_value_stat()
2528 macro_rules! get_chan_reestablish_msgs {
2529 ($src_node: expr, $dst_node: expr) => {
2531 let mut announcements = $crate::prelude::HashSet::new();
2532 let mut res = Vec::with_capacity(1);
2533 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2534 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2535 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2536 res.push(msg.clone());
2537 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2538 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2539 announcements.insert(msg.contents.short_channel_id);
2541 panic!("Unexpected event")
2544 for chan in $src_node.node.list_channels() {
2545 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2546 if let Some(scid) = chan.short_channel_id {
2547 assert!(announcements.remove(&scid));
2551 assert!(announcements.is_empty());
2557 macro_rules! handle_chan_reestablish_msgs {
2558 ($src_node: expr, $dst_node: expr) => {
2560 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2562 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2564 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2570 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2572 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2575 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2576 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2577 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2579 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2580 had_channel_update = true;
2583 let mut revoke_and_ack = None;
2584 let mut commitment_update = None;
2585 let order = if let Some(ev) = msg_events.get(idx) {
2587 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2588 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2589 revoke_and_ack = Some(msg.clone());
2591 RAACommitmentOrder::RevokeAndACKFirst
2593 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2594 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2595 commitment_update = Some(updates.clone());
2597 RAACommitmentOrder::CommitmentFirst
2599 _ => RAACommitmentOrder::CommitmentFirst,
2602 RAACommitmentOrder::CommitmentFirst
2605 if let Some(ev) = msg_events.get(idx) {
2607 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2608 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2609 assert!(revoke_and_ack.is_none());
2610 revoke_and_ack = Some(msg.clone());
2613 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2614 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2615 assert!(commitment_update.is_none());
2616 commitment_update = Some(updates.clone());
2623 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2624 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2626 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2627 assert!(!had_channel_update);
2630 assert_eq!(msg_events.len(), idx);
2632 (channel_ready, revoke_and_ack, commitment_update, order)
2637 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2638 /// for claims/fails they are separated out.
2639 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)) {
2640 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();
2641 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2642 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();
2643 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2645 if send_channel_ready.0 {
2646 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2648 for reestablish in reestablish_1.iter() {
2649 assert_eq!(reestablish.next_remote_commitment_number, 0);
2652 if send_channel_ready.1 {
2653 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2655 for reestablish in reestablish_2.iter() {
2656 assert_eq!(reestablish.next_remote_commitment_number, 0);
2659 if send_channel_ready.0 || send_channel_ready.1 {
2660 // If we expect any channel_ready's, both sides better have set
2661 // next_holder_commitment_number to 1
2662 for reestablish in reestablish_1.iter() {
2663 assert_eq!(reestablish.next_local_commitment_number, 1);
2665 for reestablish in reestablish_2.iter() {
2666 assert_eq!(reestablish.next_local_commitment_number, 1);
2670 let mut resp_1 = Vec::new();
2671 for msg in reestablish_1 {
2672 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2673 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2675 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2676 check_added_monitors!(node_b, 1);
2678 check_added_monitors!(node_b, 0);
2681 let mut resp_2 = Vec::new();
2682 for msg in reestablish_2 {
2683 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2684 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2686 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2687 check_added_monitors!(node_a, 1);
2689 check_added_monitors!(node_a, 0);
2692 // We don't yet support both needing updates, as that would require a different commitment dance:
2693 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2694 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2695 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2696 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2698 for chan_msgs in resp_1.drain(..) {
2699 if send_channel_ready.0 {
2700 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2701 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2702 if !announcement_event.is_empty() {
2703 assert_eq!(announcement_event.len(), 1);
2704 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2705 //TODO: Test announcement_sigs re-sending
2706 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2709 assert!(chan_msgs.0.is_none());
2712 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2713 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2714 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2715 check_added_monitors!(node_a, 1);
2717 assert!(chan_msgs.1.is_none());
2719 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 {
2720 let commitment_update = chan_msgs.2.unwrap();
2721 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2722 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2724 assert!(commitment_update.update_add_htlcs.is_empty());
2726 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2727 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2728 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2729 for update_add in commitment_update.update_add_htlcs {
2730 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2732 for update_fulfill in commitment_update.update_fulfill_htlcs {
2733 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2735 for update_fail in commitment_update.update_fail_htlcs {
2736 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2739 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2740 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2742 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2743 check_added_monitors!(node_a, 1);
2744 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2745 // No commitment_signed so get_event_msg's assert(len == 1) passes
2746 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2747 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2748 check_added_monitors!(node_b, 1);
2751 assert!(chan_msgs.2.is_none());
2755 for chan_msgs in resp_2.drain(..) {
2756 if send_channel_ready.1 {
2757 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2758 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2759 if !announcement_event.is_empty() {
2760 assert_eq!(announcement_event.len(), 1);
2761 match announcement_event[0] {
2762 MessageSendEvent::SendChannelUpdate { .. } => {},
2763 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2764 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2768 assert!(chan_msgs.0.is_none());
2771 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2772 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2773 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2774 check_added_monitors!(node_b, 1);
2776 assert!(chan_msgs.1.is_none());
2778 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 {
2779 let commitment_update = chan_msgs.2.unwrap();
2780 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2781 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2783 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2784 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2785 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2786 for update_add in commitment_update.update_add_htlcs {
2787 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2789 for update_fulfill in commitment_update.update_fulfill_htlcs {
2790 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2792 for update_fail in commitment_update.update_fail_htlcs {
2793 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2796 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2797 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2799 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2800 check_added_monitors!(node_b, 1);
2801 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2802 // No commitment_signed so get_event_msg's assert(len == 1) passes
2803 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2804 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2805 check_added_monitors!(node_a, 1);
2808 assert!(chan_msgs.2.is_none());