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::{self, 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 features: 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, &'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>>,
330 impl<'a, 'b, 'c> Node<'a, 'b, 'c> {
331 pub fn best_block_hash(&self) -> BlockHash {
332 self.blocks.lock().unwrap().last().unwrap().0.block_hash()
334 pub fn best_block_info(&self) -> (BlockHash, u32) {
335 self.blocks.lock().unwrap().last().map(|(a, b)| (a.block_hash(), *b)).unwrap()
337 pub fn get_block_header(&self, height: u32) -> BlockHeader {
338 self.blocks.lock().unwrap()[height as usize].0.header
342 impl<'a, 'b, 'c> Drop for Node<'a, 'b, 'c> {
345 // Check that we processed all pending events
346 let msg_events = self.node.get_and_clear_pending_msg_events();
347 if !msg_events.is_empty() {
348 panic!("Had excess message events on node {}: {:?}", self.logger.id, msg_events);
350 let events = self.node.get_and_clear_pending_events();
351 if !events.is_empty() {
352 panic!("Had excess events on node {}: {:?}", self.logger.id, events);
354 let added_monitors = self.chain_monitor.added_monitors.lock().unwrap().split_off(0);
355 if !added_monitors.is_empty() {
356 panic!("Had {} excess added monitors on node {}", added_monitors.len(), self.logger.id);
359 // Check that if we serialize the network graph, we can deserialize it again.
360 let network_graph = {
361 let mut w = test_utils::TestVecWriter(Vec::new());
362 self.network_graph.write(&mut w).unwrap();
363 let network_graph_deser = <NetworkGraph<_>>::read(&mut io::Cursor::new(&w.0), self.logger).unwrap();
364 assert!(network_graph_deser == *self.network_graph);
365 let gossip_sync = P2PGossipSync::new(
366 &network_graph_deser, Some(self.chain_source), self.logger
368 let mut chan_progress = 0;
370 let orig_announcements = self.gossip_sync.get_next_channel_announcement(chan_progress);
371 let deserialized_announcements = gossip_sync.get_next_channel_announcement(chan_progress);
372 assert!(orig_announcements == deserialized_announcements);
373 chan_progress = match orig_announcements {
374 Some(announcement) => announcement.0.contents.short_channel_id + 1,
378 let mut node_progress = None;
380 let orig_announcements = self.gossip_sync.get_next_node_announcement(node_progress.as_ref());
381 let deserialized_announcements = gossip_sync.get_next_node_announcement(node_progress.as_ref());
382 assert!(orig_announcements == deserialized_announcements);
383 node_progress = match orig_announcements {
384 Some(announcement) => Some(announcement.contents.node_id),
391 // Check that if we serialize and then deserialize all our channel monitors we get the
392 // same set of outputs to watch for on chain as we have now. Note that if we write
393 // tests that fully close channels and remove the monitors at some point this may break.
394 let feeest = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
395 let mut deserialized_monitors = Vec::new();
397 for outpoint in self.chain_monitor.chain_monitor.list_monitors() {
398 let mut w = test_utils::TestVecWriter(Vec::new());
399 self.chain_monitor.chain_monitor.get_monitor(outpoint).unwrap().write(&mut w).unwrap();
400 let (_, deserialized_monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>::read(
401 &mut io::Cursor::new(&w.0), self.keys_manager).unwrap();
402 deserialized_monitors.push(deserialized_monitor);
406 let broadcaster = test_utils::TestBroadcaster {
407 txn_broadcasted: Mutex::new(self.tx_broadcaster.txn_broadcasted.lock().unwrap().clone()),
408 blocks: Arc::new(Mutex::new(self.tx_broadcaster.blocks.lock().unwrap().clone())),
411 // Before using all the new monitors to check the watch outpoints, use the full set of
412 // them to ensure we can write and reload our ChannelManager.
414 let mut channel_monitors = HashMap::new();
415 for monitor in deserialized_monitors.iter_mut() {
416 channel_monitors.insert(monitor.get_funding_txo().0, monitor);
419 let mut w = test_utils::TestVecWriter(Vec::new());
420 self.node.write(&mut w).unwrap();
421 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut io::Cursor::new(w.0), ChannelManagerReadArgs {
422 default_config: *self.node.get_current_default_configuration(),
423 keys_manager: self.keys_manager,
424 fee_estimator: &test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) },
425 router: &test_utils::TestRouter::new(Arc::new(network_graph)),
426 chain_monitor: self.chain_monitor,
427 tx_broadcaster: &broadcaster,
428 logger: &self.logger,
433 let persister = test_utils::TestPersister::new();
434 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
435 let chain_monitor = test_utils::TestChainMonitor::new(Some(&chain_source), &broadcaster, &self.logger, &feeest, &persister, &self.keys_manager);
436 for deserialized_monitor in deserialized_monitors.drain(..) {
437 if chain_monitor.watch_channel(deserialized_monitor.get_funding_txo().0, deserialized_monitor) != ChannelMonitorUpdateStatus::Completed {
441 assert_eq!(*chain_source.watched_txn.lock().unwrap(), *self.chain_source.watched_txn.lock().unwrap());
442 assert_eq!(*chain_source.watched_outputs.lock().unwrap(), *self.chain_source.watched_outputs.lock().unwrap());
447 pub fn create_chan_between_nodes<'a, 'b, 'c, 'd>(node_a: &'a Node<'b, 'c, 'd>, node_b: &'a Node<'b, 'c, 'd>, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
448 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001, a_flags, b_flags)
451 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, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
452 let (channel_ready, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
453 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &channel_ready);
454 (announcement, as_update, bs_update, channel_id, tx)
458 /// Gets an RAA and CS which were sent in response to a commitment update
459 macro_rules! get_revoke_commit_msgs {
460 ($node: expr, $node_id: expr) => {
462 use $crate::util::events::MessageSendEvent;
463 let events = $node.node.get_and_clear_pending_msg_events();
464 assert_eq!(events.len(), 2);
466 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
467 assert_eq!(*node_id, $node_id);
470 _ => panic!("Unexpected event"),
472 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
473 assert_eq!(*node_id, $node_id);
474 assert!(updates.update_add_htlcs.is_empty());
475 assert!(updates.update_fulfill_htlcs.is_empty());
476 assert!(updates.update_fail_htlcs.is_empty());
477 assert!(updates.update_fail_malformed_htlcs.is_empty());
478 assert!(updates.update_fee.is_none());
479 updates.commitment_signed.clone()
481 _ => panic!("Unexpected event"),
487 /// Get an specific event message from the pending events queue.
489 macro_rules! get_event_msg {
490 ($node: expr, $event_type: path, $node_id: expr) => {
492 let events = $node.node.get_and_clear_pending_msg_events();
493 assert_eq!(events.len(), 1);
495 $event_type { ref node_id, ref msg } => {
496 assert_eq!(*node_id, $node_id);
499 _ => panic!("Unexpected event"),
505 /// Get an error message from the pending events queue.
507 macro_rules! get_err_msg {
508 ($node: expr, $node_id: expr) => {
510 let events = $node.node.get_and_clear_pending_msg_events();
511 assert_eq!(events.len(), 1);
513 $crate::util::events::MessageSendEvent::HandleError {
514 action: $crate::ln::msgs::ErrorAction::SendErrorMessage { ref msg }, ref node_id
516 assert_eq!(*node_id, $node_id);
519 _ => panic!("Unexpected event"),
525 /// Get a specific event from the pending events queue.
527 macro_rules! get_event {
528 ($node: expr, $event_type: path) => {
530 let mut events = $node.node.get_and_clear_pending_events();
531 assert_eq!(events.len(), 1);
532 let ev = events.pop().unwrap();
534 $event_type { .. } => {
537 _ => panic!("Unexpected event"),
544 /// Gets an UpdateHTLCs MessageSendEvent
545 macro_rules! get_htlc_update_msgs {
546 ($node: expr, $node_id: expr) => {
548 let events = $node.node.get_and_clear_pending_msg_events();
549 assert_eq!(events.len(), 1);
551 $crate::util::events::MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
552 assert_eq!(*node_id, $node_id);
555 _ => panic!("Unexpected event"),
562 macro_rules! get_channel_ref {
563 ($node: expr, $counterparty_node: expr, $per_peer_state_lock: ident, $peer_state_lock: ident, $channel_id: expr) => {
565 $per_peer_state_lock = $node.node.per_peer_state.read().unwrap();
566 $peer_state_lock = $per_peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
567 $peer_state_lock.channel_by_id.get_mut(&$channel_id).unwrap()
573 macro_rules! get_feerate {
574 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
576 let mut per_peer_state_lock;
577 let mut peer_state_lock;
578 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
585 macro_rules! get_opt_anchors {
586 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {
588 let mut per_peer_state_lock;
589 let mut peer_state_lock;
590 let chan = get_channel_ref!($node, $counterparty_node, per_peer_state_lock, peer_state_lock, $channel_id);
596 /// Returns a channel monitor given a channel id, making some naive assumptions
598 macro_rules! get_monitor {
599 ($node: expr, $channel_id: expr) => {
601 use bitcoin::hashes::Hash;
602 let mut monitor = None;
603 // Assume funding vout is either 0 or 1 blindly
605 if let Ok(mon) = $node.chain_monitor.chain_monitor.get_monitor(
606 $crate::chain::transaction::OutPoint {
607 txid: bitcoin::Txid::from_slice(&$channel_id[..]).unwrap(), index
619 /// Returns any local commitment transactions for the channel.
621 macro_rules! get_local_commitment_txn {
622 ($node: expr, $channel_id: expr) => {
624 $crate::get_monitor!($node, $channel_id).unsafe_get_latest_holder_commitment_txn(&$node.logger)
629 /// Check the error from attempting a payment.
631 macro_rules! unwrap_send_err {
632 ($res: expr, $all_failed: expr, $type: pat, $check: expr) => {
634 &Err(PaymentSendFailure::AllFailedResendSafe(ref fails)) if $all_failed => {
635 assert_eq!(fails.len(), 1);
641 &Err(PaymentSendFailure::PartialFailure { ref results, .. }) if !$all_failed => {
642 assert_eq!(results.len(), 1);
644 Err($type) => { $check },
653 /// Check whether N channel monitor(s) have been added.
655 macro_rules! check_added_monitors {
656 ($node: expr, $count: expr) => {
658 let mut added_monitors = $node.chain_monitor.added_monitors.lock().unwrap();
659 assert_eq!(added_monitors.len(), $count);
660 added_monitors.clear();
665 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, &'c test_utils::TestFeeEstimator, &'b test_utils::TestRouter<'c>, &'c test_utils::TestLogger> {
666 let mut monitors_read = Vec::with_capacity(monitors_encoded.len());
667 for encoded in monitors_encoded {
668 let mut monitor_read = &encoded[..];
669 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingSigner>)>
670 ::read(&mut monitor_read, node.keys_manager).unwrap();
671 assert!(monitor_read.is_empty());
672 monitors_read.push(monitor);
675 let mut node_read = &chanman_encoded[..];
676 let (_, node_deserialized) = {
677 let mut channel_monitors = HashMap::new();
678 for monitor in monitors_read.iter_mut() {
679 assert!(channel_monitors.insert(monitor.get_funding_txo().0, monitor).is_none());
681 <(BlockHash, ChannelManager<&test_utils::TestChainMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestRouter, &test_utils::TestLogger>)>::read(&mut node_read, ChannelManagerReadArgs {
683 keys_manager: node.keys_manager,
684 fee_estimator: node.fee_estimator,
686 chain_monitor: node.chain_monitor,
687 tx_broadcaster: node.tx_broadcaster,
692 assert!(node_read.is_empty());
694 for monitor in monitors_read.drain(..) {
695 assert_eq!(node.chain_monitor.watch_channel(monitor.get_funding_txo().0, monitor),
696 ChannelMonitorUpdateStatus::Completed);
697 check_added_monitors!(node, 1);
704 macro_rules! reload_node {
705 ($node: expr, $new_config: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
706 let chanman_encoded = $chanman_encoded;
708 $persister = test_utils::TestPersister::new();
709 $new_chain_monitor = test_utils::TestChainMonitor::new(Some($node.chain_source), $node.tx_broadcaster.clone(), $node.logger, $node.fee_estimator, &$persister, &$node.keys_manager);
710 $node.chain_monitor = &$new_chain_monitor;
712 $new_channelmanager = _reload_node(&$node, $new_config, &chanman_encoded, $monitors_encoded);
713 $node.node = &$new_channelmanager;
715 ($node: expr, $chanman_encoded: expr, $monitors_encoded: expr, $persister: ident, $new_chain_monitor: ident, $new_channelmanager: ident) => {
716 reload_node!($node, $crate::util::config::UserConfig::default(), $chanman_encoded, $monitors_encoded, $persister, $new_chain_monitor, $new_channelmanager);
720 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) {
721 let chan_id = *node.network_chan_count.borrow();
723 let events = node.node.get_and_clear_pending_events();
724 assert_eq!(events.len(), 1);
726 Event::FundingGenerationReady { ref temporary_channel_id, ref counterparty_node_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
727 assert_eq!(counterparty_node_id, expected_counterparty_node_id);
728 assert_eq!(*channel_value_satoshis, expected_chan_value);
729 assert_eq!(user_channel_id, expected_user_chan_id);
731 let tx = Transaction { version: chan_id as i32, lock_time: PackedLockTime::ZERO, input: Vec::new(), output: vec![TxOut {
732 value: *channel_value_satoshis, script_pubkey: output_script.clone(),
734 let funding_outpoint = OutPoint { txid: tx.txid(), index: 0 };
735 (*temporary_channel_id, tx, funding_outpoint)
737 _ => panic!("Unexpected event"),
740 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 {
741 let (temporary_channel_id, tx, funding_output) = create_funding_transaction(node_a, &node_b.node.get_our_node_id(), channel_value, 42);
742 assert_eq!(temporary_channel_id, expected_temporary_channel_id);
744 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_ok());
745 check_added_monitors!(node_a, 0);
747 let funding_created_msg = get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id());
748 assert_eq!(funding_created_msg.temporary_channel_id, expected_temporary_channel_id);
749 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &funding_created_msg);
751 let mut added_monitors = node_b.chain_monitor.added_monitors.lock().unwrap();
752 assert_eq!(added_monitors.len(), 1);
753 assert_eq!(added_monitors[0].0, funding_output);
754 added_monitors.clear();
757 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()));
759 let mut added_monitors = node_a.chain_monitor.added_monitors.lock().unwrap();
760 assert_eq!(added_monitors.len(), 1);
761 assert_eq!(added_monitors[0].0, funding_output);
762 added_monitors.clear();
765 let events_4 = node_a.node.get_and_clear_pending_events();
766 assert_eq!(events_4.len(), 0);
768 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
769 assert_eq!(node_a.tx_broadcaster.txn_broadcasted.lock().unwrap()[0], tx);
770 node_a.tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
772 // Ensure that funding_transaction_generated is idempotent.
773 assert!(node_a.node.funding_transaction_generated(&temporary_channel_id, &node_b.node.get_our_node_id(), tx.clone()).is_err());
774 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
775 check_added_monitors!(node_a, 0);
780 // Receiver must have been initialized with manually_accept_inbound_channels set to true.
781 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]) {
782 let initiator_channels = initiator.node.list_usable_channels().len();
783 let receiver_channels = receiver.node.list_usable_channels().len();
785 initiator.node.create_channel(receiver.node.get_our_node_id(), 100_000, 10_001, 42, initiator_config).unwrap();
786 let open_channel = get_event_msg!(initiator, MessageSendEvent::SendOpenChannel, receiver.node.get_our_node_id());
788 receiver.node.handle_open_channel(&initiator.node.get_our_node_id(), channelmanager::provided_init_features(), &open_channel);
789 let events = receiver.node.get_and_clear_pending_events();
790 assert_eq!(events.len(), 1);
792 Event::OpenChannelRequest { temporary_channel_id, .. } => {
793 receiver.node.accept_inbound_channel_from_trusted_peer_0conf(&temporary_channel_id, &initiator.node.get_our_node_id(), 0).unwrap();
795 _ => panic!("Unexpected event"),
798 let accept_channel = get_event_msg!(receiver, MessageSendEvent::SendAcceptChannel, initiator.node.get_our_node_id());
799 assert_eq!(accept_channel.minimum_depth, 0);
800 initiator.node.handle_accept_channel(&receiver.node.get_our_node_id(), channelmanager::provided_init_features(), &accept_channel);
802 let (temporary_channel_id, tx, _) = create_funding_transaction(&initiator, &receiver.node.get_our_node_id(), 100_000, 42);
803 initiator.node.funding_transaction_generated(&temporary_channel_id, &receiver.node.get_our_node_id(), tx.clone()).unwrap();
804 let funding_created = get_event_msg!(initiator, MessageSendEvent::SendFundingCreated, receiver.node.get_our_node_id());
806 receiver.node.handle_funding_created(&initiator.node.get_our_node_id(), &funding_created);
807 check_added_monitors!(receiver, 1);
808 let bs_signed_locked = receiver.node.get_and_clear_pending_msg_events();
809 assert_eq!(bs_signed_locked.len(), 2);
810 let as_channel_ready;
811 match &bs_signed_locked[0] {
812 MessageSendEvent::SendFundingSigned { node_id, msg } => {
813 assert_eq!(*node_id, initiator.node.get_our_node_id());
814 initiator.node.handle_funding_signed(&receiver.node.get_our_node_id(), &msg);
815 check_added_monitors!(initiator, 1);
817 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
818 assert_eq!(initiator.tx_broadcaster.txn_broadcasted.lock().unwrap().split_off(0)[0], tx);
820 as_channel_ready = get_event_msg!(initiator, MessageSendEvent::SendChannelReady, receiver.node.get_our_node_id());
822 _ => panic!("Unexpected event"),
824 match &bs_signed_locked[1] {
825 MessageSendEvent::SendChannelReady { node_id, msg } => {
826 assert_eq!(*node_id, initiator.node.get_our_node_id());
827 initiator.node.handle_channel_ready(&receiver.node.get_our_node_id(), &msg);
829 _ => panic!("Unexpected event"),
832 receiver.node.handle_channel_ready(&initiator.node.get_our_node_id(), &as_channel_ready);
834 let as_channel_update = get_event_msg!(initiator, MessageSendEvent::SendChannelUpdate, receiver.node.get_our_node_id());
835 let bs_channel_update = get_event_msg!(receiver, MessageSendEvent::SendChannelUpdate, initiator.node.get_our_node_id());
837 initiator.node.handle_channel_update(&receiver.node.get_our_node_id(), &bs_channel_update);
838 receiver.node.handle_channel_update(&initiator.node.get_our_node_id(), &as_channel_update);
840 assert_eq!(initiator.node.list_usable_channels().len(), initiator_channels + 1);
841 assert_eq!(receiver.node.list_usable_channels().len(), receiver_channels + 1);
843 expect_channel_ready_event(&initiator, &receiver.node.get_our_node_id());
844 expect_channel_ready_event(&receiver, &initiator.node.get_our_node_id());
846 (tx, as_channel_ready.channel_id)
849 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, a_flags: InitFeatures, b_flags: InitFeatures) -> Transaction {
850 let create_chan_id = node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
851 let open_channel_msg = get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id());
852 assert_eq!(open_channel_msg.temporary_channel_id, create_chan_id);
853 assert_eq!(node_a.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 42);
854 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), a_flags, &open_channel_msg);
855 let accept_channel_msg = get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id());
856 assert_eq!(accept_channel_msg.temporary_channel_id, create_chan_id);
857 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), b_flags, &accept_channel_msg);
858 assert_ne!(node_b.node.list_channels().iter().find(|channel| channel.channel_id == create_chan_id).unwrap().user_channel_id, 0);
860 sign_funding_transaction(node_a, node_b, channel_value, create_chan_id)
863 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) {
864 confirm_transaction_at(node_conf, tx, conf_height);
865 connect_blocks(node_conf, CHAN_CONFIRM_DEPTH - 1);
866 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()));
869 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]) {
871 let events_6 = node_conf.node.get_and_clear_pending_msg_events();
872 assert_eq!(events_6.len(), 3);
873 let announcement_sigs_idx = if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[1] {
874 assert_eq!(*node_id, node_recv.node.get_our_node_id());
876 } else if let MessageSendEvent::SendChannelUpdate { ref node_id, msg: _ } = events_6[2] {
877 assert_eq!(*node_id, node_recv.node.get_our_node_id());
879 } else { panic!("Unexpected event: {:?}", events_6[1]); };
880 ((match events_6[0] {
881 MessageSendEvent::SendChannelReady { ref node_id, ref msg } => {
882 channel_id = msg.channel_id.clone();
883 assert_eq!(*node_id, node_recv.node.get_our_node_id());
886 _ => panic!("Unexpected event"),
887 }, match events_6[announcement_sigs_idx] {
888 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
889 assert_eq!(*node_id, node_recv.node.get_our_node_id());
892 _ => panic!("Unexpected event"),
896 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]) {
897 let conf_height = core::cmp::max(node_a.best_block_info().1 + 1, node_b.best_block_info().1 + 1);
898 create_chan_between_nodes_with_value_confirm_first(node_a, node_b, tx, conf_height);
899 confirm_transaction_at(node_a, tx, conf_height);
900 connect_blocks(node_a, CHAN_CONFIRM_DEPTH - 1);
901 expect_channel_ready_event(&node_a, &node_b.node.get_our_node_id());
902 create_chan_between_nodes_with_value_confirm_second(node_b, node_a)
905 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, a_flags: InitFeatures, b_flags: InitFeatures) -> ((msgs::ChannelReady, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
906 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat, a_flags, b_flags);
907 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
911 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) {
912 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &as_funding_msgs.0);
913 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
914 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1);
916 let events_7 = node_b.node.get_and_clear_pending_msg_events();
917 assert_eq!(events_7.len(), 1);
918 let (announcement, bs_update) = match events_7[0] {
919 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
922 _ => panic!("Unexpected event"),
925 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs);
926 let events_8 = node_a.node.get_and_clear_pending_msg_events();
927 assert_eq!(events_8.len(), 1);
928 let as_update = match events_8[0] {
929 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
930 assert!(*announcement == *msg);
931 assert_eq!(update_msg.contents.short_channel_id, announcement.contents.short_channel_id);
932 assert_eq!(update_msg.contents.short_channel_id, bs_update.contents.short_channel_id);
935 _ => panic!("Unexpected event"),
938 *node_a.network_chan_count.borrow_mut() += 1;
940 expect_channel_ready_event(&node_b, &node_a.node.get_our_node_id());
941 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
944 pub fn create_announced_chan_between_nodes<'a, 'b, 'c, 'd>(nodes: &'a Vec<Node<'b, 'c, 'd>>, a: usize, b: usize, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
945 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001, a_flags, b_flags)
948 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, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
949 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat, a_flags, b_flags);
950 update_nodes_with_chan_announce(nodes, a, b, &chan_announcement.0, &chan_announcement.1, &chan_announcement.2);
951 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
954 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, a_flags: InitFeatures, b_flags: InitFeatures) -> (msgs::ChannelReady, Transaction) {
955 let mut no_announce_cfg = test_default_channel_config();
956 no_announce_cfg.channel_handshake_config.announced_channel = false;
957 nodes[a].node.create_channel(nodes[b].node.get_our_node_id(), channel_value, push_msat, 42, Some(no_announce_cfg)).unwrap();
958 let open_channel = get_event_msg!(nodes[a], MessageSendEvent::SendOpenChannel, nodes[b].node.get_our_node_id());
959 nodes[b].node.handle_open_channel(&nodes[a].node.get_our_node_id(), a_flags, &open_channel);
960 let accept_channel = get_event_msg!(nodes[b], MessageSendEvent::SendAcceptChannel, nodes[a].node.get_our_node_id());
961 nodes[a].node.handle_accept_channel(&nodes[b].node.get_our_node_id(), b_flags, &accept_channel);
963 let (temporary_channel_id, tx, _) = create_funding_transaction(&nodes[a], &nodes[b].node.get_our_node_id(), channel_value, 42);
964 nodes[a].node.funding_transaction_generated(&temporary_channel_id, &nodes[b].node.get_our_node_id(), tx.clone()).unwrap();
965 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()));
966 check_added_monitors!(nodes[b], 1);
968 let cs_funding_signed = get_event_msg!(nodes[b], MessageSendEvent::SendFundingSigned, nodes[a].node.get_our_node_id());
969 nodes[a].node.handle_funding_signed(&nodes[b].node.get_our_node_id(), &cs_funding_signed);
970 check_added_monitors!(nodes[a], 1);
972 let conf_height = core::cmp::max(nodes[a].best_block_info().1 + 1, nodes[b].best_block_info().1 + 1);
973 confirm_transaction_at(&nodes[a], &tx, conf_height);
974 connect_blocks(&nodes[a], CHAN_CONFIRM_DEPTH - 1);
975 confirm_transaction_at(&nodes[b], &tx, conf_height);
976 connect_blocks(&nodes[b], CHAN_CONFIRM_DEPTH - 1);
977 let as_channel_ready = get_event_msg!(nodes[a], MessageSendEvent::SendChannelReady, nodes[b].node.get_our_node_id());
978 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()));
979 expect_channel_ready_event(&nodes[a], &nodes[b].node.get_our_node_id());
980 let as_update = get_event_msg!(nodes[a], MessageSendEvent::SendChannelUpdate, nodes[b].node.get_our_node_id());
981 nodes[b].node.handle_channel_ready(&nodes[a].node.get_our_node_id(), &as_channel_ready);
982 expect_channel_ready_event(&nodes[b], &nodes[a].node.get_our_node_id());
983 let bs_update = get_event_msg!(nodes[b], MessageSendEvent::SendChannelUpdate, nodes[a].node.get_our_node_id());
985 nodes[a].node.handle_channel_update(&nodes[b].node.get_our_node_id(), &bs_update);
986 nodes[b].node.handle_channel_update(&nodes[a].node.get_our_node_id(), &as_update);
988 let mut found_a = false;
989 for chan in nodes[a].node.list_usable_channels() {
990 if chan.channel_id == as_channel_ready.channel_id {
993 assert!(!chan.is_public);
998 let mut found_b = false;
999 for chan in nodes[b].node.list_usable_channels() {
1000 if chan.channel_id == as_channel_ready.channel_id {
1003 assert!(!chan.is_public);
1008 (as_channel_ready, tx)
1011 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) {
1013 assert!(node.gossip_sync.handle_channel_announcement(ann).unwrap());
1014 node.gossip_sync.handle_channel_update(upd_1).unwrap();
1015 node.gossip_sync.handle_channel_update(upd_2).unwrap();
1017 // Note that channel_updates are also delivered to ChannelManagers to ensure we have
1018 // forwarding info for local channels even if its not accepted in the network graph.
1019 node.node.handle_channel_update(&nodes[a].node.get_our_node_id(), &upd_1);
1020 node.node.handle_channel_update(&nodes[b].node.get_our_node_id(), &upd_2);
1025 macro_rules! check_spends {
1026 ($tx: expr, $($spends_txn: expr),*) => {
1029 for outp in $spends_txn.output.iter() {
1030 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Input tx output didn't meet dust limit");
1033 for outp in $tx.output.iter() {
1034 assert!(outp.value >= outp.script_pubkey.dust_value().to_sat(), "Spending tx output didn't meet dust limit");
1036 let get_output = |out_point: &bitcoin::blockdata::transaction::OutPoint| {
1038 if out_point.txid == $spends_txn.txid() {
1039 return $spends_txn.output.get(out_point.vout as usize).cloned()
1044 let mut total_value_in = 0;
1045 for input in $tx.input.iter() {
1046 total_value_in += get_output(&input.previous_output).unwrap().value;
1048 let mut total_value_out = 0;
1049 for output in $tx.output.iter() {
1050 total_value_out += output.value;
1052 let min_fee = ($tx.weight() as u64 + 3) / 4; // One sat per vbyte (ie per weight/4, rounded up)
1053 // Input amount - output amount = fee, so check that out + min_fee is smaller than input
1054 assert!(total_value_out + min_fee <= total_value_in);
1055 $tx.verify(get_output).unwrap();
1060 macro_rules! get_closing_signed_broadcast {
1061 ($node: expr, $dest_pubkey: expr) => {
1063 let events = $node.get_and_clear_pending_msg_events();
1064 assert!(events.len() == 1 || events.len() == 2);
1065 (match events[events.len() - 1] {
1066 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1067 assert_eq!(msg.contents.flags & 2, 2);
1070 _ => panic!("Unexpected event"),
1071 }, if events.len() == 2 {
1073 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1074 assert_eq!(*node_id, $dest_pubkey);
1077 _ => panic!("Unexpected event"),
1085 macro_rules! check_warn_msg {
1086 ($node: expr, $recipient_node_id: expr, $chan_id: expr) => {{
1087 let msg_events = $node.node.get_and_clear_pending_msg_events();
1088 assert_eq!(msg_events.len(), 1);
1089 match msg_events[0] {
1090 MessageSendEvent::HandleError { action: ErrorAction::SendWarningMessage { ref msg, log_level: _ }, node_id } => {
1091 assert_eq!(node_id, $recipient_node_id);
1092 assert_eq!(msg.channel_id, $chan_id);
1095 _ => panic!("Unexpected event"),
1100 /// Check that a channel's closing channel update has been broadcasted, and optionally
1101 /// check whether an error message event has occurred.
1103 macro_rules! check_closed_broadcast {
1104 ($node: expr, $with_error_msg: expr) => {{
1105 use $crate::util::events::MessageSendEvent;
1106 use $crate::ln::msgs::ErrorAction;
1108 let msg_events = $node.node.get_and_clear_pending_msg_events();
1109 assert_eq!(msg_events.len(), if $with_error_msg { 2 } else { 1 });
1110 match msg_events[0] {
1111 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
1112 assert_eq!(msg.contents.flags & 2, 2);
1114 _ => panic!("Unexpected event"),
1116 if $with_error_msg {
1117 match msg_events[1] {
1118 MessageSendEvent::HandleError { action: ErrorAction::SendErrorMessage { ref msg }, node_id: _ } => {
1119 // TODO: Check node_id
1122 _ => panic!("Unexpected event"),
1128 /// Check that a channel's closing channel events has been issued
1130 macro_rules! check_closed_event {
1131 ($node: expr, $events: expr, $reason: expr) => {
1132 check_closed_event!($node, $events, $reason, false);
1134 ($node: expr, $events: expr, $reason: expr, $is_check_discard_funding: expr) => {{
1135 use $crate::util::events::Event;
1137 let events = $node.node.get_and_clear_pending_events();
1138 assert_eq!(events.len(), $events, "{:?}", events);
1139 let expected_reason = $reason;
1140 let mut issues_discard_funding = false;
1141 for event in events {
1143 Event::ChannelClosed { ref reason, .. } => {
1144 assert_eq!(*reason, expected_reason);
1146 Event::DiscardFunding { .. } => {
1147 issues_discard_funding = true;
1149 _ => panic!("Unexpected event"),
1152 assert_eq!($is_check_discard_funding, issues_discard_funding);
1156 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) {
1157 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) };
1158 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) };
1161 node_a.close_channel(channel_id, &node_b.get_our_node_id()).unwrap();
1162 node_b.handle_shutdown(&node_a.get_our_node_id(), &channelmanager::provided_init_features(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id()));
1164 let events_1 = node_b.get_and_clear_pending_msg_events();
1165 assert!(events_1.len() >= 1);
1166 let shutdown_b = match events_1[0] {
1167 MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
1168 assert_eq!(node_id, &node_a.get_our_node_id());
1171 _ => panic!("Unexpected event"),
1174 let closing_signed_b = if !close_inbound_first {
1175 assert_eq!(events_1.len(), 1);
1178 Some(match events_1[1] {
1179 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
1180 assert_eq!(node_id, &node_a.get_our_node_id());
1183 _ => panic!("Unexpected event"),
1187 node_a.handle_shutdown(&node_b.get_our_node_id(), &channelmanager::provided_init_features(), &shutdown_b);
1188 let (as_update, bs_update) = if close_inbound_first {
1189 assert!(node_a.get_and_clear_pending_msg_events().is_empty());
1190 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1192 node_b.handle_closing_signed(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id()));
1193 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1194 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1195 let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1197 node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap());
1198 let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1199 assert!(none_a.is_none());
1200 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1201 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1202 (as_update, bs_update)
1204 let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
1206 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a);
1207 node_a.handle_closing_signed(&node_b.get_our_node_id(), &get_event_msg!(struct_b, MessageSendEvent::SendClosingSigned, node_a.get_our_node_id()));
1209 assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
1210 tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
1211 let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
1213 node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap());
1214 let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
1215 assert!(none_b.is_none());
1216 assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
1217 tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
1218 (as_update, bs_update)
1220 assert_eq!(tx_a, tx_b);
1221 check_spends!(tx_a, funding_tx);
1223 (as_update, bs_update, tx_a)
1226 pub struct SendEvent {
1227 pub node_id: PublicKey,
1228 pub msgs: Vec<msgs::UpdateAddHTLC>,
1229 pub commitment_msg: msgs::CommitmentSigned,
1232 pub fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
1233 assert!(updates.update_fulfill_htlcs.is_empty());
1234 assert!(updates.update_fail_htlcs.is_empty());
1235 assert!(updates.update_fail_malformed_htlcs.is_empty());
1236 assert!(updates.update_fee.is_none());
1237 SendEvent { node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
1240 pub fn from_event(event: MessageSendEvent) -> SendEvent {
1242 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
1243 _ => panic!("Unexpected event type!"),
1247 pub fn from_node<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>) -> SendEvent {
1248 let mut events = node.node.get_and_clear_pending_msg_events();
1249 assert_eq!(events.len(), 1);
1250 SendEvent::from_event(events.pop().unwrap())
1255 /// Performs the "commitment signed dance" - the series of message exchanges which occur after a
1256 /// commitment update.
1257 macro_rules! commitment_signed_dance {
1258 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
1260 check_added_monitors!($node_a, 0);
1261 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1262 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1263 check_added_monitors!($node_a, 1);
1264 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
1267 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
1269 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
1270 check_added_monitors!($node_b, 0);
1271 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1272 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack);
1273 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
1274 check_added_monitors!($node_b, 1);
1275 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed);
1276 let (bs_revoke_and_ack, extra_msg_option) = {
1277 let events = $node_b.node.get_and_clear_pending_msg_events();
1278 assert!(events.len() <= 2);
1280 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
1281 assert_eq!(*node_id, $node_a.node.get_our_node_id());
1284 _ => panic!("Unexpected event"),
1285 }, events.get(1).map(|e| e.clone()))
1287 check_added_monitors!($node_b, 1);
1288 if $fail_backwards {
1289 assert!($node_a.node.get_and_clear_pending_events().is_empty());
1290 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1292 (extra_msg_option, bs_revoke_and_ack)
1295 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
1297 check_added_monitors!($node_a, 0);
1298 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1299 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed);
1300 check_added_monitors!($node_a, 1);
1301 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1302 assert!(extra_msg_option.is_none());
1306 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
1308 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
1309 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack);
1310 check_added_monitors!($node_a, 1);
1314 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
1316 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
1319 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
1321 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
1322 if $fail_backwards {
1323 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 }]);
1324 check_added_monitors!($node_a, 1);
1326 let channel_state = $node_a.node.channel_state.lock().unwrap();
1327 assert_eq!(channel_state.pending_msg_events.len(), 1);
1328 if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
1329 assert_ne!(*node_id, $node_b.node.get_our_node_id());
1330 } else { panic!("Unexpected event"); }
1332 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
1338 /// Get a payment preimage and hash.
1340 macro_rules! get_payment_preimage_hash {
1341 ($dest_node: expr) => {
1343 get_payment_preimage_hash!($dest_node, None)
1346 ($dest_node: expr, $min_value_msat: expr) => {
1348 use bitcoin::hashes::Hash as _;
1349 let mut payment_count = $dest_node.network_payment_count.borrow_mut();
1350 let payment_preimage = $crate::ln::PaymentPreimage([*payment_count; 32]);
1351 *payment_count += 1;
1352 let payment_hash = $crate::ln::PaymentHash(
1353 bitcoin::hashes::sha256::Hash::hash(&payment_preimage.0[..]).into_inner());
1354 let payment_secret = $dest_node.node.create_inbound_payment_for_hash(payment_hash, $min_value_msat, 7200).unwrap();
1355 (payment_preimage, payment_hash, payment_secret)
1361 macro_rules! get_route {
1362 ($send_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1363 use $crate::chain::keysinterface::EntropySource;
1364 let scorer = $crate::util::test_utils::TestScorer::with_penalty(0);
1365 let keys_manager = $crate::util::test_utils::TestKeysInterface::new(&[0u8; 32], bitcoin::network::constants::Network::Testnet);
1366 let random_seed_bytes = keys_manager.get_secure_random_bytes();
1367 $crate::routing::router::get_route(
1368 &$send_node.node.get_our_node_id(), &$payment_params, &$send_node.network_graph.read_only(),
1369 Some(&$send_node.node.list_usable_channels().iter().collect::<Vec<_>>()),
1370 $recv_value, $cltv, $send_node.logger, &scorer, &random_seed_bytes
1377 macro_rules! get_route_and_payment_hash {
1378 ($send_node: expr, $recv_node: expr, $recv_value: expr) => {{
1379 let payment_params = $crate::routing::router::PaymentParameters::from_node_id($recv_node.node.get_our_node_id())
1380 .with_features($crate::ln::channelmanager::provided_invoice_features());
1381 $crate::get_route_and_payment_hash!($send_node, $recv_node, payment_params, $recv_value, TEST_FINAL_CLTV)
1383 ($send_node: expr, $recv_node: expr, $payment_params: expr, $recv_value: expr, $cltv: expr) => {{
1384 let (payment_preimage, payment_hash, payment_secret) = $crate::get_payment_preimage_hash!($recv_node, Some($recv_value));
1385 let route = $crate::get_route!($send_node, $payment_params, $recv_value, $cltv);
1386 (route.unwrap(), payment_hash, payment_preimage, payment_secret)
1391 macro_rules! expect_pending_htlcs_forwardable_conditions {
1392 ($node: expr, $expected_failures: expr) => {{
1393 let expected_failures = $expected_failures;
1394 let events = $node.node.get_and_clear_pending_events();
1396 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1397 _ => panic!("Unexpected event {:?}", events),
1400 let count = expected_failures.len() + 1;
1401 assert_eq!(events.len(), count);
1403 if expected_failures.len() > 0 {
1404 expect_htlc_handling_failed_destinations!(events, expected_failures)
1410 macro_rules! expect_htlc_handling_failed_destinations {
1411 ($events: expr, $expected_failures: expr) => {{
1412 for event in $events {
1414 $crate::util::events::Event::PendingHTLCsForwardable { .. } => { },
1415 $crate::util::events::Event::HTLCHandlingFailed { ref failed_next_destination, .. } => {
1416 assert!($expected_failures.contains(&failed_next_destination))
1418 _ => panic!("Unexpected destination"),
1425 /// Clears (and ignores) a PendingHTLCsForwardable event
1426 macro_rules! expect_pending_htlcs_forwardable_ignore {
1428 expect_pending_htlcs_forwardable_conditions!($node, vec![]);
1433 /// Clears (and ignores) PendingHTLCsForwardable and HTLCHandlingFailed events
1434 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore {
1435 ($node: expr, $expected_failures: expr) => {{
1436 expect_pending_htlcs_forwardable_conditions!($node, $expected_failures);
1441 /// Handles a PendingHTLCsForwardable event
1442 macro_rules! expect_pending_htlcs_forwardable {
1444 expect_pending_htlcs_forwardable_ignore!($node);
1445 $node.node.process_pending_htlc_forwards();
1447 // Ensure process_pending_htlc_forwards is idempotent.
1448 $node.node.process_pending_htlc_forwards();
1453 /// Handles a PendingHTLCsForwardable and HTLCHandlingFailed event
1454 macro_rules! expect_pending_htlcs_forwardable_and_htlc_handling_failed {
1455 ($node: expr, $expected_failures: expr) => {{
1456 expect_pending_htlcs_forwardable_and_htlc_handling_failed_ignore!($node, $expected_failures);
1457 $node.node.process_pending_htlc_forwards();
1459 // Ensure process_pending_htlc_forwards is idempotent.
1460 $node.node.process_pending_htlc_forwards();
1465 macro_rules! expect_pending_htlcs_forwardable_from_events {
1466 ($node: expr, $events: expr, $ignore: expr) => {{
1467 assert_eq!($events.len(), 1);
1469 Event::PendingHTLCsForwardable { .. } => { },
1470 _ => panic!("Unexpected event"),
1473 $node.node.process_pending_htlc_forwards();
1475 // Ensure process_pending_htlc_forwards is idempotent.
1476 $node.node.process_pending_htlc_forwards();
1481 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1482 macro_rules! expect_payment_claimable {
1483 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr) => {
1484 expect_payment_claimable!($node, $expected_payment_hash, $expected_payment_secret, $expected_recv_value, None, $node.node.get_our_node_id())
1486 ($node: expr, $expected_payment_hash: expr, $expected_payment_secret: expr, $expected_recv_value: expr, $expected_payment_preimage: expr, $expected_receiver_node_id: expr) => {
1487 let events = $node.node.get_and_clear_pending_events();
1488 assert_eq!(events.len(), 1);
1490 $crate::util::events::Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, via_channel_id: _, via_user_channel_id: _ } => {
1491 assert_eq!($expected_payment_hash, *payment_hash);
1492 assert_eq!($expected_recv_value, amount_msat);
1493 assert_eq!($expected_receiver_node_id, receiver_node_id.unwrap());
1495 $crate::util::events::PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1496 assert_eq!(&$expected_payment_preimage, payment_preimage);
1497 assert_eq!($expected_payment_secret, *payment_secret);
1502 _ => panic!("Unexpected event"),
1508 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1509 macro_rules! expect_payment_claimed {
1510 ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
1511 let events = $node.node.get_and_clear_pending_events();
1512 assert_eq!(events.len(), 1);
1514 $crate::util::events::Event::PaymentClaimed { ref payment_hash, amount_msat, .. } => {
1515 assert_eq!($expected_payment_hash, *payment_hash);
1516 assert_eq!($expected_recv_value, amount_msat);
1518 _ => panic!("Unexpected event"),
1525 macro_rules! expect_payment_sent_without_paths {
1526 ($node: expr, $expected_payment_preimage: expr) => {
1527 expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, false);
1529 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1530 expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, false);
1535 macro_rules! expect_payment_sent {
1536 ($node: expr, $expected_payment_preimage: expr) => {
1537 $crate::expect_payment_sent!($node, $expected_payment_preimage, None::<u64>, true);
1539 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr) => {
1540 $crate::expect_payment_sent!($node, $expected_payment_preimage, $expected_fee_msat_opt, true);
1542 ($node: expr, $expected_payment_preimage: expr, $expected_fee_msat_opt: expr, $expect_paths: expr) => { {
1543 use bitcoin::hashes::Hash as _;
1544 let events = $node.node.get_and_clear_pending_events();
1545 let expected_payment_hash = $crate::ln::PaymentHash(
1546 bitcoin::hashes::sha256::Hash::hash(&$expected_payment_preimage.0).into_inner());
1548 assert!(events.len() > 1);
1550 assert_eq!(events.len(), 1);
1552 let expected_payment_id = match events[0] {
1553 $crate::util::events::Event::PaymentSent { ref payment_id, ref payment_preimage, ref payment_hash, ref fee_paid_msat } => {
1554 assert_eq!($expected_payment_preimage, *payment_preimage);
1555 assert_eq!(expected_payment_hash, *payment_hash);
1556 assert!(fee_paid_msat.is_some());
1557 if $expected_fee_msat_opt.is_some() {
1558 assert_eq!(*fee_paid_msat, $expected_fee_msat_opt);
1562 _ => panic!("Unexpected event"),
1565 for i in 1..events.len() {
1567 $crate::util::events::Event::PaymentPathSuccessful { payment_id, payment_hash, .. } => {
1568 assert_eq!(payment_id, expected_payment_id);
1569 assert_eq!(payment_hash, Some(expected_payment_hash));
1571 _ => panic!("Unexpected event"),
1580 macro_rules! expect_payment_path_successful {
1582 let events = $node.node.get_and_clear_pending_events();
1583 assert_eq!(events.len(), 1);
1585 $crate::util::events::Event::PaymentPathSuccessful { .. } => {},
1586 _ => panic!("Unexpected event"),
1591 macro_rules! expect_payment_forwarded {
1592 ($node: expr, $prev_node: expr, $next_node: expr, $expected_fee: expr, $upstream_force_closed: expr, $downstream_force_closed: expr) => {
1593 let events = $node.node.get_and_clear_pending_events();
1594 assert_eq!(events.len(), 1);
1596 Event::PaymentForwarded { fee_earned_msat, prev_channel_id, claim_from_onchain_tx, next_channel_id } => {
1597 assert_eq!(fee_earned_msat, $expected_fee);
1598 if fee_earned_msat.is_some() {
1599 // Is the event prev_channel_id in one of the channels between the two nodes?
1600 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()));
1602 // We check for force closures since a force closed channel is removed from the
1603 // node's channel list
1604 if !$downstream_force_closed {
1605 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()));
1607 assert_eq!(claim_from_onchain_tx, $downstream_force_closed);
1609 _ => panic!("Unexpected event"),
1614 #[cfg(any(test, feature = "_bench_unstable", feature = "_test_utils"))]
1615 pub fn expect_channel_ready_event<'a, 'b, 'c, 'd>(node: &'a Node<'b, 'c, 'd>, expected_counterparty_node_id: &PublicKey) {
1616 let events = node.node.get_and_clear_pending_events();
1617 assert_eq!(events.len(), 1);
1619 crate::util::events::Event::ChannelReady{ ref counterparty_node_id, .. } => {
1620 assert_eq!(*expected_counterparty_node_id, *counterparty_node_id);
1622 _ => panic!("Unexpected event"),
1627 pub struct PaymentFailedConditions<'a> {
1628 pub(crate) expected_htlc_error_data: Option<(u16, &'a [u8])>,
1629 pub(crate) expected_blamed_scid: Option<u64>,
1630 pub(crate) expected_blamed_chan_closed: Option<bool>,
1631 pub(crate) expected_mpp_parts_remain: bool,
1634 impl<'a> PaymentFailedConditions<'a> {
1635 pub fn new() -> Self {
1637 expected_htlc_error_data: None,
1638 expected_blamed_scid: None,
1639 expected_blamed_chan_closed: None,
1640 expected_mpp_parts_remain: false,
1643 pub fn mpp_parts_remain(mut self) -> Self {
1644 self.expected_mpp_parts_remain = true;
1647 pub fn blamed_scid(mut self, scid: u64) -> Self {
1648 self.expected_blamed_scid = Some(scid);
1651 pub fn blamed_chan_closed(mut self, closed: bool) -> Self {
1652 self.expected_blamed_chan_closed = Some(closed);
1655 pub fn expected_htlc_error_data(mut self, code: u16, data: &'a [u8]) -> Self {
1656 self.expected_htlc_error_data = Some((code, data));
1662 macro_rules! expect_payment_failed_with_update {
1663 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr, $scid: expr, $chan_closed: expr) => {
1664 $crate::ln::functional_test_utils::expect_payment_failed_conditions(
1665 &$node, $expected_payment_hash, $payment_failed_permanently,
1666 $crate::ln::functional_test_utils::PaymentFailedConditions::new()
1667 .blamed_scid($scid).blamed_chan_closed($chan_closed));
1672 macro_rules! expect_payment_failed {
1673 ($node: expr, $expected_payment_hash: expr, $payment_failed_permanently: expr $(, $expected_error_code: expr, $expected_error_data: expr)*) => {
1674 #[allow(unused_mut)]
1675 let mut conditions = $crate::ln::functional_test_utils::PaymentFailedConditions::new();
1677 conditions = conditions.expected_htlc_error_data($expected_error_code, &$expected_error_data);
1679 $crate::ln::functional_test_utils::expect_payment_failed_conditions(&$node, $expected_payment_hash, $payment_failed_permanently, conditions);
1683 pub fn expect_payment_failed_conditions_event<'a, 'b, 'c, 'd, 'e>(
1684 node: &'a Node<'b, 'c, 'd>, payment_failed_event: Event, expected_payment_hash: PaymentHash,
1685 expected_payment_failed_permanently: bool, conditions: PaymentFailedConditions<'e>
1687 let expected_payment_id = match payment_failed_event {
1688 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, path, retry, payment_id, network_update, short_channel_id,
1692 error_data, .. } => {
1693 assert_eq!(payment_hash, expected_payment_hash, "unexpected payment_hash");
1694 assert_eq!(payment_failed_permanently, expected_payment_failed_permanently, "unexpected payment_failed_permanently value");
1695 assert!(retry.is_some(), "expected retry.is_some()");
1696 assert_eq!(retry.as_ref().unwrap().final_value_msat, path.last().unwrap().fee_msat, "Retry amount should match last hop in path");
1697 assert_eq!(retry.as_ref().unwrap().payment_params.payee_pubkey, path.last().unwrap().pubkey, "Retry payee node_id should match last hop in path");
1698 if let Some(scid) = short_channel_id {
1699 assert!(retry.as_ref().unwrap().payment_params.previously_failed_channels.contains(&scid));
1704 assert!(error_code.is_some(), "expected error_code.is_some() = true");
1705 assert!(error_data.is_some(), "expected error_data.is_some() = true");
1706 if let Some((code, data)) = conditions.expected_htlc_error_data {
1707 assert_eq!(error_code.unwrap(), code, "unexpected error code");
1708 assert_eq!(&error_data.as_ref().unwrap()[..], data, "unexpected error data");
1712 if let Some(chan_closed) = conditions.expected_blamed_chan_closed {
1713 match network_update {
1714 Some(NetworkUpdate::ChannelUpdateMessage { ref msg }) if !chan_closed => {
1715 if let Some(scid) = conditions.expected_blamed_scid {
1716 assert_eq!(msg.contents.short_channel_id, scid);
1718 const CHAN_DISABLED_FLAG: u8 = 2;
1719 assert_eq!(msg.contents.flags & CHAN_DISABLED_FLAG, 0);
1721 Some(NetworkUpdate::ChannelFailure { short_channel_id, is_permanent }) if chan_closed => {
1722 if let Some(scid) = conditions.expected_blamed_scid {
1723 assert_eq!(short_channel_id, scid);
1725 assert!(is_permanent);
1727 Some(_) => panic!("Unexpected update type"),
1728 None => panic!("Expected update"),
1734 _ => panic!("Unexpected event"),
1736 if !conditions.expected_mpp_parts_remain {
1737 node.node.abandon_payment(expected_payment_id);
1738 let events = node.node.get_and_clear_pending_events();
1739 assert_eq!(events.len(), 1);
1741 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
1742 assert_eq!(*payment_hash, expected_payment_hash, "unexpected second payment_hash");
1743 assert_eq!(*payment_id, expected_payment_id);
1745 _ => panic!("Unexpected second event"),
1750 pub fn expect_payment_failed_conditions<'a, 'b, 'c, 'd, 'e>(
1751 node: &'a Node<'b, 'c, 'd>, expected_payment_hash: PaymentHash, expected_payment_failed_permanently: bool,
1752 conditions: PaymentFailedConditions<'e>
1754 let mut events = node.node.get_and_clear_pending_events();
1755 assert_eq!(events.len(), 1);
1756 expect_payment_failed_conditions_event(node, events.pop().unwrap(), expected_payment_hash, expected_payment_failed_permanently, conditions);
1759 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 {
1760 let payment_id = PaymentId(origin_node.keys_manager.backing.get_secure_random_bytes());
1761 origin_node.node.send_payment(&route, our_payment_hash, &Some(our_payment_secret), payment_id).unwrap();
1762 check_added_monitors!(origin_node, expected_paths.len());
1763 pass_along_route(origin_node, expected_paths, recv_value, our_payment_hash, our_payment_secret);
1767 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>) {
1768 let mut payment_event = SendEvent::from_event(ev);
1769 let mut prev_node = origin_node;
1771 for (idx, &node) in expected_path.iter().enumerate() {
1772 assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
1774 node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]);
1775 check_added_monitors!(node, 0);
1776 commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
1778 expect_pending_htlcs_forwardable!(node);
1780 if idx == expected_path.len() - 1 && clear_recipient_events {
1781 let events_2 = node.node.get_and_clear_pending_events();
1782 if payment_claimable_expected {
1783 assert_eq!(events_2.len(), 1);
1785 Event::PaymentClaimable { ref payment_hash, ref purpose, amount_msat, receiver_node_id, ref via_channel_id, ref via_user_channel_id } => {
1786 assert_eq!(our_payment_hash, *payment_hash);
1787 assert_eq!(node.node.get_our_node_id(), receiver_node_id.unwrap());
1789 PaymentPurpose::InvoicePayment { payment_preimage, payment_secret, .. } => {
1790 assert_eq!(expected_preimage, *payment_preimage);
1791 assert_eq!(our_payment_secret.unwrap(), *payment_secret);
1793 PaymentPurpose::SpontaneousPayment(payment_preimage) => {
1794 assert_eq!(expected_preimage.unwrap(), *payment_preimage);
1795 assert!(our_payment_secret.is_none());
1798 assert_eq!(amount_msat, recv_value);
1799 assert!(node.node.list_channels().iter().any(|details| details.channel_id == via_channel_id.unwrap()));
1800 assert!(node.node.list_channels().iter().any(|details| details.user_channel_id == via_user_channel_id.unwrap()));
1802 _ => panic!("Unexpected event"),
1805 assert!(events_2.is_empty());
1807 } else if idx != expected_path.len() - 1 {
1808 let mut events_2 = node.node.get_and_clear_pending_msg_events();
1809 assert_eq!(events_2.len(), 1);
1810 check_added_monitors!(node, 1);
1811 payment_event = SendEvent::from_event(events_2.remove(0));
1812 assert_eq!(payment_event.msgs.len(), 1);
1819 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>) {
1820 do_pass_along_path(origin_node, expected_path, recv_value, our_payment_hash, our_payment_secret, ev, payment_claimable_expected, true, expected_preimage);
1823 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) {
1824 let mut events = origin_node.node.get_and_clear_pending_msg_events();
1825 assert_eq!(events.len(), expected_route.len());
1826 for (path_idx, (ev, expected_path)) in events.drain(..).zip(expected_route.iter()).enumerate() {
1827 // Once we've gotten through all the HTLCs, the last one should result in a
1828 // PaymentClaimable (but each previous one should not!), .
1829 let expect_payment = path_idx == expected_route.len() - 1;
1830 pass_along_path(origin_node, expected_path, recv_value, our_payment_hash.clone(), Some(our_payment_secret), ev, expect_payment, None);
1834 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) {
1835 let (our_payment_preimage, our_payment_hash, our_payment_secret) = get_payment_preimage_hash!(expected_route.last().unwrap());
1836 let payment_id = send_along_route_with_secret(origin_node, route, &[expected_route], recv_value, our_payment_hash, our_payment_secret);
1837 (our_payment_preimage, our_payment_hash, our_payment_secret, payment_id)
1840 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 {
1841 for path in expected_paths.iter() {
1842 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
1844 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1846 let claim_event = expected_paths[0].last().unwrap().node.get_and_clear_pending_events();
1847 assert_eq!(claim_event.len(), 1);
1848 match claim_event[0] {
1849 Event::PaymentClaimed { purpose: PaymentPurpose::SpontaneousPayment(preimage), .. }|
1850 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { payment_preimage: Some(preimage), ..}, .. } =>
1851 assert_eq!(preimage, our_payment_preimage),
1852 Event::PaymentClaimed { purpose: PaymentPurpose::InvoicePayment { .. }, payment_hash, .. } =>
1853 assert_eq!(&payment_hash.0, &Sha256::hash(&our_payment_preimage.0)[..]),
1857 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
1859 let mut expected_total_fee_msat = 0;
1861 macro_rules! msgs_from_ev {
1864 &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 } } => {
1865 assert!(update_add_htlcs.is_empty());
1866 assert_eq!(update_fulfill_htlcs.len(), 1);
1867 assert!(update_fail_htlcs.is_empty());
1868 assert!(update_fail_malformed_htlcs.is_empty());
1869 assert!(update_fee.is_none());
1870 ((update_fulfill_htlcs[0].clone(), commitment_signed.clone()), node_id.clone())
1872 _ => panic!("Unexpected event"),
1876 let mut per_path_msgs: Vec<((msgs::UpdateFulfillHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
1877 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
1878 assert_eq!(events.len(), expected_paths.len());
1879 for ev in events.iter() {
1880 per_path_msgs.push(msgs_from_ev!(ev));
1883 for (expected_route, (path_msgs, next_hop)) in expected_paths.iter().zip(per_path_msgs.drain(..)) {
1884 let mut next_msgs = Some(path_msgs);
1885 let mut expected_next_node = next_hop;
1887 macro_rules! last_update_fulfill_dance {
1888 ($node: expr, $prev_node: expr) => {
1890 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1891 check_added_monitors!($node, 0);
1892 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1893 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1897 macro_rules! mid_update_fulfill_dance {
1898 ($node: expr, $prev_node: expr, $next_node: expr, $new_msgs: expr) => {
1900 $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
1902 let per_peer_state = $node.node.per_peer_state.read().unwrap();
1903 let peer_state = per_peer_state.get(&$prev_node.node.get_our_node_id())
1904 .unwrap().lock().unwrap();
1905 let channel = peer_state.channel_by_id.get(&next_msgs.as_ref().unwrap().0.channel_id).unwrap();
1906 if let Some(prev_config) = channel.prev_config() {
1907 prev_config.forwarding_fee_base_msat
1909 channel.config().forwarding_fee_base_msat
1912 expect_payment_forwarded!($node, $next_node, $prev_node, Some(fee as u64), false, false);
1913 expected_total_fee_msat += fee as u64;
1914 check_added_monitors!($node, 1);
1915 let new_next_msgs = if $new_msgs {
1916 let events = $node.node.get_and_clear_pending_msg_events();
1917 assert_eq!(events.len(), 1);
1918 let (res, nexthop) = msgs_from_ev!(&events[0]);
1919 expected_next_node = nexthop;
1922 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
1925 commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
1926 next_msgs = new_next_msgs;
1931 let mut prev_node = expected_route.last().unwrap();
1932 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
1933 assert_eq!(expected_next_node, node.node.get_our_node_id());
1934 let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
1935 if next_msgs.is_some() {
1936 // Since we are traversing in reverse, next_node is actually the previous node
1937 let next_node: &Node;
1938 if idx == expected_route.len() - 1 {
1939 next_node = origin_node;
1941 next_node = expected_route[expected_route.len() - 1 - idx - 1];
1943 mid_update_fulfill_dance!(node, prev_node, next_node, update_next_msgs);
1945 assert!(!update_next_msgs);
1946 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
1948 if !skip_last && idx == expected_route.len() - 1 {
1949 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
1956 last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
1960 // Ensure that claim_funds is idempotent.
1961 expected_paths[0].last().unwrap().node.claim_funds(our_payment_preimage);
1962 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
1963 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
1965 expected_total_fee_msat
1967 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) {
1968 let expected_total_fee_msat = do_claim_payment_along_route(origin_node, expected_paths, skip_last, our_payment_preimage);
1970 expect_payment_sent!(origin_node, our_payment_preimage, Some(expected_total_fee_msat));
1974 pub fn claim_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], our_payment_preimage: PaymentPreimage) {
1975 claim_payment_along_route(origin_node, &[expected_route], false, our_payment_preimage);
1978 pub const TEST_FINAL_CLTV: u32 = 70;
1980 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) {
1981 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1982 .with_features(channelmanager::provided_invoice_features());
1983 let route = get_route!(origin_node, payment_params, recv_value, TEST_FINAL_CLTV).unwrap();
1984 assert_eq!(route.paths.len(), 1);
1985 assert_eq!(route.paths[0].len(), expected_route.len());
1986 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
1987 assert_eq!(hop.pubkey, node.node.get_our_node_id());
1990 let res = send_along_route(origin_node, route, expected_route, recv_value);
1991 (res.0, res.1, res.2)
1994 pub fn route_over_limit<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
1995 let payment_params = PaymentParameters::from_node_id(expected_route.last().unwrap().node.get_our_node_id())
1996 .with_features(channelmanager::provided_invoice_features());
1997 let network_graph = origin_node.network_graph.read_only();
1998 let scorer = test_utils::TestScorer::with_penalty(0);
1999 let seed = [0u8; 32];
2000 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2001 let random_seed_bytes = keys_manager.get_secure_random_bytes();
2002 let route = get_route(
2003 &origin_node.node.get_our_node_id(), &payment_params, &network_graph,
2004 None, recv_value, TEST_FINAL_CLTV, origin_node.logger, &scorer, &random_seed_bytes).unwrap();
2005 assert_eq!(route.paths.len(), 1);
2006 assert_eq!(route.paths[0].len(), expected_route.len());
2007 for (node, hop) in expected_route.iter().zip(route.paths[0].iter()) {
2008 assert_eq!(hop.pubkey, node.node.get_our_node_id());
2011 let (_, our_payment_hash, our_payment_preimage) = get_payment_preimage_hash!(expected_route.last().unwrap());
2012 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 },
2013 assert!(err.contains("Cannot send value that would put us over the max HTLC value in flight our peer will accept")));
2016 pub fn send_payment<'a, 'b, 'c>(origin: &Node<'a, 'b, 'c>, expected_route: &[&Node<'a, 'b, 'c>], recv_value: u64) {
2017 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2018 claim_payment(&origin, expected_route, our_payment_preimage);
2021 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) {
2022 for path in expected_paths.iter() {
2023 assert_eq!(path.last().unwrap().node.get_our_node_id(), expected_paths[0].last().unwrap().node.get_our_node_id());
2025 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2026 let expected_destinations: Vec<HTLCDestination> = repeat(HTLCDestination::FailedPayment { payment_hash: our_payment_hash }).take(expected_paths.len()).collect();
2027 expect_pending_htlcs_forwardable_and_htlc_handling_failed!(expected_paths[0].last().unwrap(), expected_destinations);
2029 pass_failed_payment_back(origin_node, expected_paths, skip_last, our_payment_hash);
2032 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) {
2033 let expected_payment_id = pass_failed_payment_back_no_abandon(origin_node, expected_paths_slice, skip_last, our_payment_hash);
2035 origin_node.node.abandon_payment(expected_payment_id.unwrap());
2036 let events = origin_node.node.get_and_clear_pending_events();
2037 assert_eq!(events.len(), 1);
2039 Event::PaymentFailed { ref payment_hash, ref payment_id } => {
2040 assert_eq!(*payment_hash, our_payment_hash, "unexpected second payment_hash");
2041 assert_eq!(*payment_id, expected_payment_id.unwrap());
2043 _ => panic!("Unexpected second event"),
2048 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> {
2049 let mut expected_paths: Vec<_> = expected_paths_slice.iter().collect();
2050 check_added_monitors!(expected_paths[0].last().unwrap(), expected_paths.len());
2052 let mut per_path_msgs: Vec<((msgs::UpdateFailHTLC, msgs::CommitmentSigned), PublicKey)> = Vec::with_capacity(expected_paths.len());
2053 let events = expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events();
2054 assert_eq!(events.len(), expected_paths.len());
2055 for ev in events.iter() {
2056 let (update_fail, commitment_signed, node_id) = match ev {
2057 &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 } } => {
2058 assert!(update_add_htlcs.is_empty());
2059 assert!(update_fulfill_htlcs.is_empty());
2060 assert_eq!(update_fail_htlcs.len(), 1);
2061 assert!(update_fail_malformed_htlcs.is_empty());
2062 assert!(update_fee.is_none());
2063 (update_fail_htlcs[0].clone(), commitment_signed.clone(), node_id.clone())
2065 _ => panic!("Unexpected event"),
2067 per_path_msgs.push(((update_fail, commitment_signed), node_id));
2069 per_path_msgs.sort_unstable_by(|(_, node_id_a), (_, node_id_b)| node_id_a.cmp(node_id_b));
2070 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()));
2072 let mut expected_payment_id = None;
2074 for (i, (expected_route, (path_msgs, next_hop))) in expected_paths.iter().zip(per_path_msgs.drain(..)).enumerate() {
2075 let mut next_msgs = Some(path_msgs);
2076 let mut expected_next_node = next_hop;
2077 let mut prev_node = expected_route.last().unwrap();
2079 for (idx, node) in expected_route.iter().rev().enumerate().skip(1) {
2080 assert_eq!(expected_next_node, node.node.get_our_node_id());
2081 let update_next_node = !skip_last || idx != expected_route.len() - 1;
2082 if next_msgs.is_some() {
2083 node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2084 commitment_signed_dance!(node, prev_node, next_msgs.as_ref().unwrap().1, update_next_node);
2085 if !update_next_node {
2086 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 }]);
2089 let events = node.node.get_and_clear_pending_msg_events();
2090 if update_next_node {
2091 assert_eq!(events.len(), 1);
2093 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 } } => {
2094 assert!(update_add_htlcs.is_empty());
2095 assert!(update_fulfill_htlcs.is_empty());
2096 assert_eq!(update_fail_htlcs.len(), 1);
2097 assert!(update_fail_malformed_htlcs.is_empty());
2098 assert!(update_fee.is_none());
2099 expected_next_node = node_id.clone();
2100 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2102 _ => panic!("Unexpected event"),
2105 assert!(events.is_empty());
2107 if !skip_last && idx == expected_route.len() - 1 {
2108 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2115 let prev_node = expected_route.first().unwrap();
2116 origin_node.node.handle_update_fail_htlc(&prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0);
2117 check_added_monitors!(origin_node, 0);
2118 assert!(origin_node.node.get_and_clear_pending_msg_events().is_empty());
2119 commitment_signed_dance!(origin_node, prev_node, next_msgs.as_ref().unwrap().1, false);
2120 let events = origin_node.node.get_and_clear_pending_events();
2121 assert_eq!(events.len(), 1);
2122 expected_payment_id = Some(match events[0] {
2123 Event::PaymentPathFailed { payment_hash, payment_failed_permanently, all_paths_failed, ref path, ref payment_id, .. } => {
2124 assert_eq!(payment_hash, our_payment_hash);
2125 assert!(payment_failed_permanently);
2126 assert_eq!(all_paths_failed, i == expected_paths.len() - 1);
2127 for (idx, hop) in expected_route.iter().enumerate() {
2128 assert_eq!(hop.node.get_our_node_id(), path[idx].pubkey);
2132 _ => panic!("Unexpected event"),
2137 // Ensure that fail_htlc_backwards is idempotent.
2138 expected_paths[0].last().unwrap().node.fail_htlc_backwards(&our_payment_hash);
2139 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_events().is_empty());
2140 assert!(expected_paths[0].last().unwrap().node.get_and_clear_pending_msg_events().is_empty());
2141 check_added_monitors!(expected_paths[0].last().unwrap(), 0);
2146 pub fn fail_payment<'a, 'b, 'c>(origin_node: &Node<'a, 'b, 'c>, expected_path: &[&Node<'a, 'b, 'c>], our_payment_hash: PaymentHash) {
2147 fail_payment_along_route(origin_node, &[&expected_path[..]], false, our_payment_hash);
2150 pub fn create_chanmon_cfgs(node_count: usize) -> Vec<TestChanMonCfg> {
2151 let mut chan_mon_cfgs = Vec::new();
2152 for i in 0..node_count {
2153 let tx_broadcaster = test_utils::TestBroadcaster {
2154 txn_broadcasted: Mutex::new(Vec::new()),
2155 blocks: Arc::new(Mutex::new(vec![(genesis_block(Network::Testnet), 0)])),
2157 let fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: Mutex::new(253) };
2158 let chain_source = test_utils::TestChainSource::new(Network::Testnet);
2159 let logger = test_utils::TestLogger::with_id(format!("node {}", i));
2160 let persister = test_utils::TestPersister::new();
2161 let seed = [i as u8; 32];
2162 let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
2164 chan_mon_cfgs.push(TestChanMonCfg { tx_broadcaster, fee_estimator, chain_source, logger, persister, keys_manager });
2170 pub fn create_node_cfgs<'a>(node_count: usize, chanmon_cfgs: &'a Vec<TestChanMonCfg>) -> Vec<NodeCfg<'a>> {
2171 let mut nodes = Vec::new();
2173 for i in 0..node_count {
2174 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);
2175 let network_graph = Arc::new(NetworkGraph::new(chanmon_cfgs[i].chain_source.genesis_hash, &chanmon_cfgs[i].logger));
2176 let seed = [i as u8; 32];
2177 nodes.push(NodeCfg {
2178 chain_source: &chanmon_cfgs[i].chain_source,
2179 logger: &chanmon_cfgs[i].logger,
2180 tx_broadcaster: &chanmon_cfgs[i].tx_broadcaster,
2181 fee_estimator: &chanmon_cfgs[i].fee_estimator,
2182 router: test_utils::TestRouter::new(network_graph.clone()),
2184 keys_manager: &chanmon_cfgs[i].keys_manager,
2186 features: channelmanager::provided_init_features(),
2194 pub fn test_default_channel_config() -> UserConfig {
2195 let mut default_config = UserConfig::default();
2196 // Set cltv_expiry_delta slightly lower to keep the final CLTV values inside one byte in our
2197 // tests so that our script-length checks don't fail (see ACCEPTED_HTLC_SCRIPT_WEIGHT).
2198 default_config.channel_config.cltv_expiry_delta = MIN_CLTV_EXPIRY_DELTA;
2199 default_config.channel_handshake_config.announced_channel = true;
2200 default_config.channel_handshake_limits.force_announced_channel_preference = false;
2201 // When most of our tests were written, the default HTLC minimum was fixed at 1000.
2202 // It now defaults to 1, so we simply set it to the expected value here.
2203 default_config.channel_handshake_config.our_htlc_minimum_msat = 1000;
2204 // When most of our tests were written, we didn't have the notion of a `max_dust_htlc_exposure_msat`,
2205 // It now defaults to 5_000_000 msat; to avoid interfering with tests we bump it to 50_000_000 msat.
2206 default_config.channel_config.max_dust_htlc_exposure_msat = 50_000_000;
2210 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, &'b test_utils::TestFeeEstimator, &'a test_utils::TestRouter<'b>, &'b test_utils::TestLogger>> {
2211 let mut chanmgrs = Vec::new();
2212 for i in 0..node_count {
2213 let network = Network::Testnet;
2214 let params = ChainParameters {
2216 best_block: BestBlock::from_genesis(network),
2218 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,
2219 if node_config[i].is_some() { node_config[i].clone().unwrap() } else { test_default_channel_config() }, params);
2220 chanmgrs.push(node);
2226 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, &'c test_utils::TestFeeEstimator, &'c test_utils::TestRouter, &'c test_utils::TestLogger>>) -> Vec<Node<'a, 'b, 'c>> {
2227 let mut nodes = Vec::new();
2228 let chan_count = Rc::new(RefCell::new(0));
2229 let payment_count = Rc::new(RefCell::new(0));
2230 let connect_style = Rc::new(RefCell::new(ConnectStyle::random_style()));
2232 for i in 0..node_count {
2233 let gossip_sync = P2PGossipSync::new(cfgs[i].network_graph.as_ref(), None, cfgs[i].logger);
2235 chain_source: cfgs[i].chain_source, tx_broadcaster: cfgs[i].tx_broadcaster,
2236 fee_estimator: cfgs[i].fee_estimator, router: &cfgs[i].router,
2237 chain_monitor: &cfgs[i].chain_monitor, keys_manager: &cfgs[i].keys_manager,
2238 node: &chan_mgrs[i], network_graph: cfgs[i].network_graph.as_ref(), gossip_sync,
2239 node_seed: cfgs[i].node_seed, network_chan_count: chan_count.clone(),
2240 network_payment_count: payment_count.clone(), logger: cfgs[i].logger,
2241 blocks: Arc::clone(&cfgs[i].tx_broadcaster.blocks),
2242 connect_style: Rc::clone(&connect_style),
2246 for i in 0..node_count {
2247 for j in (i+1)..node_count {
2248 nodes[i].node.peer_connected(&nodes[j].node.get_our_node_id(), &msgs::Init { features: cfgs[j].features.clone(), remote_network_address: None }).unwrap();
2249 nodes[j].node.peer_connected(&nodes[i].node.get_our_node_id(), &msgs::Init { features: cfgs[i].features.clone(), remote_network_address: None }).unwrap();
2256 // Note that the following only works for CLTV values up to 128
2257 pub const ACCEPTED_HTLC_SCRIPT_WEIGHT: usize = 137; //Here we have a diff due to HTLC CLTV expiry being < 2^15 in test
2259 #[derive(PartialEq)]
2260 pub enum HTLCType { NONE, TIMEOUT, SUCCESS }
2261 /// Tests that the given node has broadcast transactions for the given Channel
2263 /// First checks that the latest holder commitment tx has been broadcast, unless an explicit
2264 /// commitment_tx is provided, which may be used to test that a remote commitment tx was
2265 /// broadcast and the revoked outputs were claimed.
2267 /// Next tests that there is (or is not) a transaction that spends the commitment transaction
2268 /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
2270 /// All broadcast transactions must be accounted for in one of the above three types of we'll
2272 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> {
2273 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2274 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2276 let mut res = Vec::with_capacity(2);
2277 node_txn.retain(|tx| {
2278 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2279 check_spends!(tx, chan.3);
2280 if commitment_tx.is_none() {
2281 res.push(tx.clone());
2286 if let Some(explicit_tx) = commitment_tx {
2287 res.push(explicit_tx.clone());
2290 assert_eq!(res.len(), 1);
2292 if has_htlc_tx != HTLCType::NONE {
2293 node_txn.retain(|tx| {
2294 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2295 check_spends!(tx, res[0]);
2296 if has_htlc_tx == HTLCType::TIMEOUT {
2297 assert!(tx.lock_time.0 != 0);
2299 assert!(tx.lock_time.0 == 0);
2301 res.push(tx.clone());
2305 assert!(res.len() == 2 || res.len() == 3);
2307 assert_eq!(res[1], res[2]);
2311 assert!(node_txn.is_empty());
2315 /// Tests that the given node has broadcast a claim transaction against the provided revoked
2316 /// HTLC transaction.
2317 pub fn test_revoked_htlc_claim_txn_broadcast<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, revoked_tx: Transaction, commitment_revoked_tx: Transaction) {
2318 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2319 // We may issue multiple claiming transaction on revoked outputs due to block rescan
2320 // for revoked htlc outputs
2321 if node_txn.len() != 1 && node_txn.len() != 2 && node_txn.len() != 3 { assert!(false); }
2322 node_txn.retain(|tx| {
2323 if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
2324 check_spends!(tx, revoked_tx);
2328 node_txn.retain(|tx| {
2329 check_spends!(tx, commitment_revoked_tx);
2332 assert!(node_txn.is_empty());
2335 pub fn check_preimage_claim<'a, 'b, 'c>(node: &Node<'a, 'b, 'c>, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
2336 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2338 assert!(node_txn.len() >= 1);
2339 assert_eq!(node_txn[0].input.len(), 1);
2340 let mut found_prev = false;
2342 for tx in prev_txn {
2343 if node_txn[0].input[0].previous_output.txid == tx.txid() {
2344 check_spends!(node_txn[0], tx);
2345 let mut iter = node_txn[0].input[0].witness.iter();
2346 iter.next().expect("expected 3 witness items");
2347 iter.next().expect("expected 3 witness items");
2348 assert!(iter.next().expect("expected 3 witness items").len() > 106); // must spend an htlc output
2349 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
2355 assert!(found_prev);
2357 let mut res = Vec::new();
2358 mem::swap(&mut *node_txn, &mut res);
2362 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) {
2363 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
2364 assert_eq!(events_1.len(), 2);
2365 let as_update = match events_1[0] {
2366 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2369 _ => panic!("Unexpected event"),
2372 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2373 assert_eq!(node_id, nodes[b].node.get_our_node_id());
2374 assert_eq!(msg.data, expected_error);
2375 if needs_err_handle {
2376 nodes[b].node.handle_error(&nodes[a].node.get_our_node_id(), msg);
2379 _ => panic!("Unexpected event"),
2382 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
2383 assert_eq!(events_2.len(), if needs_err_handle { 1 } else { 2 });
2384 let bs_update = match events_2[0] {
2385 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
2388 _ => panic!("Unexpected event"),
2390 if !needs_err_handle {
2392 MessageSendEvent::HandleError { node_id, action: msgs::ErrorAction::SendErrorMessage { ref msg } } => {
2393 assert_eq!(node_id, nodes[a].node.get_our_node_id());
2394 assert_eq!(msg.data, expected_error);
2396 _ => panic!("Unexpected event"),
2401 node.gossip_sync.handle_channel_update(&as_update).unwrap();
2402 node.gossip_sync.handle_channel_update(&bs_update).unwrap();
2406 pub fn get_announce_close_broadcast_events<'a, 'b, 'c>(nodes: &Vec<Node<'a, 'b, 'c>>, a: usize, b: usize) {
2407 handle_announce_close_broadcast_events(nodes, a, b, false, "Channel closed because commitment or closing transaction was confirmed on chain.");
2411 macro_rules! get_channel_value_stat {
2412 ($node: expr, $counterparty_node: expr, $channel_id: expr) => {{
2413 let peer_state_lock = $node.node.per_peer_state.read().unwrap();
2414 let chan_lock = peer_state_lock.get(&$counterparty_node.node.get_our_node_id()).unwrap().lock().unwrap();
2415 let chan = chan_lock.channel_by_id.get(&$channel_id).unwrap();
2416 chan.get_value_stat()
2420 macro_rules! get_chan_reestablish_msgs {
2421 ($src_node: expr, $dst_node: expr) => {
2423 let mut announcements = $crate::prelude::HashSet::new();
2424 let mut res = Vec::with_capacity(1);
2425 for msg in $src_node.node.get_and_clear_pending_msg_events() {
2426 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
2427 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2428 res.push(msg.clone());
2429 } else if let MessageSendEvent::SendChannelAnnouncement { ref node_id, ref msg, .. } = msg {
2430 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2431 announcements.insert(msg.contents.short_channel_id);
2433 panic!("Unexpected event")
2436 for chan in $src_node.node.list_channels() {
2437 if chan.is_public && chan.counterparty.node_id != $dst_node.node.get_our_node_id() {
2438 if let Some(scid) = chan.short_channel_id {
2439 assert!(announcements.remove(&scid));
2443 assert!(announcements.is_empty());
2449 macro_rules! handle_chan_reestablish_msgs {
2450 ($src_node: expr, $dst_node: expr) => {
2452 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
2454 let channel_ready = if let Some(&MessageSendEvent::SendChannelReady { ref node_id, ref msg }) = msg_events.get(0) {
2456 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2462 if let Some(&MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ }) = msg_events.get(idx) {
2464 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2467 let mut had_channel_update = false; // ChannelUpdate may be now or later, but not both
2468 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2469 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2471 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2472 had_channel_update = true;
2475 let mut revoke_and_ack = None;
2476 let mut commitment_update = None;
2477 let order = if let Some(ev) = msg_events.get(idx) {
2479 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2480 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2481 revoke_and_ack = Some(msg.clone());
2483 RAACommitmentOrder::RevokeAndACKFirst
2485 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2486 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2487 commitment_update = Some(updates.clone());
2489 RAACommitmentOrder::CommitmentFirst
2491 _ => RAACommitmentOrder::CommitmentFirst,
2494 RAACommitmentOrder::CommitmentFirst
2497 if let Some(ev) = msg_events.get(idx) {
2499 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2500 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2501 assert!(revoke_and_ack.is_none());
2502 revoke_and_ack = Some(msg.clone());
2505 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2506 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2507 assert!(commitment_update.is_none());
2508 commitment_update = Some(updates.clone());
2515 if let Some(&MessageSendEvent::SendChannelUpdate { ref node_id, ref msg }) = msg_events.get(idx) {
2516 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
2518 assert_eq!(msg.contents.flags & 2, 0); // "disabled" flag must not be set as we just reconnected.
2519 assert!(!had_channel_update);
2522 assert_eq!(msg_events.len(), idx);
2524 (channel_ready, revoke_and_ack, commitment_update, order)
2529 /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
2530 /// for claims/fails they are separated out.
2531 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)) {
2532 node_a.node.peer_connected(&node_b.node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2533 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
2534 node_b.node.peer_connected(&node_a.node.get_our_node_id(), &msgs::Init { features: channelmanager::provided_init_features(), remote_network_address: None }).unwrap();
2535 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
2537 if send_channel_ready.0 {
2538 // If a expects a channel_ready, it better not think it has received a revoke_and_ack
2540 for reestablish in reestablish_1.iter() {
2541 assert_eq!(reestablish.next_remote_commitment_number, 0);
2544 if send_channel_ready.1 {
2545 // If b expects a channel_ready, it better not think it has received a revoke_and_ack
2547 for reestablish in reestablish_2.iter() {
2548 assert_eq!(reestablish.next_remote_commitment_number, 0);
2551 if send_channel_ready.0 || send_channel_ready.1 {
2552 // If we expect any channel_ready's, both sides better have set
2553 // next_holder_commitment_number to 1
2554 for reestablish in reestablish_1.iter() {
2555 assert_eq!(reestablish.next_local_commitment_number, 1);
2557 for reestablish in reestablish_2.iter() {
2558 assert_eq!(reestablish.next_local_commitment_number, 1);
2562 let mut resp_1 = Vec::new();
2563 for msg in reestablish_1 {
2564 node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg);
2565 resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
2567 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
2568 check_added_monitors!(node_b, 1);
2570 check_added_monitors!(node_b, 0);
2573 let mut resp_2 = Vec::new();
2574 for msg in reestablish_2 {
2575 node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg);
2576 resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
2578 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
2579 check_added_monitors!(node_a, 1);
2581 check_added_monitors!(node_a, 0);
2584 // We don't yet support both needing updates, as that would require a different commitment dance:
2585 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_htlc_fails.0 == 0 &&
2586 pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
2587 (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_htlc_fails.1 == 0 &&
2588 pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
2590 for chan_msgs in resp_1.drain(..) {
2591 if send_channel_ready.0 {
2592 node_a.node.handle_channel_ready(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap());
2593 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
2594 if !announcement_event.is_empty() {
2595 assert_eq!(announcement_event.len(), 1);
2596 if let MessageSendEvent::SendChannelUpdate { .. } = announcement_event[0] {
2597 //TODO: Test announcement_sigs re-sending
2598 } else { panic!("Unexpected event! {:?}", announcement_event[0]); }
2601 assert!(chan_msgs.0.is_none());
2604 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2605 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap());
2606 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2607 check_added_monitors!(node_a, 1);
2609 assert!(chan_msgs.1.is_none());
2611 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 {
2612 let commitment_update = chan_msgs.2.unwrap();
2613 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2614 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
2616 assert!(commitment_update.update_add_htlcs.is_empty());
2618 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
2619 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.0 + pending_cell_htlc_fails.0);
2620 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2621 for update_add in commitment_update.update_add_htlcs {
2622 node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add);
2624 for update_fulfill in commitment_update.update_fulfill_htlcs {
2625 node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill);
2627 for update_fail in commitment_update.update_fail_htlcs {
2628 node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail);
2631 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
2632 commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
2634 node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed);
2635 check_added_monitors!(node_a, 1);
2636 let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
2637 // No commitment_signed so get_event_msg's assert(len == 1) passes
2638 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack);
2639 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2640 check_added_monitors!(node_b, 1);
2643 assert!(chan_msgs.2.is_none());
2647 for chan_msgs in resp_2.drain(..) {
2648 if send_channel_ready.1 {
2649 node_b.node.handle_channel_ready(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap());
2650 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
2651 if !announcement_event.is_empty() {
2652 assert_eq!(announcement_event.len(), 1);
2653 match announcement_event[0] {
2654 MessageSendEvent::SendChannelUpdate { .. } => {},
2655 MessageSendEvent::SendAnnouncementSignatures { .. } => {},
2656 _ => panic!("Unexpected event {:?}!", announcement_event[0]),
2660 assert!(chan_msgs.0.is_none());
2663 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
2664 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap());
2665 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
2666 check_added_monitors!(node_b, 1);
2668 assert!(chan_msgs.1.is_none());
2670 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 {
2671 let commitment_update = chan_msgs.2.unwrap();
2672 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2673 assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
2675 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.1 + pending_cell_htlc_claims.1);
2676 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_htlc_fails.1 + pending_cell_htlc_fails.1);
2677 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
2678 for update_add in commitment_update.update_add_htlcs {
2679 node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add);
2681 for update_fulfill in commitment_update.update_fulfill_htlcs {
2682 node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill);
2684 for update_fail in commitment_update.update_fail_htlcs {
2685 node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail);
2688 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
2689 commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
2691 node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed);
2692 check_added_monitors!(node_b, 1);
2693 let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
2694 // No commitment_signed so get_event_msg's assert(len == 1) passes
2695 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack);
2696 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
2697 check_added_monitors!(node_a, 1);
2700 assert!(chan_msgs.2.is_none());