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(), &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(), &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 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &open_channel_msg);
938 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
939 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
940 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_channel_msg);
941 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
943 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
946 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) {
947 confirm_transaction_at(node_conf, tx, conf_height);
948 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
949 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()));
952 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]) {
954 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
955 assert_eq!(events_6.len(), 3);
956 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
957 assert_eq!(*node_id, node_recv.node.get_our_node_id());
959 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
960 assert_eq!(*node_id, node_recv.node.get_our_node_id());
962 } else { panic!("Unexpected event: {:?}", events_6[1]); };
963 ((match events_6[0] {
964 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
965 channel_id = msg.channel_id.clone();
966 assert_eq!(*node_id, node_recv.node.get_our_node_id());
969 _ => panic!("Unexpected event"),
970 }, match events_6[announcement_sigs_idx] {
971 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
972 assert_eq!(*node_id, node_recv.node.get_our_node_id());
975 _ => panic!("Unexpected event"),
979 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]) {
980 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
981 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
982 confirm_transaction_at(node_a, tx, conf_height);
983 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
984 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
985 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
988 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) {
989 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
990 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
994 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) {
995 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
996 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
997 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
999 let events_7 = node_b.node.get_and_clear_pending_msg_events();
1000 assert_eq!(events_7.len(), 1);
1001 let (announcement, bs_update) = match events_7[0] {
1002 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1005 _ => panic!("Unexpected event"),
1008 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
1009 let events_8 = node_a.node.get_and_clear_pending_msg_events();
1010 assert_eq!(events_8.len(), 1);
1011 let as_update = match events_8[0] {
1012 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
1013 assert!(*announcement == *msg);
1014 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
1015 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
1018 _ => panic!("Unexpected event"),
1021 *node_a.network_chan_count.borrow_mut() += 1;
1023 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
1024 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
1027 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) {
1028 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
1031 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) {
1032 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
1033 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
1034 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
1037 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) {
1038 let mut no_announce_cfg = test_default_channel_config();
1039 no_announce_cfg.channel_handshake_config.announced_channel = false;
1040 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
1041 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
1042 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), &open_channel);
1043 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
1044 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), &accept_channel);
1046 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
1047 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
1048 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()));
1049 check_added_monitors!(nodes[b], 1);
1051 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
1052 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
1053 check_added_monitors!(nodes[a], 1);
1055 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
1056 confirm_transaction_at(&nodes[a], &tx, conf_height);
1057 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
1058 confirm_transaction_at(&nodes[b], &tx, conf_height);
1059 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
1060 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
1061 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()));
1062 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
1063 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
1064 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
1065 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
1066 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
1068 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
1069 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
1071 let mut found_a = false;
1072 for chan in nodes[a].node.list_usable_channels() {
1073 if chan.channel_id == as_channel_ready.channel_id {
1076 assert!(!chan.is_public);
1081 let mut found_b = false;
1082 for chan in nodes[b].node.list_usable_channels() {
1083 if chan.channel_id == as_channel_ready.channel_id {
1086 assert!(!chan.is_public);
1091 (as_channel_ready, tx)
1094 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) {
1096 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1097 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1098 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1100 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1101 // forwarding info for local channels even if its not accepted in the network graph.
1102 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1103 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1108 macro_rules! check_spends {
1109 ($tx: expr, $($spends_txn: expr),*) => {
1112 for outp in $spends_txn.output.iter() {
1113 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1116 for outp in $tx.output.iter() {
1117 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1119 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1121 if out_point.txid == $spends_txn.txid() {
1122 return $spends_txn.output.get(out_point.vout as usize).cloned()
1127 let mut total_value_in = 0;
1128 for input in $tx.input.iter() {
1129 total_value_in += get_output(&input.previous_output).unwrap().value;
1131 let mut total_value_out = 0;
1132 for output in $tx.output.iter() {
1133 total_value_out += output.value;
1135 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1136 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1137 assert!(total_value_out + min_fee <= total_value_in);
1138 $tx.verify(get_output).unwrap();
1143 macro_rules! get_closing_signed_broadcast {
1144 ($node: expr, $dest_pubkey: expr) => {
1146 let events = $node.get_and_clear_pending_msg_events();
1147 assert!(events.len() == 1 || events.len() == 2);
1148 (match events[events.len() - 1] {
1149 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1150 assert_eq!(msg.contents.flags & 2, 2);
1153 _ => panic!("Unexpected event"),
1154 }, if events.len() == 2 {
1156 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1157 assert_eq!(*node_id, $dest_pubkey);
1160 _ => panic!("Unexpected event"),
1168 macro_rules! check_warn_msg {
1169 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1170 let msg_events = $node.node.get_and_clear_pending_msg_events();
1171 assert_eq!(msg_events.len(), 1);
1172 match msg_events[0] {
1173 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1174 assert_eq!(node_id, $recipient_node_id);
1175 assert_eq!(msg.channel_id, $chan_id);
1178 _ => panic!("Unexpected event"),
1183 /// Check that a channel's closing channel update has been broadcasted, and optionally
1184 /// check whether an error message event has occurred.
1186 macro_rules! check_closed_broadcast {
1187 ($node: expr, $with_error_msg: expr) => {{
1188 use $crate::util::events::MessageSendEvent;
1189 use $crate::ln::msgs::ErrorAction;
1191 let msg_events = $node.node.get_and_clear_pending_msg_events();
1192 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1193 match msg_events[0] {
1194 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1195 assert_eq!(msg.contents.flags & 2, 2);
1197 _ => panic!("Unexpected event"),
1199 if $with_error_msg {
1200 match msg_events[1] {
1201 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1202 // TODO: Check node_id
1205 _ => panic!("Unexpected event"),
1211 /// Check that a channel's closing channel events has been issued
1213 macro_rules! check_closed_event {
1214 ($node: expr, $events: expr, $reason: expr) => {
1215 check_closed_event!($node, $events, $reason, false);
1217 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1218 use $crate::util::events::Event;
1220 let events = $node.node.get_and_clear_pending_events();
1221 assert_eq!(events.len(), $events, "{:?}", events);
1222 let expected_reason = $reason;
1223 let mut issues_discard_funding = false;
1224 for event in events {
1226 Event::ChannelClosed { ref reason, .. } => {
1227 assert_eq!(*reason, expected_reason);
1229 Event::DiscardFunding { .. } => {
1230 issues_discard_funding = true;
1232 _ => panic!("Unexpected event"),
1235 assert_eq!($is_check_discard_funding, issues_discard_funding);
1239 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) {
1240 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) };
1241 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) };
1244 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1245 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1247 let events_1 = node_b.get_and_clear_pending_msg_events();
1248 assert!(events_1.len() >= 1);
1249 let shutdown_b = match events_1[0] {
1250 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1251 assert_eq!(node_id, &node_a.get_our_node_id());
1254 _ => panic!("Unexpected event"),
1257 let closing_signed_b = if !close_inbound_first {
1258 assert_eq!(events_1.len(), 1);
1261 Some(match events_1[1] {
1262 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1263 assert_eq!(node_id, &node_a.get_our_node_id());
1266 _ => panic!("Unexpected event"),
1270 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b);
1271 let (as_update, bs_update) = if close_inbound_first {
1272 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1273 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1275 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1276 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1277 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1278 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1280 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1281 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1282 assert!(none_a.is_none());
1283 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1284 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1285 (as_update, bs_update)
1287 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1289 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1290 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1292 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1293 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1294 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1296 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1297 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1298 assert!(none_b.is_none());
1299 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1300 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1301 (as_update, bs_update)
1303 assert_eq!(tx_a, tx_b);
1304 check_spends!(tx_a, funding_tx);
1306 (as_update, bs_update, tx_a)
1309 pub struct SendEvent {
1310 pub node_id: PublicKey,
1311 pub msgs: Vec<msgs::UpdateAddHTLC>,
1312 pub commitment_msg: msgs::CommitmentSigned,
1315 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1316 assert!(updates.update_fulfill_htlcs.is_empty());
1317 assert!(updates.update_fail_htlcs.is_empty());
1318 assert!(updates.update_fail_malformed_htlcs.is_empty());
1319 assert!(updates.update_fee.is_none());
1320 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1323 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1325 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1326 _ => panic!("Unexpected event type!"),
1330 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1331 let mut events = node.node.get_and_clear_pending_msg_events();
1332 assert_eq!(events.len(), 1);
1333 SendEvent::from_event(events.pop().unwrap())
1338 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1339 /// commitment update.
1340 macro_rules! commitment_signed_dance {
1341 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1343 check_added_monitors!($node_a, 0);
1344 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1345 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1346 check_added_monitors!($node_a, 1);
1347 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1350 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1352 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1353 check_added_monitors!($node_b, 0);
1354 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1355 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1356 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1357 check_added_monitors!($node_b, 1);
1358 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1359 let (bs_revoke_and_ack, extra_msg_option) = {
1360 let events = $node_b.node.get_and_clear_pending_msg_events();
1361 assert!(events.len() <= 2);
1362 let (node_a_event, events) = remove_first_msg_event_to_node(&$node_a.node.get_our_node_id(), &events);
1363 (match node_a_event {
1364 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1365 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1368 _ => panic!("Unexpected event"),
1369 }, events.get(0).map(|e| e.clone()))
1371 check_added_monitors!($node_b, 1);
1372 if $fail_backwards {
1373 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1374 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1376 (extra_msg_option, bs_revoke_and_ack)
1379 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1381 check_added_monitors!($node_a, 0);
1382 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1383 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1384 check_added_monitors!($node_a, 1);
1385 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1386 assert!(extra_msg_option.is_none());
1390 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1392 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1393 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1394 check_added_monitors!($node_a, 1);
1398 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1400 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1403 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1405 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1406 if $fail_backwards {
1407 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 }]);
1408 check_added_monitors!($node_a, 1);
1410 let node_a_per_peer_state = $node_a.node.per_peer_state.read().unwrap();
1411 let mut number_of_msg_events = 0;
1412 for (cp_id, peer_state_mutex) in node_a_per_peer_state.iter() {
1413 let peer_state = peer_state_mutex.lock().unwrap();
1414 let cp_pending_msg_events = &peer_state.pending_msg_events;
1415 number_of_msg_events += cp_pending_msg_events.len();
1416 if cp_pending_msg_events.len() == 1 {
1417 if let MessageSendEvent::UpdateHTLCs { .. } = cp_pending_msg_events[0] {
1418 assert_ne!(*cp_id, $node_b.node.get_our_node_id());
1419 } else { panic!("Unexpected event"); }
1422 // Expecting the failure backwards event to the previous hop (not `node_b`)
1423 assert_eq!(number_of_msg_events, 1);
1425 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1431 /// Get a payment preimage and hash.
1433 macro_rules! get_payment_preimage_hash {
1434 ($dest_node: expr) => {
1436 get_payment_preimage_hash!($dest_node, None)
1439 ($dest_node: expr, $min_value_msat: expr) => {
1441 use bitcoin::hashes::Hash as _;
1442 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1443 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1444 *payment_count += 1;
1445 let payment_hash = $crate::ln::PaymentHash(
1446 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1447 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1448 (payment_preimage, payment_hash, payment_secret)
1454 macro_rules! get_route {
1455 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1456 use $crate::chain::keysinterface::EntropySource;
1457 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1458 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1459 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1460 $crate::routing::router::get_route(
1461 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1462 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1463 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1470 macro_rules! get_route_and_payment_hash {
1471 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1472 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1473 .with_features($recv_node.node.invoice_features());
1474 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1476 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1477 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1478 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1479 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1484 macro_rules! expect_pending_htlcs_forwardable_conditions {
1485 ($node: expr, $expected_failures: expr) => {{
1486 let expected_failures = $expected_failures;
1487 let events = $node.node.get_and_clear_pending_events();
1489 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1490 _ => panic!("Unexpected event {:?}", events),
1493 let count = expected_failures.len() + 1;
1494 assert_eq!(events.len(), count);
1496 if expected_failures.len() > 0 {
1497 expect_htlc_handling_failed_destinations!(events, expected_failures)
1503 macro_rules! expect_htlc_handling_failed_destinations {
1504 ($events: expr, $expected_failures: expr) => {{
1505 for event in $events {
1507 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1508 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1509 assert!($expected_failures.contains(&failed_next_destination))
1511 _ => panic!("Unexpected destination"),
1518 /// Clears (and ignores) a PendingHTLCsForwardable event
1519 macro_rules! expect_pending_htlcs_forwardable_ignore {
1521 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1526 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1527 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1528 ($node: expr, $expected_failures: expr) => {{
1529 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1534 /// Handles a PendingHTLCsForwardable event
1535 macro_rules! expect_pending_htlcs_forwardable {
1537 expect_pending_htlcs_forwardable_ignore!($node);
1538 $node.node.process_pending_htlc_forwards();
1540 // Ensure process_pending_htlc_forwards is idempotent.
1541 $node.node.process_pending_htlc_forwards();
1546 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1547 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1548 ($node: expr, $expected_failures: expr) => {{
1549 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1550 $node.node.process_pending_htlc_forwards();
1552 // Ensure process_pending_htlc_forwards is idempotent.
1553 $node.node.process_pending_htlc_forwards();
1558 macro_rules! expect_pending_htlcs_forwardable_from_events {
1559 ($node: expr, $events: expr, $ignore: expr) => {{
1560 assert_eq!($events.len(), 1);
1562 Event::PendingHTLCsForwardable { .. } => { },
1563 _ => panic!("Unexpected event"),
1566 $node.node.process_pending_htlc_forwards();
1568 // Ensure process_pending_htlc_forwards is idempotent.
1569 $node.node.process_pending_htlc_forwards();
1574 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1575 macro_rules! expect_payment_claimable {
1576 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1577 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1579 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1580 let events = $node.node.get_and_clear_pending_events();
1581 assert_eq!(events.len(), 1);
1583 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1584 assert_eq!($expected_payment_hash, *payment_hash);
1585 assert_eq!($expected_recv_value, amount_msat);
1586 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1588 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1589 assert_eq!(&$expected_payment_preimage, payment_preimage);
1590 assert_eq!($expected_payment_secret, *payment_secret);
1595 _ => panic!("Unexpected event"),
1601 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1602 macro_rules! expect_payment_claimed {
1603 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1604 let events = $node.node.get_and_clear_pending_events();
1605 assert_eq!(events.len(), 1);
1607 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1608 assert_eq!($expected_payment_hash, *payment_hash);
1609 assert_eq!($expected_recv_value, amount_msat);
1611 _ => panic!("Unexpected event"),
1618 macro_rules! expect_payment_sent_without_paths {
1619 ($node: expr, $expected_payment_preimage: expr) => {
1620 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1622 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1623 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1628 macro_rules! expect_payment_sent {
1629 ($node: expr, $expected_payment_preimage: expr) => {
1630 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1632 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1633 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1635 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1636 use bitcoin::hashes::Hash as _;
1637 let events = $node.node.get_and_clear_pending_events();
1638 let expected_payment_hash = $crate::ln::PaymentHash(
1639 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1641 assert!(events.len() > 1);
1643 assert_eq!(events.len(), 1);
1645 let expected_payment_id = match events[0] {
1646 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1647 assert_eq!($expected_payment_preimage, *payment_preimage);
1648 assert_eq!(expected_payment_hash, *payment_hash);
1649 assert!(fee_paid_msat.is_some());
1650 if $expected_fee_msat_opt.is_some() {
1651 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1655 _ => panic!("Unexpected event"),
1658 for i in 1..events.len() {
1660 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1661 assert_eq!(payment_id, expected_payment_id);
1662 assert_eq!(payment_hash, Some(expected_payment_hash));
1664 _ => panic!("Unexpected event"),
1673 macro_rules! expect_payment_path_successful {
1675 let events = $node.node.get_and_clear_pending_events();
1676 assert_eq!(events.len(), 1);
1678 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1679 _ => panic!("Unexpected event"),
1684 macro_rules! expect_payment_forwarded {
1685 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1686 let events = $node.node.get_and_clear_pending_events();
1687 assert_eq!(events.len(), 1);
1689 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1690 assert_eq!(fee_earned_msat, $expected_fee);
1691 if fee_earned_msat.is_some() {
1692 // Is the event prev_channel_id in one of the channels between the two nodes?
1693 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()));
1695 // We check for force closures since a force closed channel is removed from the
1696 // node's channel list
1697 if !$downstream_force_closed {
1698 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()));
1700 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1702 _ => panic!("Unexpected event"),
1707 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1708 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1709 let events = node.node.get_and_clear_pending_events();
1710 assert_eq!(events.len(), 1);
1712 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1713 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1715 _ => panic!("Unexpected event"),
1720 pub struct PaymentFailedConditions<'a> {
1721 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1722 pub(crate) expected_blamed_scid: Option<u64>,
1723 pub(crate) expected_blamed_chan_closed: Option<bool>,
1724 pub(crate) expected_mpp_parts_remain: bool,
1727 impl<'a> PaymentFailedConditions<'a> {
1728 pub fn new() -> Self {
1730 expected_htlc_error_data: None,
1731 expected_blamed_scid: None,
1732 expected_blamed_chan_closed: None,
1733 expected_mpp_parts_remain: false,
1736 pub fn mpp_parts_remain(mut self) -> Self {
1737 self.expected_mpp_parts_remain = true;
1740 pub fn blamed_scid(mut self, scid: u64) -> Self {
1741 self.expected_blamed_scid = Some(scid);
1744 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1745 self.expected_blamed_chan_closed = Some(closed);
1748 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1749 self.expected_htlc_error_data = Some((code, data));
1755 macro_rules! expect_payment_failed_with_update {
1756 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1757 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1758 &$node, $expected_payment_hash, $payment_failed_permanently,
1759 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1760 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1765 macro_rules! expect_payment_failed {
1766 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1767 #[allow(unused_mut)]
1768 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1770 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1772 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1776 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1777 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1778 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1780 let expected_payment_id = match payment_failed_event {
1781 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1785 error_data, .. } => {
1786 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1787 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1788 assert!(retry.is_some(), "expected retry.is_some()");
1789 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1790 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1791 if let Some(scid) = short_channel_id {
1792 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1797 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1798 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1799 if let Some((code, data)) = conditions.expected_htlc_error_data {
1800 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1801 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1805 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1806 match network_update {
1807 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1808 if let Some(scid) = conditions.expected_blamed_scid {
1809 assert_eq!(msg.contents.short_channel_id, scid);
1811 const CHAN_DISABLED_FLAG: u8 = 2;
1812 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1814 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1815 if let Some(scid) = conditions.expected_blamed_scid {
1816 assert_eq!(short_channel_id, scid);
1818 assert!(is_permanent);
1820 Some(_) => panic!("Unexpected update type"),
1821 None => panic!("Expected update"),
1827 _ => panic!("Unexpected event"),
1829 if !conditions.expected_mpp_parts_remain {
1830 node.node.abandon_payment(expected_payment_id);
1831 let events = node.node.get_and_clear_pending_events();
1832 assert_eq!(events.len(), 1);
1834 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1835 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1836 assert_eq!(*payment_id, expected_payment_id);
1838 _ => panic!("Unexpected second event"),
1843 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1844 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1845 conditions: PaymentFailedConditions<'e>
1847 let mut events = node.node.get_and_clear_pending_events();
1848 assert_eq!(events.len(), 1);
1849 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1852 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 {
1853 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1854 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1855 check_added_monitors!(origin_node, expected_paths.len());
1856 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1860 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>) {
1861 let mut payment_event = SendEvent::from_event(ev);
1862 let mut prev_node = origin_node;
1864 for (idx, &node) in expected_path.iter().enumerate() {
1865 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1867 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1868 check_added_monitors!(node, 0);
1869 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1871 expect_pending_htlcs_forwardable!(node);
1873 if idx == expected_path.len() - 1 && clear_recipient_events {
1874 let events_2 = node.node.get_and_clear_pending_events();
1875 if payment_claimable_expected {
1876 assert_eq!(events_2.len(), 1);
1878 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1879 assert_eq!(our_payment_hash, *payment_hash);
1880 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1882 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1883 assert_eq!(expected_preimage, *payment_preimage);
1884 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1886 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1887 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1888 assert!(our_payment_secret.is_none());
1891 assert_eq!(amount_msat, recv_value);
1892 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1893 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1895 _ => panic!("Unexpected event"),
1898 assert!(events_2.is_empty());
1900 } else if idx != expected_path.len() - 1 {
1901 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1902 assert_eq!(events_2.len(), 1);
1903 check_added_monitors!(node, 1);
1904 payment_event = SendEvent::from_event(events_2.remove(0));
1905 assert_eq!(payment_event.msgs.len(), 1);
1912 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>) {
1913 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1916 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) {
1917 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1918 assert_eq!(events.len(), expected_route.len());
1919 for (path_idx, expected_path) in expected_route.iter().enumerate() {
1920 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1921 events = updated_events;
1922 // Once we've gotten through all the HTLCs, the last one should result in a
1923 // PaymentClaimable (but each previous one should not!), .
1924 let expect_payment = path_idx == expected_route.len() - 1;
1925 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1929 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) {
1930 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1931 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1932 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1935 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 {
1936 for path in expected_paths.iter() {
1937 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1939 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1941 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1942 assert_eq!(claim_event.len(), 1);
1943 match claim_event[0] {
1944 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1945 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1946 assert_eq!(preimage, our_payment_preimage),
1947 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1948 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1952 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1954 let mut expected_total_fee_msat = 0;
1956 macro_rules! msgs_from_ev {
1959 &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 } } => {
1960 assert!(update_add_htlcs.is_empty());
1961 assert_eq!(update_fulfill_htlcs.len(), 1);
1962 assert!(update_fail_htlcs.is_empty());
1963 assert!(update_fail_malformed_htlcs.is_empty());
1964 assert!(update_fee.is_none());
1965 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1967 _ => panic!("Unexpected event"),
1971 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1972 let mut events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1973 assert_eq!(events.len(), expected_paths.len());
1975 if events.len() == 1 {
1976 per_path_msgs.push(msgs_from_ev!(&events[0]));
1978 for expected_path in expected_paths.iter() {
1979 // For MPP payments, we always want the message to the first node in the path.
1980 let (ev, updated_events) = remove_first_msg_event_to_node(&expected_path[0].node.get_our_node_id(), &events);
1981 per_path_msgs.push(msgs_from_ev!(&ev));
1982 events = updated_events;
1986 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1987 let mut next_msgs = Some(path_msgs);
1988 let mut expected_next_node = next_hop;
1990 macro_rules! last_update_fulfill_dance {
1991 ($node: expr, $prev_node: expr) => {
1993 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1994 check_added_monitors!($node, 0);
1995 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1996 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2000 macro_rules! mid_update_fulfill_dance {
2001 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
2003 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2005 let per_peer_state = $node.node.per_peer_state.read().unwrap();
2006 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
2007 .unwrap().lock().unwrap();
2008 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
2009 if let Some(prev_config) = channel.prev_config() {
2010 prev_config.forwarding_fee_base_msat
2012 channel.config().forwarding_fee_base_msat
2015 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
2016 expected_total_fee_msat += fee as u64;
2017 check_added_monitors!($node, 1);
2018 let new_next_msgs = if $new_msgs {
2019 let events = $node.node.get_and_clear_pending_msg_events();
2020 assert_eq!(events.len(), 1);
2021 let (res, nexthop) = msgs_from_ev!(&events[0]);
2022 expected_next_node = nexthop;
2025 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
2028 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
2029 next_msgs = new_next_msgs;
2034 let mut prev_node = expected_route.last().unwrap();
2035 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2036 assert_eq!(expected_next_node, node.node.get_our_node_id());
2037 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
2038 if next_msgs.is_some() {
2039 // Since we are traversing in reverse, next_node is actually the previous node
2040 let next_node: &Node;
2041 if idx == expected_route.len() - 1 {
2042 next_node = origin_node;
2044 next_node = expected_route[expected_route.len() - 1 - idx - 1];
2046 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
2048 assert!(!update_next_msgs);
2049 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
2051 if !skip_last && idx == expected_route.len() - 1 {
2052 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2059 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
2063 // Ensure that claim_funds is idempotent.
2064 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
2065 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2066 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2068 expected_total_fee_msat
2070 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) {
2071 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
2073 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
2077 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
2078 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
2081 pub const TEST_FINAL_CLTV: u32 = 70;
2083 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) {
2084 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2085 .with_features(expected_route.last().unwrap().node.invoice_features());
2086 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
2087 assert_eq!(route.paths.len(), 1);
2088 assert_eq!(route.paths[0].len(), expected_route.len());
2089 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2090 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2093 let res = send_along_route(origin_node, route, expected_route, recv_value);
2094 (res.0, res.1, res.2)
2097 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2098 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
2099 .with_features(expected_route.last().unwrap().node.invoice_features());
2100 let network_graph = origin_node.network_graph.read_only();
2101 let scorer = test_utils::TestScorer::with_penalty(0);
2102 let seed = [0u8; 32];
2103 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2104 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2105 let route = get_route(
2106 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2107 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2108 assert_eq!(route.paths.len(), 1);
2109 assert_eq!(route.paths[0].len(), expected_route.len());
2110 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2111 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2114 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2115 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 },
2116 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2119 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2120 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2121 claim_payment(&origin, expected_route, our_payment_preimage);
2124 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) {
2125 for path in expected_paths.iter() {
2126 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2128 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2129 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2130 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2132 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2135 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) {
2136 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2138 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2139 let events = origin_node.node.get_and_clear_pending_events();
2140 assert_eq!(events.len(), 1);
2142 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2143 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2144 assert_eq!(*payment_id, expected_payment_id.unwrap());
2146 _ => panic!("Unexpected second event"),
2151 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> {
2152 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2153 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2155 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2156 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2157 assert_eq!(events.len(), expected_paths.len());
2158 for ev in events.iter() {
2159 let (update_fail, commitment_signed, node_id) = match ev {
2160 &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 } } => {
2161 assert!(update_add_htlcs.is_empty());
2162 assert!(update_fulfill_htlcs.is_empty());
2163 assert_eq!(update_fail_htlcs.len(), 1);
2164 assert!(update_fail_malformed_htlcs.is_empty());
2165 assert!(update_fee.is_none());
2166 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2168 _ => panic!("Unexpected event"),
2170 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2172 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2173 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()));
2175 let mut expected_payment_id = None;
2177 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2178 let mut next_msgs = Some(path_msgs);
2179 let mut expected_next_node = next_hop;
2180 let mut prev_node = expected_route.last().unwrap();
2182 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2183 assert_eq!(expected_next_node, node.node.get_our_node_id());
2184 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2185 if next_msgs.is_some() {
2186 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2187 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2188 if !update_next_node {
2189 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 }]);
2192 let events = node.node.get_and_clear_pending_msg_events();
2193 if update_next_node {
2194 assert_eq!(events.len(), 1);
2196 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 } } => {
2197 assert!(update_add_htlcs.is_empty());
2198 assert!(update_fulfill_htlcs.is_empty());
2199 assert_eq!(update_fail_htlcs.len(), 1);
2200 assert!(update_fail_malformed_htlcs.is_empty());
2201 assert!(update_fee.is_none());
2202 expected_next_node = node_id.clone();
2203 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2205 _ => panic!("Unexpected event"),
2208 assert!(events.is_empty());
2210 if !skip_last && idx == expected_route.len() - 1 {
2211 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2218 let prev_node = expected_route.first().unwrap();
2219 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2220 check_added_monitors!(origin_node, 0);
2221 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2222 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2223 let events = origin_node.node.get_and_clear_pending_events();
2224 assert_eq!(events.len(), 1);
2225 expected_payment_id = Some(match events[0] {
2226 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2227 assert_eq!(payment_hash, our_payment_hash);
2228 assert!(payment_failed_permanently);
2229 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2230 for (idx, hop) in expected_route.iter().enumerate() {
2231 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2235 _ => panic!("Unexpected event"),
2240 // Ensure that fail_htlc_backwards is idempotent.
2241 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2242 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2243 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2244 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2249 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2250 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2253 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2254 let mut chan_mon_cfgs = Vec::new();
2255 for i in 0..node_count {
2256 let tx_broadcaster = test_utils::TestBroadcaster {
2257 txn_broadcasted: Mutex::new(Vec::new()),
2258 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2260 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2261 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2262 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2263 let persister = test_utils::TestPersister::new();
2264 let seed = [i as u8; 32];
2265 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2267 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2273 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2274 let mut nodes = Vec::new();
2276 for i in 0..node_count {
2277 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);
2278 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2279 let seed = [i as u8; 32];
2280 nodes.push(NodeCfg {
2281 chain_source: &chanmon_cfgs[i].chain_source,
2282 logger: &chanmon_cfgs[i].logger,
2283 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2284 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2285 router: test_utils::TestRouter::new(network_graph.clone()),
2287 keys_manager: &chanmon_cfgs[i].keys_manager,
2290 override_init_features: Rc::new(RefCell::new(None)),
2297 pub fn test_default_channel_config() -> UserConfig {
2298 let mut default_config = UserConfig::default();
2299 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2300 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2301 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2302 default_config.channel_handshake_config.announced_channel = true;
2303 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2304 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2305 // It now defaults to 1, so we simply set it to the expected value here.
2306 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2307 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2308 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2309 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2313 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>> {
2314 let mut chanmgrs = Vec::new();
2315 for i in 0..node_count {
2316 let network = Network::Testnet;
2317 let params = ChainParameters {
2319 best_block: BestBlock::from_genesis(network),
2321 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,
2322 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);
2323 chanmgrs.push(node);
2329 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>> {
2330 let mut nodes = Vec::new();
2331 let chan_count = Rc::new(RefCell::new(0));
2332 let payment_count = Rc::new(RefCell::new(0));
2333 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2335 for i in 0..node_count {
2336 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2338 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2339 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2340 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2341 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2342 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2343 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2344 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2345 connect_style: Rc::clone(&connect_style),
2346 override_init_features: Rc::clone(&cfgs[i].override_init_features),
2350 for i in 0..node_count {
2351 for j in (i+1)..node_count {
2352 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();
2353 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();
2360 // Note that the following only works for CLTV values up to 128
2361 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2363 #[derive(PartialEq)]
2364 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2365 /// Tests that the given node has broadcast transactions for the given Channel
2367 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2368 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2369 /// broadcast and the revoked outputs were claimed.
2371 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2372 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2374 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2376 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> {
2377 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2378 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2380 let mut res = Vec::with_capacity(2);
2381 node_txn.retain(|tx| {
2382 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2383 check_spends!(tx, chan.3);
2384 if commitment_tx.is_none() {
2385 res.push(tx.clone());
2390 if let Some(explicit_tx) = commitment_tx {
2391 res.push(explicit_tx.clone());
2394 assert_eq!(res.len(), 1);
2396 if has_htlc_tx != HTLCType::NONE {
2397 node_txn.retain(|tx| {
2398 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2399 check_spends!(tx, res[0]);
2400 if has_htlc_tx == HTLCType::TIMEOUT {
2401 assert!(tx.lock_time.0 != 0);
2403 assert!(tx.lock_time.0 == 0);
2405 res.push(tx.clone());
2409 assert!(res.len() == 2 || res.len() == 3);
2411 assert_eq!(res[1], res[2]);
2415 assert!(node_txn.is_empty());
2419 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2420 /// HTLC transaction.
2421 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2422 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2423 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2424 // for revoked htlc outputs
2425 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2426 node_txn.retain(|tx| {
2427 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2428 check_spends!(tx, revoked_tx);
2432 node_txn.retain(|tx| {
2433 check_spends!(tx, commitment_revoked_tx);
2436 assert!(node_txn.is_empty());
2439 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2440 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2442 assert!(node_txn.len() >= 1);
2443 assert_eq!(node_txn[0].input.len(), 1);
2444 let mut found_prev = false;
2446 for tx in prev_txn {
2447 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2448 check_spends!(node_txn[0], tx);
2449 let mut iter = node_txn[0].input[0].witness.iter();
2450 iter.next().expect("expected 3 witness items");
2451 iter.next().expect("expected 3 witness items");
2452 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2453 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2459 assert!(found_prev);
2461 let mut res = Vec::new();
2462 mem::swap(&mut *node_txn, &mut res);
2466 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) {
2467 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2468 assert_eq!(events_1.len(), 2);
2469 let as_update = match events_1[0] {
2470 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2473 _ => panic!("Unexpected event"),
2476 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2477 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2478 assert_eq!(msg.data, expected_error);
2479 if needs_err_handle {
2480 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2483 _ => panic!("Unexpected event"),
2486 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2487 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2488 let bs_update = match events_2[0] {
2489 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2492 _ => panic!("Unexpected event"),
2494 if !needs_err_handle {
2496 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2497 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2498 assert_eq!(msg.data, expected_error);
2500 _ => panic!("Unexpected event"),
2505 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2506 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2510 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2511 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2515 macro_rules! get_channel_value_stat {
2516 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2517 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2518 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2519 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2520 chan.get_value_stat()
2524 macro_rules! get_chan_reestablish_msgs {
2525 ($src_node: expr, $dst_node: expr) => {
2527 let mut announcements = $crate::prelude::HashSet::new();
2528 let mut res = Vec::with_capacity(1);
2529 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2530 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2531 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2532 res.push(msg.clone());
2533 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2534 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2535 announcements.insert(msg.contents.short_channel_id);
2537 panic!("Unexpected event")
2540 for chan in $src_node.node.list_channels() {
2541 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2542 if let Some(scid) = chan.short_channel_id {
2543 assert!(announcements.remove(&scid));
2547 assert!(announcements.is_empty());
2553 macro_rules! handle_chan_reestablish_msgs {
2554 ($src_node: expr, $dst_node: expr) => {
2556 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2558 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2560 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2566 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2568 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2571 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2572 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2573 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2575 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2576 had_channel_update = true;
2579 let mut revoke_and_ack = None;
2580 let mut commitment_update = None;
2581 let order = if let Some(ev) = msg_events.get(idx) {
2583 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2584 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2585 revoke_and_ack = Some(msg.clone());
2587 RAACommitmentOrder::RevokeAndACKFirst
2589 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2590 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2591 commitment_update = Some(updates.clone());
2593 RAACommitmentOrder::CommitmentFirst
2595 _ => RAACommitmentOrder::CommitmentFirst,
2598 RAACommitmentOrder::CommitmentFirst
2601 if let Some(ev) = msg_events.get(idx) {
2603 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2604 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2605 assert!(revoke_and_ack.is_none());
2606 revoke_and_ack = Some(msg.clone());
2609 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2610 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2611 assert!(commitment_update.is_none());
2612 commitment_update = Some(updates.clone());
2619 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2620 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2622 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2623 assert!(!had_channel_update);
2626 assert_eq!(msg_events.len(), idx);
2628 (channel_ready, revoke_and_ack, commitment_update, order)
2633 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2634 /// for claims/fails they are separated out.
2635 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)) {
2636 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();
2637 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2638 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();
2639 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2641 if send_channel_ready.0 {
2642 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2644 for reestablish in reestablish_1.iter() {
2645 assert_eq!(reestablish.next_remote_commitment_number, 0);
2648 if send_channel_ready.1 {
2649 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2651 for reestablish in reestablish_2.iter() {
2652 assert_eq!(reestablish.next_remote_commitment_number, 0);
2655 if send_channel_ready.0 || send_channel_ready.1 {
2656 // If we expect any channel_ready's, both sides better have set
2657 // next_holder_commitment_number to 1
2658 for reestablish in reestablish_1.iter() {
2659 assert_eq!(reestablish.next_local_commitment_number, 1);
2661 for reestablish in reestablish_2.iter() {
2662 assert_eq!(reestablish.next_local_commitment_number, 1);
2666 let mut resp_1 = Vec::new();
2667 for msg in reestablish_1 {
2668 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2669 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2671 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2672 check_added_monitors!(node_b, 1);
2674 check_added_monitors!(node_b, 0);
2677 let mut resp_2 = Vec::new();
2678 for msg in reestablish_2 {
2679 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2680 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2682 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2683 check_added_monitors!(node_a, 1);
2685 check_added_monitors!(node_a, 0);
2688 // We don't yet support both needing updates, as that would require a different commitment dance:
2689 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2690 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2691 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2692 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2694 for chan_msgs in resp_1.drain(..) {
2695 if send_channel_ready.0 {
2696 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2697 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2698 if !announcement_event.is_empty() {
2699 assert_eq!(announcement_event.len(), 1);
2700 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2701 //TODO: Test announcement_sigs re-sending
2702 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2705 assert!(chan_msgs.0.is_none());
2708 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2709 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2710 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2711 check_added_monitors!(node_a, 1);
2713 assert!(chan_msgs.1.is_none());
2715 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 {
2716 let commitment_update = chan_msgs.2.unwrap();
2717 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2718 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2720 assert!(commitment_update.update_add_htlcs.is_empty());
2722 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2723 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2724 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2725 for update_add in commitment_update.update_add_htlcs {
2726 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2728 for update_fulfill in commitment_update.update_fulfill_htlcs {
2729 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2731 for update_fail in commitment_update.update_fail_htlcs {
2732 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2735 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2736 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2738 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2739 check_added_monitors!(node_a, 1);
2740 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2741 // No commitment_signed so get_event_msg's assert(len == 1) passes
2742 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2743 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2744 check_added_monitors!(node_b, 1);
2747 assert!(chan_msgs.2.is_none());
2751 for chan_msgs in resp_2.drain(..) {
2752 if send_channel_ready.1 {
2753 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2754 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2755 if !announcement_event.is_empty() {
2756 assert_eq!(announcement_event.len(), 1);
2757 match announcement_event[0] {
2758 MessageSendEvent::SendChannelUpdate { .. } => {},
2759 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2760 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2764 assert!(chan_msgs.0.is_none());
2767 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2768 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2769 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2770 check_added_monitors!(node_b, 1);
2772 assert!(chan_msgs.1.is_none());
2774 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 {
2775 let commitment_update = chan_msgs.2.unwrap();
2776 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2777 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2779 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2780 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2781 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2782 for update_add in commitment_update.update_add_htlcs {
2783 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2785 for update_fulfill in commitment_update.update_fulfill_htlcs {
2786 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2788 for update_fail in commitment_update.update_fail_htlcs {
2789 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2792 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2793 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2795 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2796 check_added_monitors!(node_b, 1);
2797 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2798 // No commitment_signed so get_event_msg's assert(len == 1) passes
2799 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2800 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2801 check_added_monitors!(node_a, 1);
2804 assert!(chan_msgs.2.is_none());